=============================
RigidGroup (hwx.inspire.core)
=============================

Group of parts which don't move relative to each other and are realized to
motion as a single rigid body.

Rigid groups are mutually exclusive meaning a part can't be in two at the same time.

----------
Attributes
----------

  +-------------------+-------------------+-------------------+
  | active_: Bool     | ground_: Bool     | ip_: Inertia      |
  +-------------------+-------------------+-------------------+
  | mass_: Double     | name_: Attribute  | parts_: Attribute |
  +-------------------+-------------------+-------------------+
  | visible_: Bool    |                                       |
  +-------------------+---------------------------------------+

----------
Properties
----------

  +-----------+-----------+
  | cg_       | position_ |
  +-----------+-----------+

--------------
Public Methods
--------------

  +-----------------------------------+
  | classmethod create_ (cls, **kwds) |
  +-----------------------------------+
  | add_ (self, parts)                |
  +-----------------------------------+
  | discard_ (self, parts)            |
  +-----------------------------------+
  | remove_ (self, parts)             |
  +-----------------------------------+

-----------------
Attribute Details
-----------------

.. _active:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
active : :ref:`Bool <Bool (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Returns or sets the object activeness.

Setting this on or off sets all children.
Setting to True sets all the parents active too.

.. _ground:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ground : :ref:`Bool <Bool (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Returns True, if any of the rigid group parts are grounded.

.. _ip:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ip : :ref:`Inertia <Inertia (hwx.inspire)>` (units="massMI")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^




.. _mass:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
mass : :ref:`Double <Double (hwx.inspire)>` (units="m")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Returns the combined mass of all the parts in rigid group.

.. _name:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
name : :ref:`Attribute <Attribute (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Returns or sets the name of the object.

It can be any text string, including spaces, although it's best to avoid
using the following characters: " ' * ? and $.

While these characters are allowed, they could create difficulties when
you export the model to other applications.

.. _parts:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
parts : :ref:`Attribute <Attribute (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


List of parts in the rigid group.

.. _visible:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
visible : :ref:`Bool <Bool (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Determines whether the object is visible in the modeling window.

Setting this on or off sets all children.
Setting to True sets all the parents visible too.


----------------
Property Details
----------------

.. _cg:
.. method:: cg

Returns the center of gravity point of the rigid group.

.. _position:
.. method:: position

Returns the position of the first part as a Matrix44.

--------------
Method Details
--------------

.. _create:
.. classmethod:: create(cls, **kwds)

Create and returns a Rigid Group.

Args:
**name (str) : Name of the rigid group.
**parts (list[Part]) : Specify a part or list of parts to create rigid group.

:returns: Return created rigid group.
:rtype: RigidGroup


.. _add:
.. method:: add(self, parts)

Adds part or parts to the rigid group.

Errors if the part already exists in the rigid group.

:param parts: List of part or parts to add into rigid group.
:type parts: list[Part]


.. _discard:
.. method:: discard(self, parts)

Remove part or parts from the rigid group.

:param parts: List of part or parts to remove from the rigid group.
:type parts: list(Part)


.. _remove:
.. method:: remove(self, parts)

Remove part or parts from the rigid group.

Errors if the part does not exists in rigid group.

:param parts: List of part or parts to remove from the rigid group.
:type parts: list[Part]