Data Structures | |
struct | A3DMarkupDefinitionData |
Structure defining common data to all markup with definition. More... | |
struct | A3DMDTextPropertiesData |
Markup text properties data structure. More... | |
Modules | |
Position definition | |
Notes | |
Dimension | |
Tolerance | |
Symbols | |
Welding | |
Enumerations | |
enum | EA3DMDMarkupDisplayType { KEA3DMDDisplayType_Unknown = -1, KEA3DMDDisplayType_Unspecified = 0, KEA3DMDDisplayType_FlatToScreen = 1, KEA3DMDDisplayType_FlatToSurface = 2 } |
enum | EA3DMDTextPropertiesFormat { KEA3DMDTextPropertiesFormatNormal = 0, KEA3DMDTextPropertiesFormatUnderLine = 1, KEA3DMDTextPropertiesFormatOverLine = 2, KEA3DMDTextPropertiesFormatExposant = 3, KEA3DMDTextPropertiesFormatindice = 4 } |
Enumerator that describes the format text. More... | |
enum | EA3DMDTextPropertiesJustification { KEA3DMDTextPropertiesJustificationLeft = 0, KEA3DMDTextPropertiesJustificationCenter = 1, KEA3DMDTextPropertiesJustificationRight = 2 } |
Enumerator that justifies the text. More... | |
enum | EA3DMDTextPropertiesScore { KEA3DMDTextPropertiesScoreNone = 0, KEA3DMDTextPropertiesUnderScored = 1, KEA3DMDTextPropertiesScored = 2, KEA3DMDTextPropertiesOverScored = 3 } |
Enumerator that describes the score type applied on text. More... | |
Functions | |
A3DStatus | A3DMarkupDefinitionGet (const A3DMarkupDefinition *pMarkupDefinition, A3DMarkupDefinitionData *pData) |
Populates the A3DMarkupDefinitionData structure. More... | |
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. More... | |
A3DStatus | A3DMDTextPropertiesGet (const A3DMDTextProperties *pTextProperties, A3DMDTextPropertiesData *pData) |
Populates the A3DMDTextPropertiesData structure. More... | |
Detailed Description
- Version
- 4.0
The A3DMkpAnnotationItemData structure references an A3DMkpMarkup. This markup contains tessellation, leaders, and linked item information that is available by using the function A3DMkpMarkupGet. In addition this markup can contain also definition and specific data. Those data are stored in common structure A3DMarkupDefinitionData and in a specific structure corresponding to the type return by the function A3DEntityGetType. For the structures corresponding to markups with definition, only access functions are defined. In other words, the customer can only create A3DMkpMarkup.
The following illustration shows the available methods to retrieve all the data.
In yellow, the data stored in the structure; in blue, the access function defined for corresponding structure.

Here, it samples of the two ways to obtain markup data. In the first case, the markup contains only a tessellation, a type, and a sub type, in the second case, considering a markup text creation, the markup contains specific data (text, text properties (font...), position definition, display options, with a tessellation, a type, and a sub type.

See the following sample code:
Enumeration Type Documentation
◆ EA3DMDMarkupDisplayType
The markup position is defined by an attach point and an attach type.
The attach type specifies the point of markup frame on which the attach point will be aligned. See below.

Enumerator | |
---|---|
KEA3DMDDisplayType_Unknown | Unknown. |
KEA3DMDDisplayType_Unspecified | Unspecified. |
KEA3DMDDisplayType_FlatToScreen | Flat to screen. |
KEA3DMDDisplayType_FlatToSurface | Flat to surface. |
◆ EA3DMDTextPropertiesScore
Enumerator that describes the score type applied on text.
◆ EA3DMDTextPropertiesFormat
Enumerator that describes the format text.
◆ EA3DMDTextPropertiesJustification
Function Documentation
◆ A3DMDTextPropertiesGet()
A3DStatus A3DMDTextPropertiesGet | ( | const A3DMDTextProperties * | pTextProperties, |
A3DMDTextPropertiesData * | pData | ||
) |
Populates the A3DMDTextPropertiesData structure.
- Version
- 4.0
◆ A3DMarkupDefinitionGet()
A3DStatus A3DMarkupDefinitionGet | ( | const A3DMarkupDefinition * | pMarkupDefinition, |
A3DMarkupDefinitionData * | pData | ||
) |
Populates the A3DMarkupDefinitionData structure.
- Version
- 4.0
◆ A3DMarkupPositionIsScreenLocation()
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.
- Parameters
-
[in] pMarkupDefinition is the markup. [out] pIsScreenLocation true if the position of the markup is a screen position. [out] pPosition is the 2D position of the markup. [out] pOffsetAnchorPoint is the offset of position of the markup.
- Version
- 9.2