bluemira.geometry.compound

Wrapper for FreeCAD Part.Compounds objects

Classes

BluemiraCompound

Bluemira Compound class.

Module Contents

class bluemira.geometry.compound.BluemiraCompound(boundary: list[bluemira.geometry.base.BluemiraGeo], label: str = '', *, _compound_obj: bluemira.codes._freecadapi.apiCompound | None = None)

Bases: bluemira.geometry.base.BluemiraGeo

Inheritance diagram of bluemira.geometry.compound.BluemiraCompound

Bluemira Compound class.

Parameters:

  • boundary (list[bluemira.geometry.base.BluemiraGeo]) – List of BluemiraGeo objects to include in the compound

  • label (str) – Label to assign to the compound

  • _compound_obj (bluemira.codes._freecadapi.apiCompound | None) – A pre-constructed compound object to use for the shape. This should only be used by the _create classmethod.

_compound_obj = None
_create_shape() → bluemira.codes._freecadapi.apiCompound
Returns:

Shape of the object as a single compound.

Return type:

apiCompound

classmethod _create(obj: bluemira.codes._freecadapi.apiCompound, label='') → BluemiraCompound
Parameters:

obj (bluemira.codes._freecadapi.apiCompound)

Return type:

BluemiraCompound

property vertexes: bluemira.geometry.coordinates.Coordinates

The vertexes of the compound.

Return type:

bluemira.geometry.coordinates.Coordinates

property edges: tuple[bluemira.geometry.wire.BluemiraWire, Ellipsis]

The edges of the compound.

Return type:

tuple[bluemira.geometry.wire.BluemiraWire, Ellipsis]

property wires: tuple[bluemira.geometry.wire.BluemiraWire, Ellipsis]

The wires of the compound.

Return type:

tuple[bluemira.geometry.wire.BluemiraWire, Ellipsis]

property faces: tuple[bluemira.geometry.face.BluemiraFace, Ellipsis]

The faces of the compound.

Return type:

tuple[bluemira.geometry.face.BluemiraFace, Ellipsis]

property shells: tuple[bluemira.geometry.shell.BluemiraShell, Ellipsis]

The shells of the compound.

Return type:

tuple[bluemira.geometry.shell.BluemiraShell, Ellipsis]

property solids: tuple[bluemira.geometry.solid.BluemiraSolid, Ellipsis]

The solids of the compound.

Return type:

tuple[bluemira.geometry.solid.BluemiraSolid, Ellipsis]