.. _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* <https://docs.techsoft3d.com/exchange/latest/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* <https://docs.techsoft3d.com/exchange/latest/SC2N570-PRC-WD.pdf>`__\ . 


**Returns**


   ``A3D_SUCCESS`` on success, or an error code on failure


.. rst-class:: kind-group kind-record

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


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


* :c:struct:`~A3DCrvHelixPitchCstData`
* :c:struct:`~A3DCrvHelixPitchVarData`
* :c:struct:`~A3DCrvHelixData`

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

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


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


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

.. toctree::
   :maxdepth: 1
   :hidden:

   ../structures/A3DCrvHelixPitchCstData
   ../structures/A3DCrvHelixPitchVarData
   ../structures/A3DCrvHelixData
   ../enums/A3DEHelixType
   ../functions/A3DCrvHelixGet
   ../functions/A3DCrvHelixCreate


