=======================
Axis (hwx.inspire.core)
=======================

Reference Axis can be used to create or modify geometry.

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

  +----------------------+----------------------+----------------------+
  | active_: Bool        | moveWithPart_: Bool  | name_: Attribute     |
  +----------------------+----------------------+----------------------+
  | origin_: Location    | part_: Attribute     | position_: Attribute |
  +----------------------+----------------------+----------------------+
  | systemType_: Enum    | type_: Enum          | visible_: Bool       |
  +----------------------+----------------------+----------------------+

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

  +----------------------------------------+
  | __new__ (cls, features, directionType) |
  +----------------------------------------+

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

.. _moveWithPart:

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


Whether the system is moving with the associated part or not.

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

.. _origin:

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


The origin of this system in local coordinate system.

.. _part:

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


The part associated with this system.

.. _position:

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


The global transform as a Matrix44.

.. _systemType:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
systemType : :ref:`Enum <Enum (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The type of the system.

.. _type:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
type : :ref:`Enum <Enum (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


The type of the system.

.. _visible:

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


Determines whether the object is visible in the graphics window.

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


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

.. ___new__:
.. method:: __new__(cls, features, directionType)

Create a reference axis.

:param features: Features to create a reference axis.
:type features: list[Feature]
:param directionType: Direction Type.
                   - THROUGH_EDGE
                   - THROUGH_CYLINDER
                   - THROUGH_TWO_POINTS
                   - THROUGH_TWO_PLANES
                   - NORMAL_TO_FACE_AT_A_POINT
:type directionType: str