A3DSDKMarkup.h File Reference

Header file for the markup module. More...

Data Structures

struct  A3DFontData
 Font structure. More...
 
struct  A3DFontKeyData
 Font key structure. More...
 
struct  A3DMiscMarkupLinkedItemData
 Markup Linked Item structure. More...
 
struct  A3DMkpAnnotationItemData
 Annotation Item structure. More...
 
struct  A3DMkpAnnotationReferenceData
 Annotation Reference structure. More...
 
struct  A3DMkpAnnotationSetData
 Annotation Set structure. More...
 
struct  A3DMkpLeaderData
 Markup Leader structure. More...
 
struct  A3DMkpMarkupData
 Markup structure. More...
 
struct  A3DMkpRTFFieldData
 Structure used to parse RTF strings. More...
 
struct  A3DMkpViewData
 View structure. More...
 
struct  A3DMkpViewFlagsData
 The set of activated components in a View. More...
 

Typedefs

typedef void A3DMkpRTFField
 
typedef A3DMkpRTFFieldData A3DRTFFieldData
 

Functions

A3DStatus A3DGlobalFontKeyCreate (const A3DFontData *pFontData, A3DFontKeyData *pFontKeyData)
 Creates the A3DFontKeyData structure from the A3DFontData structure. More...
 
A3DStatus A3DGlobalFontKeyGet (const A3DFontKeyData *pFontKeyData, A3DFontData *pFontData)
 Retrieves font information (A3DFontData) from the A3DFontKeyData structure. This function is useful when reading markup tessellation. More...
 
A3DStatus A3DGlobalFontTextBoxAndScaleGet (const A3DFontKeyData *psFontKeyData, A3DUTF8Char *pcText, A3DDouble *pdLength, A3DDouble *pdHeight, A3DDouble *pdScale)
 Gets text bounding box and scale according to the font. More...
 
A3DStatus A3DGlobalFontTextBoxGet (const A3DFontKeyData *psFontKeyData, A3DUTF8Char *pcText, A3DDouble *pdLength, A3DDouble *pdHeight)
 Gets text bounding box according to the font. More...
 
A3DStatus A3DGlobalFontTextTessellationGet (const A3DFontKeyData *psFontKeyData, const A3DUTF8Char *pcOneChar, A3DRiSet **ppset, A3DDouble *pdCharWidth)
 Gets text tessellation as wireframe. More...
 
A3DStatus A3DMiscMarkupLinkedItemCreate (const A3DMiscMarkupLinkedItemData *pData, A3DMiscMarkupLinkedItem **ppLinkedItem)
 Creates an A3DMiscMarkupLinkedItem from an A3DMiscMarkupLinkedItemData structure. More...
 
A3DStatus A3DMiscMarkupLinkedItemGet (const A3DMiscMarkupLinkedItem *pLinkedItem, A3DMiscMarkupLinkedItemData *pData)
 Populates the A3DMiscMarkupLinkedItemData structure. More...
 
A3DStatus A3DMkpAnnotationItemCreate (const A3DMkpAnnotationItemData *pData, A3DMkpAnnotationItem **ppAnnotation)
 Creates an A3DMkpAnnotationItem from an A3DMkpAnnotationItemData structure. More...
 
A3DStatus A3DMkpAnnotationItemGet (const A3DMkpAnnotationItem *pAnnotation, A3DMkpAnnotationItemData *pData)
 Populates the A3DMkpAnnotationItemData structure. More...
 
A3DStatus A3DMkpAnnotationReferenceCreate (const A3DMkpAnnotationReferenceData *pData, A3DMkpAnnotationReference **ppAnnotation)
 Creates an A3DMkpAnnotationReference from an A3DMkpAnnotationReferenceData structure. More...
 
A3DStatus A3DMkpAnnotationReferenceGet (const A3DMkpAnnotationReference *pAnnotation, A3DMkpAnnotationReferenceData *pData)
 Populates the A3DMkpAnnotationReferenceData structure. More...
 
A3DStatus A3DMkpAnnotationSetCreate (const A3DMkpAnnotationSetData *pData, A3DMkpAnnotationSet **ppAnnotation)
 Creates an A3DMkpAnnotationSet from an A3DMkpAnnotationSetData structure. More...
 
A3DStatus A3DMkpAnnotationSetGet (const A3DMkpAnnotationSet *pAnnotation, A3DMkpAnnotationSetData *pData)
 Populates the A3DMkpAnnotationSetData structure. More...
 
A3DStatus A3DMkpLeaderCreate (const A3DMkpLeaderData *pData, A3DMkpLeader **ppLeader)
 Creates an A3DMkpLeader from an A3DMkpLeaderData structure. More...
 
A3DStatus A3DMkpLeaderGet (const A3DMkpLeader *pLeader, A3DMkpLeaderData *pData)
 Populates the A3DMkpLeaderData structure. More...
 
A3DStatus A3DMkpLinkForAdditionalMarkupReferenceGet (const A3DMkpMarkup *pMarkup, A3DUns32 *puiLinkedItemsSize, A3DMiscMarkupLinkedItem ***pppLinkedItems)
 Get links corresponding to the A3DMkpMarkup additional references such as element defining the toleranced line for line profile. This function allocates and returns an array of A3DMiscMarkupLinkedItem. To free the allocated array, the function must be called again with pMarkup as NULL. More...
 
A3DStatus A3DMkpLinkForMarkupReferenceGet (const A3DMkpMarkup *pMarkup, A3DUns32 *puiLinkedItemsSize, A3DMiscMarkupLinkedItem ***ppLinkedItems)
 Get links corresponding to the A3DMkpMarkup references This function allocates and returns an array of A3DMiscMarkupLinkedItem. To free the allocated array, the function must be called again with pMarkup as NULL. More...
 
A3DStatus A3DMkpMarkupCreate (const A3DMkpMarkupData *pData, A3DMkpMarkup **ppMarkup)
 Creates the A3DMkpMarkup from A3DMkpMarkupData structure. More...
 
A3DStatus A3DMkpMarkupGet (const A3DMkpMarkup *pMarkup, A3DMkpMarkupData *pData)
 Populates the A3DMkpMarkupData structure. More...
 
A3DStatus A3DMkpRTFDelete (A3DVoid *pRTFData)
 delete RTF data created by A3DMkpRTFInit More...
 
A3DStatus A3DMkpRTFFieldCreate (const A3DUTF8Char *pRTFString, A3DMkpRTFField **pRTFField)
 Initialize RTF data for parsing Previously A3DMkpRTFInit. More...
 
A3DStatus A3DMkpRTFFieldDelete (const A3DMkpRTFField *pRTFField)
 delete RTF data created by A3DMkpRTFInit Previously A3DMkpRTFDelete. More...
 
A3DStatus A3DMkpRTFFieldGet (const A3DMkpRTFField *pRTFField, A3DMkpRTFFieldData *pRTFFieldData)
 Get each independent field of a RTF data Previously A3DMkpRTFGetField. More...
 
A3DStatus A3DMkpRTFGetField (A3DVoid *pRTFData, A3DRTFFieldData *pRTFField)
 Get each independent field of a RTF data. More...
 
A3DStatus A3DMkpRTFInit (const A3DUTF8Char *pRTF, A3DVoid **pRTFData)
 Initialize RTF data for parsing. More...
 
A3DStatus A3DMkpViewCreate (const A3DMkpViewData *pData, A3DMkpView **ppView)
 Creates an A3DMkpView from an A3DMkpViewData structure. More...
 
A3DStatus A3DMkpViewGet (const A3DMkpView *pView, A3DMkpViewData *pData)
 Populates the A3DMkpViewData structure. More...
 
A3DStatus A3DMkpViewGetFlags (const A3DMkpView *pView, A3DMkpViewFlagsData *pFlags)
 Returns the set of components for a view using a A3DMkpViewFlagsData. More...
 

Detailed Description

Header file for the markup module.

Author
Tech Soft 3D
Version
23.0
Date
November 2022
Copyright (c) 2010 - 2022 by Tech Soft 3D, Inc. All rights reserved.

Typedef Documentation

◆ A3DMkpRTFField

typedef void A3DMkpRTFField

Entity type for RTF Field. Data is A3DMkpRTFFieldData

◆ A3DRTFFieldData

Deprecated:
This type is deprecated. Please use the A3DRTFFieldData to implement the same behaviour.