A3DSDKMarkupText.h

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

A3DMDTextPositionData

Markup text position.

A3DMarkupTextData

Note with simple text (m_ppcLines) and text properties like font, size, thickness…

A3DMarkupCoordinateData

Markup text with additional data. Use A3DMarkupTextGet to access to markup text data.

A3DMarkupRichTextData

Markup rich text data.

Functions

A3DMDTextPositionGet()

Populates the A3DMDTextPositionData structure.

A3DMarkupTextGet()

Populates the A3DMarkupTextData structure.

A3DMarkupCoordinateGet()

Populates the A3DMarkupCoordinateData structure.

A3DMarkupRichTextGet()

Populates the A3DMarkupRichTextData structure.

Functions

A3DStatus A3DMDTextPositionGet(const A3DMDTextPosition *pTextPosition, A3DMDTextPositionData *pData)

Populates the A3DMDTextPositionData 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 A3DMarkupTextGet(const A3DMarkupText *pMarkupText, A3DMarkupTextData *pData)

Populates the A3DMarkupTextData 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 A3DMarkupCoordinateGet(const A3DMarkupCoordinate *pMarkupCoordinate, A3DMarkupCoordinateData *pData)

Populates the A3DMarkupCoordinateData 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 A3DMarkupRichTextGet(const A3DMarkupRichText *pMarkupRichText, A3DMarkupRichTextData *pData)

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