Overview

Programming Guide

API Reference

Creates and accesses a hierarchy of descriptive names and modeller data that can be applied to any PRC entity. More...

Modules

 Miscellaneous Attribute Entity
 Creates and accesses descriptive names and modeller data associated with PRC entities.
 

Data Structures

struct  A3DRootBaseData
 A structure representing a hierarchy of descriptive names and modeler data that applies to any PRC entity. More...
 

Functions

A3DStatus A3DRootBaseGet (const A3DRootBase *pRootBase, A3DRootBaseData *pData)
 Populates an A3DRootBaseData structure with the data from a PRC entity. More...
 
A3DStatus A3DRootBaseSet (A3DRootBase *pRootBase, const A3DRootBaseData *pData)
 Adds an A3DRootBaseData structure to an existing PRC entity. More...
 

Detailed Description

Creates and accesses a hierarchy of descriptive names and modeller data that can be applied to any PRC entity.

Entity type is kA3DTypeRootBase

This module lets you create a hierarchy of descriptive names and modeller data (called root-level attributes) that can be applied to any PRC entity. These attributes are packaged as an A3DRootBase entity that is referenced from the PRC entity they describe.

The following sample code shows how to create root-level attributes for any PRC entity. In this case, the attributes include modeller data. For restrictions on specifying modeller data, see A3DMiscAttributeData.

The following illustration shows the result of the sample code.

The sample code creates an A3DRootBase entity that houses three A3DMiscAttribute entities, each of which reference an A3DMiscSingleAttributeData structure. Each A3DMiscSingleAttributeData structure provides modeller data of type kA3DModellerAttributeTypeString.

PRC_RootAttributes.png
See also
Root Type Declarations

Function Documentation

A3DStatus A3DRootBaseGet ( const A3DRootBase pRootBase,
A3DRootBaseData pData 
)
A3DStatus A3DRootBaseSet ( A3DRootBase pRootBase,
const A3DRootBaseData pData 
)

Adds an A3DRootBaseData structure to an existing PRC entity.

Version
2.0
Returns
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_DATA_STRUCT_NULL
A3D_SUCCESS
Note
A3DRootBase is an abstract class and cannot be directly created; however, any entity created with a function of the form A3DEntity_nameCreate results in the creation of a PRC entity of type A3DRootBase and of type A3DEntity_name.