.. _group__a3d__crvhelix:

###########
Helix Curve
###########


   2.0


Entity type is :c:enumerator:`~kA3DTypeCrvHelix`\ .

For the canonical definition of this curve, see the "SerializeHelix01" section of the \ `*PRC Format Specification* </hoops/exchange/_static/SC2N570-PRC-WD.pdf>`__\ .

:c:struct:`~A3DParameterizationData` allows for reparameterization and trim.

:c:struct:`~A3DMiscCartesianTransformationData` allows for specific placement.


   :c:enumerator:`~kA3DConstantPitch` and :c:enumerator:`~kA3DVariablePitch` correspond to type 0 and 1 respectively in \ `*PRC Format Specification* </hoops/exchange/_static/SC2N570-PRC-WD.pdf>`__\ .


.. rst-class:: kind-group kind-enumeration

.. rubric:: Enumerations
   :class: kind-group-title


.. rst-class:: api-xref-list


* :c:enum:`~A3DEHelixType`

.. rst-class:: kind-group kind-enumerator

.. rubric:: Enumerators
   :class: kind-group-title


.. rst-class:: api-xref-list


* :c:enumerator:`~kA3DConstantPitch`
* :c:enumerator:`~kA3DVariablePitch`

.. rst-class:: kind-group kind-function

.. rubric:: Functions
   :class: kind-group-title


.. rst-class:: api-xref-list


* :c:func:`~A3DCrvHelixCreate`
* :c:func:`~A3DCrvHelixGet`


