Set Representation Item

Types

A3DRiSetData

Functions

A3DStatus

A3DRiSetGet

A3DStatus

A3DRiSetCreate

A3DStatus

A3DRiSetEdit

Detailed Description

group a3d_riset

This entity is a logical grouping of other representation items. No matrix for placement is attached to components, and an A3DRiSet entity can contain multiple child A3DRiSet sets.

Sample code

A3DRiSet pSet;
/* Should call something here in order to get a valid A3DRiSet */
A3DInt32 iErr = A3D_SUCCESS;
A3DRiSetData sData;
A3D_INITIALIZE_DATA(sData);
iErr = A3DRiSetGet(pSet, &sData);
if (iErr == A3D_SUCCESS)
{
    for(A3DUns32 ui=0; ui<sData.m_uiRepItemsSize;ui++)
    {
        /* Insert here your own code to parse through members of Set: sData.m_ppRepItems[ui] */
    }
    A3DRiSetGet( NULL,&sData );
}

Warning

A representation item cannot belong to more than one set.

Function Documentation

A3DStatus A3DRiSetGet(const A3DRiSet *pSet, A3DRiSetData *pData)

Populates the A3DRiSetData 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 in case of success or an error code

A3DStatus A3DRiSetCreate(const A3DRiSetData *pData, A3DRiSet **ppSet)

Creates an A3DRiSet from A3DRiSetData structure.

Version

2.0

Return values:

  • A3D_INVALID_DATA_STRUCT_SIZE –

  • A3D_INVALID_DATA_STRUCT_NULL –

  • A3D_SET_INCONSISTENT_EMPTY –

  • A3D_SUCCESS –

Returns:

A3D_SUCCESS in case of success or an error code

A3DStatus A3DRiSetEdit(const A3DRiSetData *pData, A3DRiSet *pSet)

Replaces the old data of an A3DRiSet with the new A3DRiSetData structure.

Version

10.0

Return values:

  • A3D_INVALID_DATA_STRUCT_SIZE –

  • A3D_INVALID_DATA_STRUCT_NULL –

  • A3D_SET_INCONSISTENT_EMPTY –

  • A3D_INVALID_ENTITY_NULL –

  • A3D_SUCCESS –

Returns:

A3D_SUCCESS in case of success or an error code