Annotation Reference

Types

A3DMkpAnnotationReferenceData

Functions

A3DStatus

A3DMkpAnnotationReferenceGet

A3DStatus

A3DMkpAnnotationReferenceCreate

Detailed Description

group a3d_annotationreference

Logical grouping of other annotations

Entity type is kA3DTypeMkpAnnotationReference.

An annotation reference stores explicit combinations of markup data with modifiers that can then be used to define other annotations (feature control frame).

Function Documentation

A3DStatus A3DMkpAnnotationReferenceGet(const A3DMkpAnnotationReference *pAnnotation, A3DMkpAnnotationReferenceData *pData)

Populates the A3DMkpAnnotationReferenceData structure.

Version

2.0

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 –

Returns:

A3D_SUCCESS on success, or an error code on failure

A3DStatus A3DMkpAnnotationReferenceCreate(const A3DMkpAnnotationReferenceData *pData, A3DMkpAnnotationReference **ppAnnotation)

Creates an A3DMkpAnnotationReference from an A3DMkpAnnotationReferenceData structure.

Version

2.0

Return values:

  • A3D_INVALID_DATA_STRUCT_SIZE –

  • A3D_INVALID_DATA_STRUCT_NULL –

  • A3D_SUCCESS –

Returns:

A3D_SUCCESS on success, or an error code on failure