bluemira.geometry.plane
=======================

.. py:module:: bluemira.geometry.plane

.. autoapi-nested-parse::

   Wrapper for FreeCAD Plane objects



Classes
-------

.. autoapisummary::

   bluemira.geometry.plane.BluemiraPlane


Module Contents
---------------

.. py:class:: 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.

   :param base: Plane reference point
   :param axis: normal vector dto the plane
   :param label: Label of the plane


   .. py:attribute:: _shape


   .. py:attribute:: label
      :value: ''



   .. py:method:: from_3_points(point_1: collections.abc.Iterable[float], point_2: collections.abc.Iterable[float], point_3: collections.abc.Iterable[float], label: str = '') -> BluemiraPlane
      :classmethod:


      Instantiate a BluemiraPlane from three points.

      :param point_1: First point
      :param point_2: Second Point
      :param point_3: Third point
      :param label: Label of the plane

      :returns: A bluemira plane.



   .. py:property:: base
      :type: numpy.ndarray


      Plane's reference point


   .. py:property:: axis
      :type: numpy.ndarray


      Plane's normal vector


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

      Moves the Plane along the given vector



   .. py:method:: __repr__() -> str

      Plane __repr__

      :returns: Plane __repr__.



   .. py:method:: copy(label: str | None = None) -> BluemiraPlane

      Make a copy of the BluemiraGeo.

      :returns: Copy of the plane.



   .. py:method:: deepcopy(label: str | None = None) -> BluemiraPlane

      Make a deepcopy of the BluemiraPlane

      :returns: Deepcopy of the plane.



   .. py:method:: 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.



   .. py:method:: to_placement() -> bluemira.geometry.placement.BluemiraPlacement

      Convert the plane into a placement

      :returns: A placement from a plane.