Hyperbolic Curve

Detailed Description

group a3d_crvhyperbola

Entity type is kA3DTypeCrvHyperbola.

Version
2.0

For the canonical definition of this curve and its corresponding parametric equation, see the “SerializeHyperbola” section of the .

The A3DParameterizationData struct specified by the A3DCrvHyperbolaData::m_sParam member specifies reparameterization and trim for the curve.

Attention
In version 2.1 and earlier, values for the parameterization type named by the A3DCrvHyperbolaData::m_cParamType member are inverted compared to the corresponding values in the .

Function Documentation

A3DStatus A3DCrvHyperbolaGet(const A3DCrvHyperbola *pCrv, A3DCrvHyperbolaData *pData)

Populates the A3DCrvHyperbolaData structure.

Version
2.0

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 A3DCrvHyperbolaCreate(const A3DCrvHyperbolaData *pData, A3DCrvHyperbola **ppCrv)

Creates an A3DCrvHyperbola from A3DCrvHyperbolaData structure.

Version
2.0

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