:class:`RARectangularSurface`
=============================


.. py:class:: ansys.rocky.app.ra_rectangular_surface.RARectangularSurface

   Bases: :py:obj:`ansys.rocky.app.ra_base_geometry.RABaseGeometry`, :py:obj:`ansys.rocky.app._ra_orientation_mixin._RAOrientationMixin`, :py:obj:`ansys.rocky.app.motion._with_movement_mixin._WithMovementMixin`


   
   Rocky API "Rectangular Surface" model.
















   ..
       !! processed by numpydoc !!




.. py:currentmodule:: RARectangularSurface

Overview
--------

.. tab-set::


   .. tab-item:: Constructors

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~GetWrappedClass`
            - 
          * - :py:attr:`~GetClassName`
            - 


   .. tab-item:: Methods

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~HasMotionFrame`
            - Whether the geometry is linked to a motion frame.
          * - :py:attr:`~GetCenter`
            - Get the value of "Center".
          * - :py:attr:`~SetCenter`
            - Set the values of "Center".
          * - :py:attr:`~GetLength`
            - Get the value of "Length".
          * - :py:attr:`~SetLength`
            - Set the value of "Length".
          * - :py:attr:`~GetName`
            - Get the value of "Name".
          * - :py:attr:`~SetName`
            - Set the value of "Name".
          * - :py:attr:`~GetWidth`
            - Get the value of "Width".
          * - :py:attr:`~SetWidth`
            - Set the value of "Width".








Import detail
-------------

.. code-block:: python

    from ansys.rocky.app.ra_rectangular_surface import RARectangularSurface



Method detail
-------------

.. py:method:: GetWrappedClass() -> type[object]
   :classmethod:


.. py:method:: GetClassName() -> str
   :classmethod:


.. py:method:: HasMotionFrame() -> bool

   
   Whether the geometry is linked to a motion frame.

   :return:
       True if geometry is linked to a motion frame False otherwise















   ..
       !! processed by numpydoc !!

.. py:method:: GetCenter(unit: str | None = None) -> list[float]

   
   Get the value of "Center".

   :param unit:
       The unit for the returned values. If no unit is provided, the returned values will be in "m".















   ..
       !! processed by numpydoc !!

.. py:method:: SetCenter(values: collections.abc.Sequence[str | float], unit: str | None = None) -> None

   
   Set the values of "Center".

   :param values:
       The values to set. The values can be heterogeneous, the element of values can be an
       expression with input variables or a float. Must have exactly 3 elements.
   :param unit:
       The unit for `values`. If no unit is provided, `values` is assumed to be in "m".
   :raises RockyApiError:
       If `values` doesn't have exactly 3 elements.















   ..
       !! processed by numpydoc !!

.. py:method:: GetLength(unit: str | None = None) -> float

   
   Get the value of "Length".

   :param unit:
       The unit for the returned value. If no unit is provided, the returned value will be in "m".















   ..
       !! processed by numpydoc !!

.. py:method:: SetLength(value: str | float, unit: str | None = None) -> None

   
   Set the value of "Length".

   :param value:
       The value to set. This value can be an expression with input variables or float type.
   :param unit:
       The unit for `value`. If no unit is provided, `value` is assumed to be in "m".















   ..
       !! processed by numpydoc !!

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

   
   Get the value of "Name".
















   ..
       !! processed by numpydoc !!

.. py:method:: SetName(value: str) -> None

   
   Set the value of "Name".

   :param value:
       The value to set.















   ..
       !! processed by numpydoc !!

.. py:method:: GetWidth(unit: str | None = None) -> float

   
   Get the value of "Width".

   :param unit:
       The unit for the returned value. If no unit is provided, the returned value will be in "m".















   ..
       !! processed by numpydoc !!

.. py:method:: SetWidth(value: str | float, unit: str | None = None) -> None

   
   Set the value of "Width".

   :param value:
       The value to set. This value can be an expression with input variables or float type.
   :param unit:
       The unit for `value`. If no unit is provided, `value` is assumed to be in "m".















   ..
       !! processed by numpydoc !!