T_Rhino_Geometry_Rectangle3d - mcneel/rhinocommon-api-docs GitHub Wiki

Rectangle3d Structure

Represents the values of a plane and two intervals that form an oriented rectangle in three dimensions.

Namespace: Rhino.Geometry
Assembly: RhinoCommon (in RhinoCommon.dll) Version: Rhino 6.0

Syntax

C#

[SerializableAttribute]
public struct Rectangle3d

VB

<SerializableAttribute>
Public Structure Rectangle3d

The Rectangle3d type exposes the following members.

Constructors

 

Name Description
Public method Rectangle3d(Plane, Interval, Interval) Initializes a new rectangle from dimensions.
Public method Rectangle3d(Plane, Point3d, Point3d) Initializes a new rectangle from a base plane and two corner points.
Public method Rectangle3d(Plane, Double, Double) Initializes a new rectangle from width and height.
  Back to Top

Properties

 

Name Description
Public property Area Gets the unsigned Area of the rectangle.
Public property BoundingBox Gets the world aligned boundingbox for this rectangle.
Public property Center Gets the point in the center of the rectangle.
Public property Circumference Gets the circumference of the rectangle.
Public property Height Gets the signed height of the rectangle. If the Y dimension is decreasing, the height will be negative.
Public property IsValid Gets a value indicating whether or not this is a valid rectangle. A rectangle is considered to be valid when the base plane and both dimensions are valid.
Public property Plane Gets or sets the base plane of the rectangle.
Public propertyStatic member Unset Gets a rectangle with Unset components.
Public property Width Gets the signed width of the rectangle. If the X dimension is decreasing, the width will be negative.
Public property X Gets or sets the dimensions of the rectangle along the base plane X-Axis (i.e. the width).
Public property Y Gets or sets the dimensions of the rectangle along the base plane Y-Axis (i.e. the height).
  Back to Top

Methods

 

Name Description
Public method ClosestPoint(Point3d) Gets the point on the rectangle that is closest to a test-point.
Public method ClosestPoint(Point3d, Boolean) Gets the point on the rectangle that is closest to a test-point.
Public method Contains(Point3d) Determines if a point is included in this rectangle.
Public method Contains(Double, Double) Determines if two plane parameters are included in this rectangle.
Public method Corner Gets the corner at the given index.
Public methodStatic member CreateFromPolyline(IEnumerable(Point3d)) Attempts to create a rectangle from a polyline. In order for the polyline to qualify as a rectangle, it must have 4 or 5 corner points (i.e. it need not be closed).
Public methodStatic member CreateFromPolyline(IEnumerable(Point3d), Double, Double) Attempts to create a Rectangle from a Polyline. In order for a polyline to qualify as a rectangle, it must have 4 or 5 corner points (i.e. it need not be closed). This overload also returns deviations.
Public method EpsilonEquals Check that all values in other are within epsilon of the values in this
Public method Equals Indicates whether this instance and a specified object are equal. (Inherited from ValueType.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from ValueType.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method MakeIncreasing Ensures the X and Y dimensions are increasing or singleton intervals.
Public method PointAt(Double) Gets a point along the rectangle boundary.
Public method PointAt(Double, Double) Gets a point in Rectangle space.
Public method RecenterPlane(Int32) Recenters the base plane on one of the corners.
Public method RecenterPlane(Point3d) Recenters the base plane on a new origin.
Public method ToNurbsCurve Constructs a nurbs curve representation of this rectangle.
Public method ToPolyline Constructs a polyline from this rectangle.
Public method ToString Returns the fully qualified type name of this instance. (Inherited from ValueType.)
Public method Transform Transforms this rectangle. Note that rectangles cannot be skewed or tapered.
  Back to Top

Version Information

Supported in: 6.0.16224.21491, 5D58w

See Also

Reference

Rhino.Geometry Namespace

⚠️ **GitHub.com Fallback** ⚠️