Data Structures

struct  A3DMDPosition2DData
 Definition of a position with a 2D vector, a plane and an offset. More...
 
struct  A3DMDPosition3DData
 Definition of a position with a 3D vector. More...
 
struct  A3DMDPositionReferenceData
 Definition of a position according to another position. More...
 

Enumerations

enum  EA3DMDAnchorPointType { ,
  KEA3DMDAnchorTop_left = 0,
  KEA3DMDAnchorTop_center = 1,
  KEA3DMDAnchorTop_right = 2,
  KEA3DMDAnchorMiddle_left = 10,
  KEA3DMDAnchorMiddle_center = 11,
  KEA3DMDAnchorMiddle_right = 12,
  KEA3DMDAnchorMiddle_auto = 13,
  KEA3DMDAnchorBottom_left = 20,
  KEA3DMDAnchorBottom_center = 21,
  KEA3DMDAnchorBottom_right = 22,
  KEA3DMDAnchorBottom_auto = 23,
  KEA3DMDAnchorAutomatic = 24
}
 Markup anchor point type. More...
 

Functions

A3DStatus A3DMDPosition2DGet (const A3DMDPosition2D *pPosition2D, A3DMDPosition2DData *pData)
 Populates the A3DMDPosition2DData structure. More...
 
A3DStatus A3DMDPosition3DGet (const A3DMDPosition3D *pPosition3D, A3DMDPosition3DData *pData)
 Populates the A3DMDPosition3DData structure. More...
 
A3DStatus A3DMDPositionReferenceGet (const A3DMDPositionReference *pPositionReference, A3DMDPositionReferenceData *pData)
 Populates the A3DMDPositionReferenceData structure. More...
 

Detailed Description

Version
4.0

Positionning information are stored in one of this three structure:

Enumeration Type Documentation

◆ EA3DMDAnchorPointType

Markup anchor point type.

Enumerator
KEA3DMDAnchorTop_left 

Top left point.

KEA3DMDAnchorTop_center 

Top center point.

KEA3DMDAnchorTop_right 

Top right point.

KEA3DMDAnchorMiddle_left 

Middle left point.

KEA3DMDAnchorMiddle_center 

Middle center point.

KEA3DMDAnchorMiddle_right 

Middle right point.

KEA3DMDAnchorMiddle_auto 

Closest point to the middle of the frame.

KEA3DMDAnchorBottom_left 

Bottom left point.

KEA3DMDAnchorBottom_center 

Bottom center point.

KEA3DMDAnchorBottom_right 

Bottom right point.

KEA3DMDAnchorBottom_auto 

Closest point to the bottom of the frame.

KEA3DMDAnchorAutomatic 

Closest point to the frame.

Function Documentation

◆ A3DMDPosition3DGet()

A3DStatus A3DMDPosition3DGet ( const A3DMDPosition3D pPosition3D,
A3DMDPosition3DData pData 
)

Populates the A3DMDPosition3DData structure.

Version
4.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_SUCCESS

◆ A3DMDPosition2DGet()

A3DStatus A3DMDPosition2DGet ( const A3DMDPosition2D pPosition2D,
A3DMDPosition2DData pData 
)

Populates the A3DMDPosition2DData structure.

Version
4.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_SUCCESS

◆ A3DMDPositionReferenceGet()

A3DStatus A3DMDPositionReferenceGet ( const A3DMDPositionReference pPositionReference,
A3DMDPositionReferenceData pData 
)

Populates the A3DMDPositionReferenceData structure.

Version
4.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_SUCCESS