Markup Module

Parent module: Entity Access and Creation

group a3d_markup_module

Creates and accesses markup entities.

Entity type is kA3DTypeMkpMarkup.

There may be a tessellation in the markup and in each leader. The following sample code shows how to retrieve the tessellation.

Sample code
/* code to get the tessellation of a markup or a leader */
/* pTess is a A3DTessMarkup* */
A3DTessBaseData sBaseData;
A3D_INITIALIZE_DATA(sBaseData);
A3DInt32 iErr = A3DTessBaseGet((A3DTessBase*)pTess, &sBaseData);
if (iErr == A3D_SUCCESS)
{
    A3DTessMarkupData sData;
    A3D_INITIALIZE_DATA(sData);
    iErr = A3DTessMarkupGet(pTess, &sData);
    if (iErr == A3D_SUCCESS)
    {
        /* the tessellation is described in sBaseData plus sData */
    }
    A3DTessMarkupGet(NULL, &sData);
}
A3DTessBaseGet(NULL, &sData);

Sub-modules

Markup Types and Subtypes

Enumerations for markup types and subtypes for use in the A3DMkpMarkupData structure.

Markup definition

Markup definition

Markup Leader

Entity type is kA3DTypeMkpLeader .

Annotations Entity

An annotation entity can be one of the following types:

View

Entity type is kA3DTypeMkpView .

Markup Linked Item

Entity type is kA3DTypeMiscMarkupLinkedItem .

RTF parsing

Set of functions used to parse RTF strings.

Fonts

When creating a markup tessellation that uses specific fonts, store fonts with font keys ( A3DFontKeyData ) by invoking the A3DGlobalFontKeyCreate function.

Data Structures

A3DMkpMarkupData

Markup structure.

Functions

A3DMkpMarkupGet()

Populates the A3DMkpMarkupData structure.

A3DMkpMarkupCreate()

Creates the A3DMkpMarkup from A3DMkpMarkupData structure.

A3DMkpLinkForMarkupReferenceGet()

Get links corresponding to the A3DMkpMarkup references This function allocates and returns an array of A3DMiscMarkupLinkedItem .

A3DMkpLinkForAdditionalMarkupReferenceGet()

Get links corresponding to the A3DMkpMarkup additional references such as element defining the toleranced line for line profile.

A3DMkpMarkupSet()

Set the A3DMkpMarkup from A3DMkpMarkupData structure.

A3DMkpDatumTargetSetDatumOwner()

Create a Link between a DatumTarget and it’s Datum owner.

A3DMkpAddMarkupLinkedItemTag()

set a A3DMiscMarkupLinkedItem as Reference type if bMainReference is FALSE, the reference is an additional reference (ie : Projected Zone for FCF)