Direction Representation Item

Detailed Description

group a3d_ridirection

An A3DRiDirection is defined by a point (optional) and a vector (mandatory).

Version
2.0

Function Documentation

A3DStatus A3DRiDirectionGet(const A3DRiDirection *pDirection, A3DRiDirectionData *pData)

Populates the A3DRiDirectionData 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_SUCCESS –
Returns:

A3D_SUCCESS on success, or an error code on failure
A3DStatus A3DRiDirectionCreate(const A3DRiDirectionData *pData, A3DRiDirection **ppDirection)

Creates an A3DRiDirection from an A3DRiDirectionData structure.

Todo:

Not yet implemented

Version
2.0

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

A3D_SUCCESS on success, or an error code on failure
A3DStatus A3DRiDirectionEdit(const A3DRiDirectionData *pData, A3DRiDirection *pDirection)

Modifies an A3DRiDirection from an A3DRiDirectionData structure.

Todo:

Not yet implemented

Version
10.0

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

A3D_SUCCESS on success, or an error code on failure