CVBpy 14.1
Cuboid Class Reference

3D rectangle in the X, Y and Z domain. More...

Inherits object.

Public Member Functions

bool contains (self, cvb.Point3D point)
 Check if a point is inside the cuboid. More...
 
bool intersects_with (self, cvb.Cuboid other)
 Check if this cuboid intersects with another cuboid. More...
 

Properties

 x_range = property
 cvb.NumberRange: Gets or sets the range regarding the x-axis.
 
 y_range = property
 cvb.NumberRange: Gets or sets the range regarding the y-axis.
 
 z_range = property
 cvb.NumberRange: Gets or sets the range regarding the z-axis.
 

Detailed Description

3D rectangle in the X, Y and Z domain.

Region resembling a cube with its faces having not necessarily equal sizes.

Initialize a cuboid object (default range from 0.0 to 0.0).

Parameters

x_range : Optional[cvb.NumberRange] Range regarding the x-axis.

y_range : Optional[cvb.NumberRange] Range regarding the y-axis.

z_range : Optional[cvb.NumberRange] Range regarding the z-axis.

Member Function Documentation

◆ contains()

bool contains (   self,
cvb.Point3D  point 
)

Check if a point is inside the cuboid.

Parameters

point : cvb.Point3D Point to be checked.

Returns

bool True if the value is within the cuboid, False otherwise.

◆ intersects_with()

bool intersects_with (   self,
cvb.Cuboid  other 
)

Check if this cuboid intersects with another cuboid.

Parameters

other : cvb.Cuboid Cuboid for intersection test.

Returns

bool True if this cuboid and the other cuboid have at least one 3D point in common, false otherwise.