A3DRootBaseWithGraphicsSet

A3DStatus A3DRootBaseWithGraphicsSet(A3DRootBaseWithGraphics *pRoot, const A3DRootBaseWithGraphicsData *pData)
A3DStatus A3DRootBaseWithGraphicsSet(A3DRootBaseWithGraphics* pRoot, const A3DRootBaseWithGraphicsData* pData)

Adds an A3DRootBaseWithGraphicsData structure to an existing A3DRootBaseWithGraphics entity.

11.1

Return Values

A3D_INVALID_DATA_STRUCT_SIZE:

A3D_INVALID_DATA_STRUCT_NULL:

A3D_SUCCESS:

The A3DRootBaseWithGraphics entity type is an abstract class and cannot be directly created; however, any graphic entity created with a function of the form A3DGraphics_entity_nameCreate results in the creation of a PRC entity of type A3DRootBaseWithGraphics and of type A3DEntity_name. That is, a function of the form A3DGraphics_entity_nameCreate adds specific data to the base class, for example A3DRootBaseWithGraphicsData::m_pGraphics.

When A3DRootBaseWithGraphicsSet is used to set a new A3DGraphics, its data is copied in the A3DRootBaseWithGraphics but the pointer is not kept nor freed later when the A3DRootBaseWithGraphics is deleted. It must be deleted using A3DEntityDelete()

   A3DGraphicsData sGraphicsData = A3D_MAKE_DATA(A3DGraphicsData);
   // fill in sGraphicsData

   A3DGraphics* pGraphics = A3D_NULL_HANDLE;
   A3DStatus    eStatus   = A3DGraphicsCreate(&sGraphicsData, &graphics);

   A3DRootBaseWithGraphicsData sRootBaseWithGraphicsData = A3D_MAKE_DATA(A3DRootBaseWithGraphicsData);
   sRootBaseWithGraphicsData.m_pGraphics = pGraphics;

   // copy pGraphics'content to pEntity
   eStatus = A3DRootBaseWithGraphicsSet(pEntity, &sRootBaseWithGraphicsData);

   // free pGraphics
   eStatus = A3DEntityDelete(pGraphics);

Never call :c:func:`~A3DEntityDelete` on an :c:type:`~A3DGraphics` obtained with :c:func:`~A3DRootBaseWithGraphicsGet`\ .

Returns

A3D_SUCCESS on success, or an error code on failure