T_Rhino_Geometry_BoundingBox - mcneel/rhinocommon-api-docs GitHub Wiki

BoundingBox Structure

Represents the value of two points in a bounding box defined by the two extreme corner points. This box is therefore aligned to the world X, Y and Z axes.

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

Syntax

C#

[SerializableAttribute]
public struct BoundingBox

VB

<SerializableAttribute>
Public Structure BoundingBox

The BoundingBox type exposes the following members.

Constructors

 

Name Description
Public method BoundingBox(IEnumerable(Point3d)) Constructs a boundingbox from a collection of points.
Public methodCode example BoundingBox(Point3d, Point3d) Constructs a new boundingbox from two corner points.
Public method BoundingBox(IEnumerable(Point3d), Transform) Constructs a boundingbox from a collection of points.
Public method BoundingBox(Double, Double, Double, Double, Double, Double) Constructs a boundingbox from numeric extremes.
  Back to Top

Properties

 

Name Description
Public property Center Gets the point in the center of the boundingbox.
Public property Diagonal Gets the diagonal vector of this BoundingBox. The diagonal connects the Min and Max points.
Public propertyStatic member Empty Gets an [Empty] boundingbox. An Empty box is an invalid structure that has negative width.
Public property IsValid Gets a value that indicates whether or not this boundingbox is valid. Empty boxes are not valid, and neither are boxes with unset points.
Public property Max Gets or sets the point in the maximal corner.
Public property Min Gets or sets the point in the minimal corner.
Public propertyStatic member Unset Gets a boundingbox that has Unset coordinates for Min and Max.
  Back to Top

Methods

 

Name Description
Public method ClosestPoint(Point3d) Finds the closest point on or in the boundingbox.
Public method ClosestPoint(Point3d, Boolean) Finds the closest point on or in the boundingbox.
Public method Contains(BoundingBox) Determines whether this boundingbox contains another boundingbox. This is the same as calling Contains(box,false).
Public method Contains(Point3d) Tests a point for boundingbox inclusion. This is the same as calling Contains(point, false)
Public method Contains(BoundingBox, Boolean) Determines whether this boundingbox contains another boundingbox. The user can choose how to treat boundingboxes with coincidents surfaces.
Public method Contains(Point3d, Boolean) Tests a point for BoundingBox inclusion.
Public method Corner Gets one of the eight corners of the box.
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.
Public methodCode example GetCorners Gets an array filled with the 8 corner points of this box. See remarks for the return order.
Public method GetEdges Gets an array of the 12 edges 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 with equal amounts in all directions. Inflating with negative amounts may result in decreasing boxes. Invalid boxes can not be inflated.
Public method Inflate(Double, Double, Double) Inflate the box with custom amounts in all directions. Inflating with negative amounts may result in decreasing boxes. InValid boxes can not be inflated.
Public methodStatic member Intersection Computes the intersection of two bounding boxes.
Public methodCode example IsDegenerate Determines whether a bounding box is degenerate (flat) in one or more directions.
Public method MakeValid Ensures that the box is defined in an increasing fashion along X, Y and Z axes. If the Min or Max points are unset, this function will not change the box.
Public method PointAt Evaluates the boundingbox with normalized parameters. The box has idealized side length of 1x1x1.
Public methodCode example ToBrep Constructs a Brep representation of this boundingbox.
Public method ToString Constructs the string representation of this aligned boundingbox. (Overrides ValueType.ToString().)
Public method Transform Updates this boundingbox to be the smallest axis aligned boundingbox that contains the transformed result of its 8 original corner points.
Public method Union(BoundingBox) Updates this BoundingBox to represent the union of itself and another box.
Public method Union(Point3d) Updates this BoundingBox to represent the union of itself and a point.
Public methodStatic member Union(BoundingBox, BoundingBox) Returns a new BoundingBox that represents the union of boxes a and b.
Public methodStatic member Union(BoundingBox, Point3d) Returns a new BoundingBox that represents the union of a bounding box and a point.
  Back to Top

Version Information

Supported in: 6.0.16224.21491, 5D58w

See Also

Reference

Rhino.Geometry Namespace

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