Box

class rhino3dm.Box
Box()

Box constructor

IsValid

bool: Gets the validity of this Box. Boxes are invalid when the base plane or any of the dimension intervals are invalid or decreasing.

Center

rhino3dm.Point3d: Gets the point that is in the center of the box.

Area

float: Gets the total surface area of this box.

Volume

float: Gets the total volume of this box.

PointAt(x, y, z)

Evaluates the box volume at the given unitized parameters. The box has idealized side length of 1x1x1.

Parameters:
  • x (float) – Unitized parameter (between 0 and 1 is inside the box) along box X direction.
  • y (float) – Unitized parameter (between 0 and 1 is inside the box) along box Y direction.
  • z (float) – Unitized parameter (between 0 and 1 is inside the box) along box Z direction.
Returns:

The point at (x,y,z).

Return type:

rhino3dm.Point3d

ClosestPoint(point)

Finds the closest point on or in the Box. The box should be Valid for this to work.

Parameters:point (rhino3dm.Point3d) – Sample point.
Returns:The point on or in the box that is closest to the sample point.
Return type:rhino3dm.Point3d
Transform(xform)

Transforms this Box using a Transformation matrix. If the Transform does not preserve Similarity, the dimensions of the resulting box cannot be trusted.

Parameters:xform (Transform) – Transformation matrix to apply to this Box.
Returns:True if the Box was successfully transformed, False if otherwise.
Return type:bool