A3DSDKMarkupSymbol.h

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

A3DMarkupRoughnessData

defined in file A3DSDKMarkupSymbol.h Values of m_eRoughType , m_eRoughMode , and m_eRoughContactArea define the Roughness symbol form.

A3DMarkupBalloonData

Markup balloon.

A3DMarkupFastenerData

Markup fastener.

A3DMarkupLocatorData

Markup locator.

A3DMarkupMeasurementPointData

Markup measurement point.

Functions

A3DMarkupRoughnessGet()

Populates the A3DMarkupRoughnessData structure.

A3DMarkupBalloonGet()

Populates the A3DMarkupBalloonData structure.

A3DMarkupFastenerGet()

Populates the A3DMarkupFastenerData structure.

A3DMarkupLocatorGet()

Populates the A3DMarkupLocatorData structure.

A3DMarkupMeasurementPointGet()

Populates the A3DMarkupMeasurementPointData structure.

Functions

A3DStatus A3DMarkupRoughnessGet(const A3DMarkupRoughness *pMarkupRoughness, A3DMarkupRoughnessData *pData)

Populates the A3DMarkupRoughnessData structure.

Version

4.0

Parameters
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 A3DMarkupBalloonGet(const A3DMarkupBalloon *pBalloon, A3DMarkupBalloonData *pData)

Populates the A3DMarkupBalloonData 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 A3DMarkupFastenerGet(const A3DMarkupFastener *pFastener, A3DMarkupFastenerData *pData)

Populates the A3DMarkupFastenerData 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 A3DMarkupLocatorGet(const A3DMarkupLocator *pLocator, A3DMarkupLocatorData *pData)

Populates the A3DMarkupLocatorData 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 A3DMarkupMeasurementPointGet(const A3DMarkupMeasurementPoint *pMeasurementPoint, A3DMarkupMeasurementPointData *pData)

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