================================
ShapeVariable (hwx.inspire.core)
================================

Define which directions PolyNURBS cage points can move during PolyNURBS optimization.

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

  +------------------+------------------+------------------+
  | active_: Bool    | name_: Attribute | visible_: Bool   |
  +------------------+------------------+------------------+

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

  +------------------+------------------+
  | features_        | pointDirections_ |
  +------------------+------------------+

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

  +----------------------------------------+
  | __new__ (cls, pointDirections, **kwds) |
  +----------------------------------------+
  | getFeatures_ (self)                    |
  +----------------------------------------+

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

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

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


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

.. _features:
.. property:: features

A list of all features of ShapeVariable.
    

.. _pointDirections:
.. property:: pointDirections

A dictionary representation of each FeaturePoint direction

Returns:
  dict[FeaturePoint, math.Vector]

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

.. ___new__:
.. method:: __new__(cls, pointDirections, **kwds)

Define the direction the cage points can move during PolyNURBS optimization.

If you want cage points to move in different directions, you should create
multiple shape variables.

:param pointDirections: A mapping of FeaturePoints
                     to their corresponding direction.
:type pointDirections: dict[FeaturePoint, math.Vector]

:returns: ShapeVariable


.. _getFeatures:
.. method:: getFeatures(self)

Returns a list of all features of ShapeVariable.