Cuboid3D

Canonical path: NemAll_Python_Geometry.Cuboid3D

Representation class for 3D cuboid.

Methods:

• GetBottomFacePolygon –

  Get the boundary polygon of bottom face of the cuboid

• GetGroundPlane –

  Get ground plane ( ref point + Z-vector ).

• GetHeight –

  Get height.

• GetHeightVector –

  Get the height vector

• GetLength –

  Get length.

• GetLengthVector –

  Get the length vector

• GetRefPoint –

  Get reference point.

• GetRelStartPoint –

  Get start point in relative coordinates.

• GetStartPoint –

  Get start point in world coordinates.

• GetTopFacePolygon –

  Get the boundary polygon of top face of the cuboid

• GetVector –

  Get given vector.

• GetWidth –

  Get width.

• GetWidthVector –

  Get the width vector

• Set –

  Overloaded function. See individual overloads.

• SetHeight –

  Set height.

• SetHeightVector –

  Set the height vector

• SetLength –

  Set length.

• SetLengthVector –

  Set the length vector

• SetRefPoint –

  Set reference point.

• SetStartPoint –

  Set start point.

• SetVector –

  Set the vector.

• SetWidth –

  Set width.

• SetWidthVector –

  Set the width vector

• __eq__ –

  Comparison of cuboid.

• __init__ –

  Overloaded function. See individual overloads.

• __repr__ –

  Convert to string

Attributes:

• Height (float) –

  Get height.

• HeightVector (Vector3D) –

  Get the height vector

• Length (float) –

  Get length.

• LengthVector (Vector3D) –

  Get the length vector

• RefPoint (Point3D) –

  Get reference point.

• StartPoint (Point3D) –

  Get start point in world coordinates.

• Width (float) –

  Get width.

• WidthVector (Vector3D) –

  Get the width vector

Height property writable

Height: float

Get height.

HeightVector property writable

HeightVector: Vector3D

Get the height vector

Length property writable

Length: float

Get length.

LengthVector property writable

LengthVector: Vector3D

Get the length vector

RefPoint property writable

RefPoint: Point3D

Get reference point.

StartPoint property writable

StartPoint: Point3D

Get start point in world coordinates.

Width property writable

Width: float

Get width.

WidthVector property writable

WidthVector: Vector3D

Get the width vector

GetBottomFacePolygon

GetBottomFacePolygon() -> Polygon3D

Get the boundary polygon of bottom face of the cuboid

Returns:

• Polygon3D –

  Bottom face boundary polygon

GetGroundPlane

GetGroundPlane() -> Plane3D

Get ground plane ( ref point + Z-vector ).

Returns:

• Plane3D –

  ground Plane3D.

GetHeight

GetHeight() -> float

Get height.

Returns:

• float –

  Size of Z-vector ( vector3 ).

GetHeightVector

GetHeightVector() -> Vector3D

Get the height vector

Returns:

• Vector3D –

  Height vector

GetLength

GetLength() -> float

Get length.

Returns:

• float –

  Size of X-vector ( vector1 ).

GetLengthVector

GetLengthVector() -> Vector3D

Get the length vector

Returns:

• Vector3D –

  Length vector

GetRefPoint

GetRefPoint() -> Point3D

Get reference point.

Returns:

• Point3D –

  Reference point.

GetRelStartPoint

GetRelStartPoint() -> Point3D

Get start point in relative coordinates.

Returns:

• Point3D –

  Constant the start point.

GetStartPoint

GetStartPoint() -> Point3D

Get start point in world coordinates.

Returns:

• Point3D –

  copy of start point.

GetTopFacePolygon

GetTopFacePolygon() -> Polygon3D

Get the boundary polygon of top face of the cuboid

Returns:

• Polygon3D –

  Top face boundary polygon

GetVector

GetVector(index: int) -> Vector3D

Get given vector.

Parameters:

• index (int) –

  Index of the vector.

Returns:

• Vector3D –

  m_Vec[index]

GetWidth

GetWidth() -> float

Get width.

Returns:

• float –

  Size of Y-vector ( vector2 ).

GetWidthVector

GetWidthVector() -> Vector3D

Get the width vector

Returns:

• Vector3D –

  Width vector

Set overloaded

Set(
    refPoint: Point3D,
    startPoint: Point3D,
    vec1: Vector3D,
    vec2: Vector3D,
    vec3: Vector3D,
)

Set the Cuboid.

Parameters:

• refPoint (Point3D) –

  Reference point in world coordinate system.

• startPoint (Point3D) –

  Start point of cuboid.

• vec1 (Vector3D) –

  X-vector.

• vec2 (Vector3D) –

  Y-vector.

• vec3 (Vector3D) –

  Z-vector.

Set(cuboid: Cuboid3D)

Initialize from cuboid.

Parameters:

• cuboid (Cuboid3D) –

  Cuboid which will be copied.

SetHeight

SetHeight(height: float)

Set height.

Parameters:

• height (float) –

  New size of Z-vector ( vector3 ).

SetHeightVector

SetHeightVector(vector: Vector3D)

Set the height vector

Parameters:

• vector (Vector3D) –

  Height vector

SetLength

SetLength(length: float)

Set length.

Parameters:

• length (float) –

  New size of X-vector ( vector1 ).

SetLengthVector

SetLengthVector(vector: Vector3D)

Set the length vector

Parameters:

• vector (Vector3D) –

  Length vector

SetRefPoint

SetRefPoint(refPoint: Point3D)

Set reference point.

Parameters:

• refPoint (Point3D) –

  New reference point.

SetStartPoint

SetStartPoint(startPoint: Point3D)

Set start point.

Parameters:

• startPoint (Point3D) –

  New start point ( in world coordinates ).

SetVector

SetVector(vec: Vector3D, index: int)

Set the vector.

Parameters:

• vec (Vector3D) –

  New vector.

• index (int) –

  Index pf the vector.

SetWidth

SetWidth(width: float)

Set width.

Parameters:

• width (float) –

  New size of Y-vector ( vector2 ).

SetWidthVector

SetWidthVector(vector: Vector3D)

Set the width vector

Parameters:

• vector (Vector3D) –

  Width vector

__eq__

__eq__(cuboid: Cuboid3D) -> bool

Comparison of cuboid.

Be careful, this method work without tolerance!

Parameters:

• cuboid (Cuboid3D) –

  cuboid to be compared.

Returns:

• bool –

  True when cuboid are equal, otherwise false.

__init__ overloaded

__init__()

Initialize

__init__(cuboid: Cuboid3D)

Copy constructor.

Parameters:

• cuboid (Cuboid3D) –

  Cuboid which will be copied.

__init__(
    refPoint: Point3D,
    startPoint: Point3D,
    vec1: Vector3D,
    vec2: Vector3D,
    vec3: Vector3D,
)

Constructor.

Parameters:

• refPoint (Point3D) –

  Reference point.

• startPoint (Point3D) –

  Start point of cuboid.

• vec1 (Vector3D) –

  X-vector.

• vec2 (Vector3D) –

  Y-vector.

• vec3 (Vector3D) –

  Z-vector

__repr__

__repr__() -> str

Convert to string

Placeholder