bluemira.geometry.plane

Wrapper for FreeCAD Plane objects

Classes

BluemiraPlane

Bluemira Plane class.

Module Contents

class bluemira.geometry.plane.BluemiraPlane(base: tuple[float, float, float] = (0.0, 0.0, 0.0), axis: tuple[float, float, float] = (0.0, 0.0, 1.0), label: str = '')

Bluemira Plane class.

Parameters:

base (tuple[float, float, float]) – Plane reference point
axis (tuple[float, float, float]) – normal vector dto the plane
label (str) – Label of the plane

_shape

label = ''

classmethod from_3_points(point_1: collections.abc.Iterable[float], point_2: collections.abc.Iterable[float], point_3: collections.abc.Iterable[float], label: str = '') → BluemiraPlane

Instantiate a BluemiraPlane from three points.

Parameters:

point_1 (collections.abc.Iterable[float]) – First point
point_2 (collections.abc.Iterable[float]) – Second Point
point_3 (collections.abc.Iterable[float]) – Third point
label (str) – Label of the plane

Returns:

A bluemira plane.

Return type:

BluemiraPlane

property base: numpy.ndarray

Plane’s reference point

Return type:: numpy.ndarray

property axis: numpy.ndarray

Plane’s normal vector

Return type:: numpy.ndarray

move(vector: collections.abc.Iterable[float])

Moves the Plane along the given vector

Parameters:: vector (collections.abc.Iterable[float])

__repr__() → str

Plane __repr__

Returns:: Plane __repr__.
Return type:: str

copy(label: str | None = None) → BluemiraPlane

Make a copy of the BluemiraGeo.

Returns:: Copy of the plane.
Parameters:: label (str | None)
Return type:: BluemiraPlane

deepcopy(label: str | None = None) → BluemiraPlane

Make a deepcopy of the BluemiraPlane

Returns:: Deepcopy of the plane.
Parameters:: label (str | None)
Return type:: BluemiraPlane

to_face(width: float = VERY_BIG, height: float = VERY_BIG, label: str = '') → bluemira.geometry.face.BluemiraFace

Convert the plane to a face with dimension (width, height) and centred into the plane base position.

Returns:

A face centred into the plane base position.

Parameters:

width (float)
height (float)
label (str)

Return type:

bluemira.geometry.face.BluemiraFace

to_placement() → bluemira.geometry.placement.BluemiraPlacement

Convert the plane into a placement

Returns:: A placement from a plane.
Return type:: bluemira.geometry.placement.BluemiraPlacement