Creates and accesses markup entities. More...

Modules

 Markup Types and Subtypes
 Enumerations for markup types and subtypes for use in the A3DMkpMarkupData structure.
 
 Markup definition
 
 Markup Leader
 
 Annotations Entity
 
 View
 
 Markup Linked Item
 
 RTF parsing
 
 Fonts
 

Data Structures

struct  A3DMkpMarkupData
 Markup structure. More...
 

Functions

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...
 

Detailed Description

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;
A3DInt32 iErr = A3DTessBaseGet((A3DTessBase*)pTess, &sBaseData);
if (iErr == A3D_SUCCESS)
{
iErr = A3DTessMarkupGet(pTess, &sData);
if (iErr == A3D_SUCCESS)
{
/* the tessellation is described in sBaseData plus sData */
}
A3DTessMarkupGet(NULL, &sData);
}
A3DTessBaseGet(NULL, &sData);
See also
Tessellation for Markups

Function Documentation

◆ A3DMkpMarkupGet()

A3DStatus A3DMkpMarkupGet ( const A3DMkpMarkup pMarkup,
A3DMkpMarkupData pData 
)

Populates the A3DMkpMarkupData structure.

Version
2.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

◆ A3DMkpMarkupCreate()

A3DStatus A3DMkpMarkupCreate ( const A3DMkpMarkupData pData,
A3DMkpMarkup **  ppMarkup 
)

Creates the A3DMkpMarkup from A3DMkpMarkupData structure.

Version
2.0
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_DATA_STRUCT_NULL
A3D_SUCCESS

◆ A3DMkpLinkForMarkupReferenceGet()

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.

Version
6.0
Parameters
[in]pMarkupThe A3DMkpMarkup entity to get linked item list from. If NULL, pppLinkedItems is freed instead of being allocated.
[out]puiLinkedItemsSizeThe number of A3DMiscMarkupLinkedItem in the resulting array.
[out]ppLinkedItemsThe resulting array.
Remarks
Internally there are several types of links such as reference, position, additional reference, owner or datum.This function only returns the reference links.
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

◆ A3DMkpLinkForAdditionalMarkupReferenceGet()

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.

Version
6.0
Parameters
[in]pMarkupThe A3DMkpMarkup entity to get linked item list from. If NULL, pppLinkedItems is freed instead of being allocated.
[out]puiLinkedItemsSizeThe number of A3DMiscMarkupLinkedItem in the resulting array.
[out]pppLinkedItemsThe resulting array.
Remarks
Internally there are several types of links such as reference, position, additional reference, owner or datum.This function only returns the additional reference links.
Version
9.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