OEBox

class OEBox

OEBox class represents a box aligned to the x, y and z coordinate axis.

Constructors

OEBox() -> OEBox
OEBox(arg2: OEBox) -> OEBox

Default and copy constructors

Extend

Extend(x: float, y: float, z: float) -> bool
Extend(value: float) -> bool

Extend the box in all dimensions with the specified values. The box is extended simultaneously in both maximum and minimum coordinate directions

GetArea

GetArea() -> float

Returns the surface area of the box

GetVolume

GetVolume() -> float

Returns the volume of the box

GetXDim

GetXDim() -> float

Returns the X dimension value of the box

GetYDim

GetYDim() -> float

Returns the Y dimension value of the box

GetZDim

GetZDim() -> float

Returns the Z dimension value of the box

GetXMax

GetXMax() -> float

Returns the maximum X value of the box

GetYMax

GetYMax() -> float

Returns the maximum Y value of the box

GetZMax

GetZMax() -> float

Returns the maximum Z value of the box

GetXMid

GetXMid() -> float

Returns the midpoint of X dimension of the box

GetYMid

GetYMid() -> float

Returns the midpoint of Y dimension of the box

GetZMid

GetZMid() -> float

Returns the midpoint of Z dimension of the box

GetXMin

GetXMin() -> float

Returns the minimum X value of the box

GetYMin

GetYMin() -> float

Returns the minimum Y value of the box

GetZMin

GetZMin() -> float

Returns the minimum Z value of the box

IsInside

IsInside(x: float, y: float, z: float) -> bool

Returns if the specified point is inside the box

Setup

Setup(x1: float, y1: float, z1: float, x2: float, y2: float,
      z2: float) -> bool
Setup(xyz: OEFloatArray, numPoints: int, addbox: float = 0.0) -> bool
Setup(center: OEFloatArray, extents: OEFloatArray) -> bool

Sets up the box.

The first overload expects the maximum and minimum values in all directions. The max and min X values are the max and min of x1, x2 respectively. Minimum and maximum values of Y and Z are selected in an analogous fashion.

The second overload creates a box that encapsulates all the specified data points. The number of values in xyz must be three times that specified in numPoints. The value in addbox extends the box in all three dimensions with the specified value. The box is extended simultaneously in both maximum and minimum coordinate directions, when specified.

The third overload creates a box with the specified center and extent.