Overview

Programming Guide

API Reference

Markup definition

Modules

 Position definition
 
 Notes
 
 Dimension
 
 Tolerance
 
 Symbols
 
 Welding
 

Data Structures

struct  A3DMDTextPropertiesData
 Markup text properties data structure.
 
struct  A3DMarkupDefinitionData
 Structure defining common data to all markup with definition.
 

Enumerations

enum  EA3DMDMarkupDisplayType { KEA3DMDDisplayType_Unknown = -1, KEA3DMDDisplayType_Unspecified = 0, KEA3DMDDisplayType_FlatToScreen = 1, KEA3DMDDisplayType_FlatToSurface = 2 }
 
enum  EA3DMDTextPropertiesScore { KEA3DMDTextPropertiesScoreNone = 0, KEA3DMDTextPropertiesUnderScored = 1, KEA3DMDTextPropertiesScored = 2, KEA3DMDTextPropertiesOverScored = 3 }
 
enum  EA3DMDTextPropertiesFormat {
  KEA3DMDTextPropertiesFormatNormal = 0, KEA3DMDTextPropertiesFormatUnderLine = 1, KEA3DMDTextPropertiesFormatOverLine = 2, KEA3DMDTextPropertiesFormatExposant = 3,
  KEA3DMDTextPropertiesFormatindice = 4
}
 
enum  EA3DMDTextPropertiesJustification { KEA3DMDTextPropertiesJustificationLeft = 0, KEA3DMDTextPropertiesJustificationCenter = 1, KEA3DMDTextPropertiesJustificationRight = 2 }
 
enum  EA3DMDMarkupDisplayType { KEA3DMDDisplayType_Unknown = -1, KEA3DMDDisplayType_Unspecified = 0, KEA3DMDDisplayType_FlatToScreen = 1, KEA3DMDDisplayType_FlatToSurface = 2 }
 
enum  EA3DMDTextPropertiesScore { KEA3DMDTextPropertiesScoreNone = 0, KEA3DMDTextPropertiesUnderScored = 1, KEA3DMDTextPropertiesScored = 2, KEA3DMDTextPropertiesOverScored = 3 }
 Enumerator that describes the score type applied on text. More...
 
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...
 

Functions

A3DStatus A3DMDTextPropertiesGet (const A3DMDTextProperties *pTextProperties, A3DMDTextPropertiesData *pData)
 Populates the A3DMDTextPropertiesData structure. More...
 
A3DStatus A3DMarkupDefinitionGet (const A3DMarkupDefinition *pMarkupDefinition, A3DMarkupDefinitionData *pData)
 Populates the A3DMarkupDefinitionData 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.

pmi_access.png

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.

pmi_access_sample.png

See the following sample code:

//markup data
A3DInt32 iRet=A3DEntityGetType( pMarkup, &eType);
// if ( iRet!=A3D_SUCCESS ) exit
if(eType == kA3DTypeMkpMarkup)
{
//no definition is set, no information to retrieve
//terminate...
}
//markup definition data
A3DMarkupDefinitionData sDataDefinition;
A3D_INITIALIZE_DATA( A3DMarkupDefinitionData, sDataDefinition);
A3DInt32 iRet=A3DMarkupDefinitionGet((A3DMarkupDefinition*)pMarkup, &sDataDefinition);//sDataDefinition contains basic definition information
//specific data
A3DMarkupDimensionData sDimensionData;
switch(eType)
{
A3DMarkupTextData sTextData;
A3D_INITIALIZE_DATA( A3DMarkupTextData, sTextData);
A3DInt32 iRet=A3DMarkupTextGet((A3DMarkupText*)pMarkup, &sTextData);
break;
A3DMarkupDimensionData sDimensionData;
A3D_INITIALIZE_DATA( A3DMarkupDimensionData, sDimensionData);
A3DInt32 iRet=A3DMarkupTextGet((A3DMarkupDimension*)pMarkup, &sDimensionData);
break;
A3DMarkupGDTData sGDTData;
A3D_INITIALIZE_DATA( A3DMarkupGDTData, sGDTData);
A3DInt32 iRet=A3DMarkupGDTGet((A3DMarkupGDT*)pMarkup, &sGDTData);
break;
...same thing for all types
default:
break;
}