T_Rhino_Geometry_Box - mcneel/rhinocommon-api-docs GitHub Wiki

Box Structure

Represents the value of a plane and three intervals in an orthogonal, oriented box that is not necessarily parallel to the world Y, X, Z axes.

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

Syntax

C#

[SerializableAttribute]
public struct Box

VB

<SerializableAttribute>
Public Structure Box

The Box type exposes the following members.

Constructors

 

Name Description
Public method Box(BoundingBox) Initializes a new Box that mimics a BoundingBox struct. The orientation plane of the Box is coincident with the World XY plane.
Public method Box(Plane, BoundingBox) Initializes a world aligned box from a base plane and a boundingbox.
Public method Box(Plane, GeometryBase) Initializes a box that contains a generic piece of geometry. This box will be aligned with an arbitrary plane.
Public method Box(Plane, IEnumerable(Point3d)) Initializes the smallest box that contains a set of points.
Public method Box(Plane, Interval, Interval, Interval) Initializes a new box from a base Plane and three Intervals.
  Back to Top

Properties

 

Name Description
Public property Area Gets the total surface area of this box.
Public property BoundingBox Gets the world axis aligned Bounding box for this oriented box.
Public property Center Gets the point that is in the center of the box.
Public propertyStatic member Empty Empty Box. Empty boxes are considered to be invalid.
Public property IsValid Gets the validity of this Box. Boxes are invalid when the base plane or any of the dimension intervals are invalid or decreasing.
Public property Plane Gets or sets the orientation plane for this Box.
Public propertyStatic member Unset Gets a Box whose base plane and axis dimensions are all Unset.
Public property Volume Gets the total volume of this box.
Public property X Gets or sets the Interval that describes the dimension of the Box along the orientation plane X-Axis. Otherwise known as the Width of the Box.
Public property Y Gets or sets the Interval that describes the dimension of the Box along the orientation plane Y-Axis. Otherwise known as the Depth of the Box.
Public property Z Gets or sets the Interval that describes the dimension of the Box along the orientation plane Z-Axis. Otherwise known as the Height of the Box.
  Back to Top

Methods

 

Name Description
Public method ClosestPoint Finds the closest point on or in the Box. The box should be Valid for this to work.
Public method Contains(BoundingBox) Test a boundingbox for Box inclusion. This is the same as calling Contains(box,false)
Public method Contains(Box) Test a box for Box inclusion. This is the same as calling Contains(box,false)
Public method Contains(Point3d) Determines whether a point is included in this box. This is the same as calling Contains(point,false)
Public method Contains(BoundingBox, Boolean) Test a boundingbox for Box inclusion.
Public method Contains(Box, Boolean) Test a box for Box inclusion.
Public method Contains(Point3d, Boolean) Determines whether a point is included in this box.
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 FurthestPoint Finds the furthest point on the Box. The Box should be Valid for this to work properly.
Public method GetCorners Gets an array of the 8 corner points of this box.
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 Inflate(Double) Inflates the box by a given offset in each direction. Inflating with negative amounts may result in decreasing boxes. InValid boxes cannot be inflated.
Public method Inflate(Double, Double, Double) Inflates the box by a given offset in each direction. Inflating with negative amounts may result in decreasing boxes. InValid boxes cannot be inflated.
Public method MakeValid Attempts to make the Box valid. This is not always possible.
Public method PointAt Evaluates the box volume at the given unitized parameters. The box has idealized side length of 1x1x1.
Public method RepositionBasePlane Repositions the origin of the Base plane for this box without affecting the physical dimensions.
Public method ToBrep Constructs a brep representation of this box.
Public method ToString Returns the fully qualified type name of this instance. (Inherited from ValueType.)
Public method Transform Transforms this Box using a Transformation matrix. If the Transform does not preserve Similarity, the dimensions of the resulting box cannot be trusted.
Public method Union Constructs a union between this Box and the given point. This grows the box in directions so it contains the point.
  Back to Top

Version Information

Supported in: 6.0.16224.21491, 5D58w

See Also

Reference

Rhino.Geometry Namespace

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