Coordinate System Representation Item

Detailed Description

group a3d_ricoordinatesystem

An axis system.

An A3DRiCoordinateSystem is an A3DRiRepresentationItem that specifies a coordinate system. The A3DRiCoordinateSystemData structure contains an A3DMiscCartesianTransformation axis system. This axis system owns the geometric data: there is no particular geometry attached, and the user is responsible for representation.

Note

An A3DRiCoordinateSystem is an A3DRiRepresentationItem and not an A3DMiscCartesianTransformation. Being a representation item, a coordinate system can own a local coordinate system (on the RI level), which can also own a local coordinate system, and so on…

Function Documentation

A3DStatus A3DRiCoordinateSystemGet(const A3DRiCoordinateSystem *pCoordinateSystem, A3DRiCoordinateSystemData *pData)

Populates the A3DRiCoordinateSystemData 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 A3DRiCoordinateSystemCreate(const A3DRiCoordinateSystemData *pData, A3DRiCoordinateSystem **ppCoordinateSystem)

Creates an A3DRiCoordinateSystem from an A3DRiCoordinateSystemData structure.

Version
2.0

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

A3D_SUCCESS on success, or an error code on failure
A3DStatus A3DRiCoordinateSystemEdit(const A3DRiCoordinateSystemData *pData, A3DRiCoordinateSystem *pCoordinateSystem)

Modifies an A3DRiCoordinateSystem from an A3DRiCoordinateSystemData structure.

Version
10.0

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

A3D_SUCCESS on success, or an error code on failure