A3DSDKMarkupLeaderDefinition.h

Header file for the leader 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

A3DMDPosition3DData

Definition of a position with a 3D vector.

A3DMDPosition2DData

Definition of a position with a 2D vector, a plane and an offset.

A3DMDPositionReferenceData

Definition of a position according to another position.

A3DMDLeaderSymbolData

Markup leader symbol data structure.

A3DMDMarkupLeaderStubData

Markup Leader stub data structure.

A3DMDLeaderDefinitionData

Leader data structure.

Macro definitions

__A3DPRCMARKUPLEADERDEFINITION__

Functions

A3DMDPosition3DGet()

Populates the A3DMDPosition3DData structure.

A3DMDPosition2DGet()

Populates the A3DMDPosition2DData structure.

A3DMDPositionReferenceGet()

Populates the A3DMDPositionReferenceData structure.

A3DMDLeaderSymbolGet()

Populates the A3DMDLeaderSymbolData structure.

A3DMDMarkupLeaderStubGet()

Populates the A3DMDMarkupLeaderStubData structure.

A3DMDLeaderDefinitionGet()

Populates the A3DMDLeaderDefinitionData structure.

Macro definitions

__A3DPRCMARKUPLEADERDEFINITION__

Functions

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

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

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

A3DStatus A3DMDLeaderSymbolGet(const A3DMDLeaderSymbol *pLeaderSymbol, A3DMDLeaderSymbolData *pData)

Populates the A3DMDLeaderSymbolData 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 A3DMDMarkupLeaderStubGet(const A3DMDMarkupLeaderStub *pLeaderStub, A3DMDMarkupLeaderStubData *pData)

Populates the A3DMDMarkupLeaderStubData 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 A3DMDLeaderDefinitionGet(const A3DMDLeaderDefinition *pLeader, A3DMDLeaderDefinitionData *pData)

Populates the A3DMDLeaderDefinitionData 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