Helix Curve

Detailed Description

group a3d_crvhelix

Entity type is kA3DTypeCrvHelix.

Version
2.0

For the canonical definition of this curve, see the “SerializeHelix01” section of the .

A3DParameterizationData allows for reparameterization and trim.

A3DMiscCartesianTransformationData allows for specific placement.

Note

kA3DConstantPitch and kA3DVariablePitch correspond to type 0 and 1 respectively in .

Type Documentation

enum A3DEHelixType

Enumerated values that characterize helix curves.

Version
2.0

Values:

enumerator kA3DConstantPitch

Constant pitch.

enumerator kA3DVariablePitch

Variable pitch.

Function Documentation

A3DStatus A3DCrvHelixGet(const A3DCrvHelix *pCrv, A3DCrvHelixData *pData)

Populates the A3DCrvHelixData structure.

Version
2.0
Attention
FUNCTION IS NOT IMPLEMENTED YET

Return values:
  • A3D_INITIALIZE_NOT_CALLED –
  • A3D_INVALID_DATA_STRUCT_SIZE –
  • A3D_INVALID_DATA_STRUCT_NULL –
  • A3D_INVALID_ENTITY_NULL –
  • A3D_INVALID_ENTITY_TYPE –
  • A3D_CRV_CANNOT_ACCESS_CANONICAL –
  • A3D_SUCCESS –
Returns:

A3D_SUCCESS on success, or an error code on failure
A3DStatus A3DCrvHelixCreate(const A3DCrvHelixData *pData, A3DCrvHelix **ppCrv)

Creates an A3DCrvHelix from A3DCrvHelixData structure.

Version
2.0
Attention
FUNCTION IS NOT IMPLEMENTED YET

Return values:
  • A3D_INVALID_DATA_STRUCT_SIZE –
  • A3D_INVALID_DATA_STRUCT_NULL –
  • A3D_INTERVAL_INCONSISTENT_DATA –
  • A3D_SUCCESS –
Returns:

A3D_SUCCESS on success, or an error code on failure