================================
COGConstraint (hwx.inspire.core)
================================

Create the Center of Gravity Constraint (COG) of supplied parts.

Use the Center of Gravity Constraint (COG) to apply, reposition, and set
upper and lower bounds for a center of gravity constraint.
COG constraints are used to limit the position of the center of gravity while
running a topology optimization.

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

  +---------------------------+---------------------------+---------------------------+
  | active_: Bool             | color_: Color             | connectionRadius_: Double |
  +---------------------------+---------------------------+---------------------------+
  | connectionType_: Enum     | direction_: Direction     | distributed_: Bool        |
  +---------------------------+---------------------------+---------------------------+
  | features_: Attribute      | localToPart_: Bool        | location_: Location       |
  +---------------------------+---------------------------+---------------------------+
  | mode_: Enum               | name_: Attribute          | part_: Attribute          |
  +---------------------------+---------------------------+---------------------------+
  | parts_: Attribute         | visible_: Bool            |                           |
  +---------------------------+---------------------------+---------------------------+

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

  +-----------+-----------+
  | bounds_   | position_ |
  +-----------+-----------+

-----------------
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.

.. _color:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
color : :ref:`Color <Color (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The color assigned to the Boundary Condition.

.. _connectionRadius:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
connectionRadius : :ref:`Double <Double (hwx.inspire)>` (units="length")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The search radius for the Boundary Condition.

.. _connectionType:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
connectionType : :ref:`Enum <Enum (hwx.inspire)>` (rigid, flexible)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The type of the connection. Valid choices are:

- rigid
- flexible

.. _direction:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
direction : :ref:`Direction <Direction (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Returns the direction vector of the entity.

.. _distributed:

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


Returns whether the applied boundary condition is distributed or not.

Boundary conditions applied across the entire feature area (for faces) or length
(for edges) are distributed and at a single point boundary conditions are
non-distributed.

.. _features:

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


Returns a list of features the entity is applied to.

.. _localToPart:

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


Returns or sets 'Rotate with part'.

It makes boundary condition not to rotate or rotate along with its associated part.

.. _location:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
location : :ref:`Location <Location (hwx.inspire)>` (units="length")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Returns the location of the entity.

.. _mode:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
mode : :ref:`Enum <Enum (hwx.inspire)>` (direction, components)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Specifies the mode of the boundary condition.

Valid choices are:

  - direction
  - components

.. _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.

.. _part:

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


Returns the part on which the entity is applied graphically.

.. _parts:

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


Returns a list of parts on which the entity is applied on.

.. _visible:

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


Determines whether the Boundary Condition is visible or not.


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

.. _bounds:
.. method:: bounds

A list of the lower and upper bound values in X, Y and Z directions for 
COG during optimization, defaults to [-0.1, 0.1, -0.1, 0.1, -0.1, 0.1].
If None is specified in a position (e.g. [None, -0.1, None, None, None, None])
then this direction is inactive.

.. _position:
.. method:: position

A Matrix44 of X, Y and Z directions of COG and the current position, 
defaults to math.Matrix44(origin=getCenterOfGravity(ents))