Position definition

Types

	A3DMDPosition3DData
	A3DMDPosition2DData
	A3DMDPositionReferenceData
	`EA3DMDAnchorPointType`

Fields

	`KEA3DMDAnchorIgnored`
	`KEA3DMDAnchorTop_left`
	`KEA3DMDAnchorTop_center`
	`KEA3DMDAnchorTop_right`
	`KEA3DMDAnchorMiddle_left`
	`KEA3DMDAnchorMiddle_center`
	`KEA3DMDAnchorMiddle_right`
	`KEA3DMDAnchorMiddle_auto`
	`KEA3DMDAnchorBottom_left`
	`KEA3DMDAnchorBottom_center`
	`KEA3DMDAnchorBottom_right`
	`KEA3DMDAnchorBottom_auto`
	`KEA3DMDAnchorAutomatic`

Functions

`A3DStatus`	`A3DMDPosition3DGet`
`A3DStatus`	`A3DMDPosition2DGet`
`A3DStatus`	`A3DMDPositionReferenceGet`

Detailed Description

group a3d_markupposition

Positionning information are stored in one of this three structure:

A3DMDPosition3DData, defined by a 3D vector
A3DMDPosition2DData, defined by a 2D vector and a plane
A3DMDPositionReferenceData, according to another position

Version: 4.0

Type Documentation

enum EA3DMDAnchorPointType

Markup anchor point type.

Values:

enumerator KEA3DMDAnchorIgnored

enumerator KEA3DMDAnchorTop_left: Top left point.

enumerator KEA3DMDAnchorTop_center: Top center point.

enumerator KEA3DMDAnchorTop_right: Top right point.

enumerator KEA3DMDAnchorMiddle_left: Middle left point.

enumerator KEA3DMDAnchorMiddle_center: Middle center point.

enumerator KEA3DMDAnchorMiddle_right: Middle right point.

enumerator KEA3DMDAnchorMiddle_auto: Closest point to the middle of the frame.

enumerator KEA3DMDAnchorBottom_left: Bottom left point.

enumerator KEA3DMDAnchorBottom_center: Bottom center point.

enumerator KEA3DMDAnchorBottom_right: Bottom right point.

enumerator KEA3DMDAnchorBottom_auto: Closest point to the bottom of the frame.

enumerator KEA3DMDAnchorAutomatic: Closest point to the frame.

Function Documentation

A3DStatus A3DMDPosition3DGet(const A3DMDPosition3D *pPosition3D, A3DMDPosition3DData *pData)

Populates the A3DMDPosition3DData structure.

Version: 4.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 A3DMDPosition2DGet(const A3DMDPosition2D *pPosition2D, A3DMDPosition2DData *pData)

Populates the A3DMDPosition2DData structure.

Version: 4.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 A3DMDPositionReferenceGet(const A3DMDPositionReference *pPositionReference, A3DMDPositionReferenceData *pData)

Populates the A3DMDPositionReferenceData structure.

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