A3DSDKMarkupDefinition.h

Header file for the markup with definition module.

Author

Tech Soft 3D

Version

23.0

Date

January 2023

Copyright (c) 2010 - 2023 by Tech Soft 3D, Inc. All rights reserved.

Content

Data Structures

A3DMDTextPropertiesData

Markup text properties data structure.

A3DMarkupDefinitionData

Structure defining common data to all markup with definition.

Macro definitions

__A3DPRCMARKUPDEFINITION__

Functions

A3DMDTextPropertiesGet()

Populates the A3DMDTextPropertiesData structure.

A3DMarkupDefinitionGet()

Populates the A3DMarkupDefinitionData structure.

A3DMarkupPositionIsScreenLocation()

Test if the position of the markup is a screen position, and return the position and the offset of the anchor point.

Macro definitions

__A3DPRCMARKUPDEFINITION__

Functions

A3DStatus A3DMDTextPropertiesGet(const A3DMDTextProperties *pTextProperties, A3DMDTextPropertiesData *pData)

Populates the A3DMDTextPropertiesData 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 in case of success or an error code

A3DStatus A3DMarkupDefinitionGet(const A3DMarkupDefinition *pMarkupDefinition, A3DMarkupDefinitionData *pData)

Populates the A3DMarkupDefinitionData 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 in case of success or an error code

A3DStatus A3DMarkupPositionIsScreenLocation(const A3DMarkupDefinition *pMarkupDefinition, A3DBool *pIsScreenLocation, A3DMDPosition2DData *pPosition, A3DVector2dData *pOffsetAnchorPoint)

Test if the position of the markup is a screen position, and return the position and the offset of the anchor point.

Version

9.2

Parameters

  • pMarkupDefinition – [in] is the markup.

  • pIsScreenLocation – [out] true if the position of the markup is a screen position.

  • pPosition – [out] is the 2D position of the markup.

  • pOffsetAnchorPoint – [out] is the offset of position of the markup.

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 in case of success or an error code