Data Structures

struct  A3DMarkupCoordinateData
 Markup text with additional data. Use A3DMarkupTextGet to access to markup text data. More...
 
struct  A3DMarkupTextData
 Note with simple text (m_ppcLines) and text properties like font, size, thickness... More...
 
struct  A3DMDTextPositionData
 Markup text position. More...
 

Enumerations

enum  EA3DLeaderAlignmentType {
  KA3DLeaderAlignment_Simple = 0,
  KA3DLeaderAlignment_Below = 1,
  KA3DLeaderAlignment_Underline = 2,
  KA3DLeaderAlignment_ExtToMax = 3,
  KA3DLeaderAlignment_OnBoxPoint = 4,
  KA3DLeaderAlignment_SimpleOnBoxPoint = 5
}
 Enumerations for Leader alignment type This enumeration defines the way the leader anchors on markup. More...
 
enum  EA3DMarkupFrameType {
  KA3DMarkupFrameNone = 0,
  KA3DMarkupFrameRectangle = 1,
  KA3DMarkupFrameSquare = 2,
  KA3DMarkupFrameCircle = 3,
  KA3DMarkupFrameScoredCircle = 4,
  KA3DMarkupFrameDiamond = 5,
  KA3DMarkupFrameTriangle = 6,
  KA3DMarkupFrameRightFlag = 7,
  KA3DMarkupFrameLeftFlag = 8,
  KA3DMarkupFrameBothFlag = 9,
  KA3DMarkupFrameOblong = 10,
  KA3DMarkupFrameEllipse = 11,
  KA3DMarkupFrameFixRectangle = 51,
  KA3DMarkupFrameFixSquare = 52,
  KA3DMarkupFrameFixCircle = 53,
  KA3DMarkupFrameFixScoredCircle = 54,
  KA3DMarkupFrameFixDiamond = 55,
  KA3DMarkupFrameFixTriangle = 56,
  KA3DMarkupFrameFixRightFlag = 57,
  KA3DMarkupFrameFixLeftFlag = 58,
  KA3DMarkupFrameFixBothFlag = 59,
  KA3DMarkupFrameFixOblong = 60,
  KA3DMarkupFrameFixEllipse = 61,
  KA3DMarkupFrameCustom = 255
}
 Markup frame identifiers for markup text, datum, .... More...
 

Functions

A3DStatus A3DMarkupCoordinateGet (const A3DMarkupCoordinate *pMarkupCoordinate, A3DMarkupCoordinateData *pData)
 Populates the A3DMarkupCoordinateData structure. More...
 
A3DStatus A3DMarkupTextGet (const A3DMarkupText *pMarkupText, A3DMarkupTextData *pData)
 Populates the A3DMarkupTextData structure. More...
 
A3DStatus A3DMDTextPositionGet (const A3DMDTextPosition *pTextPosition, A3DMDTextPositionData *pData)
 Populates the A3DMDTextPositionData structure. More...
 

Detailed Description

Version
4.0

Enumeration Type Documentation

◆ EA3DMarkupFrameType

Markup frame identifiers for markup text, datum, ....

Version
4.0
Enumerator
KA3DMarkupFrameNone 

No Frame.

KA3DMarkupFrameRectangle 

Rectangle Frame.

KA3DMarkupFrameSquare 

Square Frame.

KA3DMarkupFrameCircle 

Circle Frame.

KA3DMarkupFrameScoredCircle 

Scored Circle.

KA3DMarkupFrameDiamond 

Diamond Frame.

KA3DMarkupFrameTriangle 

Triangle Frame.

KA3DMarkupFrameRightFlag 

Right Flag Frame.

KA3DMarkupFrameLeftFlag 

Left Flag Frame.

KA3DMarkupFrameBothFlag 

Both Flag Frame.

KA3DMarkupFrameOblong 

Oblong Frame.

KA3DMarkupFrameEllipse 

Ellipse Frame.

KA3DMarkupFrameFixRectangle 

Fixed Rectangle Frame.

KA3DMarkupFrameFixSquare 

Fixed Square Frame.

KA3DMarkupFrameFixCircle 

Fixed Circle Frame.

KA3DMarkupFrameFixScoredCircle 

Fixed Scored Circle Frame.

KA3DMarkupFrameFixDiamond 

Fixed Diamond Frame.

KA3DMarkupFrameFixTriangle 

Fixed Triangle Frame.

KA3DMarkupFrameFixRightFlag 

Fixed Right Flag Frame.

KA3DMarkupFrameFixLeftFlag 

Fixed Left Flag Frame.

KA3DMarkupFrameFixBothFlag 

Fixed Both Flag Frame.

KA3DMarkupFrameFixOblong 

Fixed Oblong Frame.

KA3DMarkupFrameFixEllipse 

Fixed Ellipse Frame.

KA3DMarkupFrameCustom 

Custom Frame.

◆ EA3DLeaderAlignmentType

Enumerations for Leader alignment type This enumeration defines the way the leader anchors on markup.

Version
4.0
Enumerator
KA3DLeaderAlignment_Simple 

No alignment

KA3DLeaderAlignment_Below 

For a text note, the leader underlines the first text line.

KA3DLeaderAlignment_Underline 

The leader underlines all lines.

KA3DLeaderAlignment_ExtToMax 

The leader underlines all lines with the maximum line length.

KA3DLeaderAlignment_OnBoxPoint 

The leader anchors to the markup bounding box.

KA3DLeaderAlignment_SimpleOnBoxPoint 

The leader anchors to the markup bounding box, and in the middle of the line.

Function Documentation

◆ A3DMDTextPositionGet()

A3DStatus A3DMDTextPositionGet ( const A3DMDTextPosition pTextPosition,
A3DMDTextPositionData pData 
)

Populates the A3DMDTextPositionData structure.

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

◆ A3DMarkupCoordinateGet()

A3DStatus A3DMarkupCoordinateGet ( const A3DMarkupCoordinate pMarkupCoordinate,
A3DMarkupCoordinateData pData 
)

Populates the A3DMarkupCoordinateData structure.

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

◆ A3DMarkupTextGet()

A3DStatus A3DMarkupTextGet ( const A3DMarkupText pMarkupText,
A3DMarkupTextData pData 
)

Populates the A3DMarkupTextData structure.

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