Overview

Programming Guide

API Reference

Markups based on simple text

Data Structures

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

Functions

A3DStatus A3DMDTextPositionGet (const A3DMDTextPosition *pTextPosition, A3DMDTextPositionData *pData)
 Populates the A3DMDTextPositionData structure. More...
 
A3DStatus A3DMarkupCoordinateGet (const A3DMarkupCoordinate *pMarkupCoordinate, A3DMarkupCoordinateData *pData)
 Populates the A3DMarkupCoordinateData structure. More...
 
A3DStatus A3DMarkupTextGet (const A3DMarkupText *pMarkupText, A3DMarkupTextData *pData)
 Populates the A3DMarkupTextData structure. 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...
 
enum  EA3DLeaderAlignementType { ,
  KA3DLeaderAlignement_Bellow = 1, KA3DLeaderAlignement_Underline = 2, KA3DLeaderAlignement_ExtToMax = 3, KA3DLeaderAlignement_OnBoxPoint = 4,
  KA3DLeaderAlignement_SimpleOnBoxPoint = 5
}
 Enumerations for Leader alignment type This enumeration defines the way the leader anchors on markup. More...
 

Detailed Description

Version
4.0

Enumeration Type Documentation

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.

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

Version
4.0
Enumerator
KA3DLeaderAlignement_Bellow 

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

KA3DLeaderAlignement_Underline 

The leader underline all lines.

KA3DLeaderAlignement_ExtToMax 

The leader underline all lines with the maximum line length.

KA3DLeaderAlignement_OnBoxPoint 

The leader anchors to the markup bounding box.

KA3DLeaderAlignement_SimpleOnBoxPoint 

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

Function Documentation