Helix Curve
Data Structures | |
struct | A3DCrvHelixData |
Helical arc structure. More... | |
struct | A3DCrvHelixPitchCstData |
Constant pitch structure for helix curves. More... | |
struct | A3DCrvHelixPitchVarData |
Variable Pitch structure for helical arc structure. More... | |
Enumerations | |
enum | A3DEHelixType { kA3DConstantPitch = 0, kA3DVariablePitch } |
Enumerated values that characterize helix curves. More... | |
Functions | |
A3DStatus | A3DCrvHelixCreate (const A3DCrvHelixData *pData, A3DCrvHelix **ppCrv) |
Creates an A3DCrvHelix from A3DCrvHelixData structure. More... | |
A3DStatus | A3DCrvHelixGet (const A3DCrvHelix *pCrv, A3DCrvHelixData *pData) |
Populates the A3DCrvHelixData structure. More... | |
Detailed Description
- Version
- 2.0
Entity type is kA3DTypeCrvHelix.
For the canonical definition of this curve, see the "SerializeHelix01" section of the PRC Format Specification.
A3DParameterizationData allows for reparameterization and trim.
A3DMiscCartesianTransformationData allows for specific placement.
- Note
- kA3DConstantPitch and kA3DVariablePitch correspond to type 0 and 1 respectively in PRC Format Specification.
Enumeration Type Documentation
◆ A3DEHelixType
enum A3DEHelixType |
Function Documentation
◆ A3DCrvHelixGet()
A3DStatus A3DCrvHelixGet | ( | const A3DCrvHelix * | pCrv, |
A3DCrvHelixData * | pData | ||
) |
Populates the A3DCrvHelixData structure.
- Version
- 2.0
- Returns
- A3D_SUCCESS in case of success or an error code
- 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
- Attention
- FUNCTION IS NOT IMPLEMENTED YET
◆ A3DCrvHelixCreate()
A3DStatus A3DCrvHelixCreate | ( | const A3DCrvHelixData * | pData, |
A3DCrvHelix ** | ppCrv | ||
) |
Creates an A3DCrvHelix from A3DCrvHelixData structure.
- Version
- 2.0
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_INVALID_DATA_STRUCT_SIZE A3D_INVALID_DATA_STRUCT_NULL A3D_INTERVAL_INCONSISTENT_DATA A3D_SUCCESS
- Attention
- FUNCTION IS NOT IMPLEMENTED YET