====================================
MotionConnector (hwx.inspire.motion)
====================================

Base class for Motion Objects that connect

Inherits:
  - :ref:`MotionObject (hwx.inspire.motion)`

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

  +----------------------------+----------------------------+----------------------------+
  | active_: Bool              | clevisPinHoles_: Attribute | connectionRadius_: Double  |
  +----------------------------+----------------------------+----------------------------+
  | direction_: Direction      | entity1_: Attribute        | entity2_: Attribute        |
  +----------------------------+----------------------------+----------------------------+
  | flipAxis_: Bool            | location1_: Location       | location2_: Location       |
  +----------------------------+----------------------------+----------------------------+
  | name_: Attribute           | parts_: Attribute          | rotation_: Double          |
  +----------------------------+----------------------------+----------------------------+
  | visible_: Bool             |                                                         |
  +----------------------------+---------------------------------------------------------+

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

  +-----------+-----------+-----------+
  | axis_     | features_ | location_ |
  +-----------+-----------+-----------+
  | 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.

.. _clevisPinHoles:

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


Lists all the cylindrical features from a clevis pin part, that has 3 aligned holes
and outside two holes are in the same part.

.. _connectionRadius:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
connectionRadius : :ref:`Double <Double (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Specifies the radius of the connection.

.. _direction:

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


Returns or sets the direction of the object.

.. _entity1:

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


The first feature entity connector is attached to.

.. _entity2:

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


The second feature entity connector is attached to.

.. _flipAxis:

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


Allows to flip the axis of the object.

.. _location1:

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


Specifies the location of the connector object wrt to entity1.

.. _location2:

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


Specifies the location of the connector object wrt to entity2.

.. _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)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Lists all the parts the object is attached to.

.. _rotation:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
rotation : :ref:`Double <Double (hwx.inspire)>` (units="angle")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Specifies the angle of rotation from the shaft of the object.

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

.. _axis:
.. method:: axis

Specifies two points along the connector.

This affects the connectors location and position.

.. _features:
.. method:: features

Returns the features associated with the connector object.

.. _location:
.. method:: location

Specifies the location of the connector object.

For PointToPoint and hole based Face mode connectors this is the
center of the object / axis.  For Face mode connectors attached to a non
hole face this the location1.

Location is not necessarily the same as the origin of the position.

.. _position:
.. method:: position

Specifies the objects position in global space.

This affects where the move tool will show up.