PointSet Representation Item

Types

A3DRiPointSetData

Functions

A3DStatus

A3DRiPointSetGet

A3DStatus

A3DRiPointSetCreate

A3DStatus

A3DRiPointSetEdit

Detailed Description

group a3d_ripointset

An A3DRiPointSet is a set of 3D points.

When the A3DRiPointSetGet function populates an A3DRiPointSetData structure, it allocates arrays of coordinates. When you no longer need the A3DRiPointSetData structure, invoke the A3DRiPointSetGet function with the first argument set to NULL to free its allocated memory.

Sample code

A3DInt32 iErr = A3D_SUCCESS;
A3DRiPointSet pA3DRiPointSet = NULL;

/* Should call something here in order to get a valid A3DRiPointSet */

A3DRiPointSetData sData;
A3D_INITIALIZE_DATA(sData);
iErr = A3DRiPointSetGet( pA3DRiPointSet , &sData );
if ( iErr == A3D_SUCCESS )
{
    for (A3DUns32 ui=0;ui<sData.m_uiSize;ui++)
    {
        /* Insert here your own code to use PointSet data: sData.m_pdX[ui], sData.m_pdY[ui], sData.m_pdZ[ui] */
    }
    iErr = A3DRiPointSetGet( NULL, &sData );
}

Function Documentation

A3DStatus A3DRiPointSetGet(const A3DRiPointSet *pPointSet, A3DRiPointSetData *pData)

Populates the A3DRiPointSetData 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 A3DRiPointSetCreate(const A3DRiPointSetData *pData, A3DRiPointSet **ppPointSet)

Creates an A3DRiPointSet from an A3DRiPointSetData structure.

Version

2.0

Return values

  • A3D_INVALID_DATA_STRUCT_SIZE –

  • A3D_INVALID_DATA_STRUCT_NULL –

  • A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DRiPointSetEdit(const A3DRiPointSetData *pData, A3DRiPointSet *pPointSet)

Replaces the old data of an A3DRiPointSet with the new A3DRiPointSetData structure.

Version

10.0

Return values

  • A3D_INVALID_DATA_STRUCT_SIZE –

  • A3D_INVALID_DATA_STRUCT_NULL –

  • A3D_INVALID_ENTITY_NULL –

  • A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code