Entity Base

group a3d_rootbase

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

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.

A3DVoid setAttributes(A3DEntity* p)
{
    A3DMiscAttribute* pAttr[3];

    A3DMiscSingleAttributeData Single;
    A3D_INITIALIZE_DATA(Single);

    Single.m_eType = kA3DModellerAttributeTypeString;
    Single.m_pcTitle = "Title";
    Single.m_pcData = "Simple B-rep building demonstration";

    A3DMiscAttributeData sAttribs;
    A3D_INITIALIZE_DATA(sAttribs);

    sAttribs.m_pcTitle = Single.m_pcTitle;
    sAttribs.m_asSingleAttributesData = &Single;
    sAttribs.m_uiSize = 1;
    A3DInt32 iRet = A3DMiscAttributeCreate(&sAttribs, &pAttr[0]);

    Single.m_pcTitle = "Author";
    Single.m_pcData = "HOOPS Exchange";
    sAttribs.m_pcTitle = Single.m_pcTitle;
    iRet = A3DMiscAttributeCreate(&sAttribs, &pAttr[1]);

    Single.m_pcTitle = "Company";
    Single.m_pcData = "Tech Soft 3D";
    sAttribs.m_pcTitle = Single.m_pcTitle;
    iRet = A3DMiscAttributeCreate(&sAttribs, &pAttr[2]);

    A3DRootBaseData sRootData;
    A3D_INITIALIZE_DATA(sRootData);

    sRootData.m_pcName = "Trimmed surface";
    sRootData.m_ppAttributes = pAttr;
    sRootData.m_uiSize = 3;
    iRet = A3DRootBaseSet(p, &sRootData);
    
    // cleaning up the allocated attributes
    for(A3DUns32 i = 0; i < sRootData.m_uiSize; ++i)
    {
        A3DEntityDelete(sRootData.m_ppAttributes[i]);
    }
}

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.

../_images/PRC_RootAttributes.png

Sub-modules

Miscellaneous Attribute Entity

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

Data Structures

A3DRootBaseData

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

Functions

`A3DRootBaseGet()`	Populates an A3DRootBaseData structure with the data from a PRC entity.
`A3DRootBaseSet()`	Adds an A3DRootBaseData structure to an existing PRC entity.
`A3DRootBaseAttributeRemoveAll()`	Remove all attributes stored in a PRC entity.
`A3DRootBaseAttributeRemove()`	Remove attribute in the attribute array of PRC entity with a specific title.
`A3DRootBaseAttributeRemoveAt()`	Remove attribute of the current attribute array stored in a PRC entity, at a specific position.
`A3DRootBaseAttributeAppend()`	Append attributes to the current attribute array stored in a PRC entity.
`A3DRootBaseAttributeAdd()`	Add an attribute to the current attribute array stored in a PRC entity.