Data Structures

struct  A3DRiRepresentationItemData
 Representation Item Structure. More...
 

Functions

A3DStatus A3DRiReleaseTessellation (A3DRiRepresentationItem *pRepresentationItem)
 Function to release the tessellation stored on the representation item. More...
 
A3DStatus A3DRiRepresentationItemComputeTessellation (A3DRiRepresentationItem *pRi, const A3DRWParamsTessellationData *pTessellationParametersData)
 Calculates the tessellation of a previously created A3DRiRepresentationItem with an A3DRWParamsTessellationData parameters. More...
 
A3DStatus A3DRiRepresentationItemDeepCopy (const A3DRiRepresentationItem *pRi, A3DRiRepresentationItem **ppNewRi)
 Create a new representation item by making a deep copy. More...
 
A3DStatus A3DRiRepresentationItemEditCoordinateSystem (A3DRiCoordinateSystem *pNewCoordinateSystem, A3DRiRepresentationItem *pRepresentationItem)
 Function to edit the coordinate system of a representation item. More...
 
A3DStatus A3DRiRepresentationItemGet (const A3DRiRepresentationItem *pRi, A3DRiRepresentationItemData *pData)
 Populates the A3DRiRepresentationItemData structure. More...
 
A3DStatus A3DRiRepresentationItemSet (A3DRiRepresentationItem *pRi, const A3DRiRepresentationItemData *pData)
 Sets a previously created A3DRiRepresentationItem with an A3DRiRepresentationItemData structure. More...
 

Detailed Description

Function Documentation

◆ A3DRiRepresentationItemGet()

A3DStatus A3DRiRepresentationItemGet ( const A3DRiRepresentationItem pRi,
A3DRiRepresentationItemData pData 
)

Populates the A3DRiRepresentationItemData structure.

Version
2.0
Returns
A3D_SUCCESS in case of success or an error code
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

◆ A3DRiRepresentationItemSet()

A3DStatus A3DRiRepresentationItemSet ( A3DRiRepresentationItem pRi,
const A3DRiRepresentationItemData pData 
)

Sets a previously created A3DRiRepresentationItem with an A3DRiRepresentationItemData structure.

Version
2.0
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_DATA_STRUCT_NULL
A3D_SET_INCONSISTENT_EMPTY
A3D_SUCCESS
Note
The A3DRiRepresentationItem entity is an abstract class. You cannot directly create this entity. Instead, use the appropriate derived function (such as A3DRiSetCreate or A3DRiPointSetCreate) to create a specific representation item entity. Then use this function to specify values in that entity base class. For example, this function specifies a value for the A3DRiRepresentationItemData::m_pCoordinateSystem member.

◆ A3DRiRepresentationItemDeepCopy()

A3DStatus A3DRiRepresentationItemDeepCopy ( const A3DRiRepresentationItem pRi,
A3DRiRepresentationItem **  ppNewRi 
)

Create a new representation item by making a deep copy.

ri_deep_copy.jpg

Representation item data are copied, except coordinate system and surface are shared for optimization as for the rest of the model. There are some limitations:

  • ID is reset to 0, but topological item ids are kept.
  • Stored links are lost when a representation item is copied independently of the rest of the model. It's up to the user to create new ones. An entity reference sets to describe the link between a datum plane and a body plane face will be removed.
  • Drawing block is not implemented.
  • Feature data on TfSet are not copied.

Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_INVALID_ENTITY_NULL
A3D_INVALID_ENTITY_TYPE
A3D_ERROR
A3D_SUCCESS
Version
11.2

◆ A3DRiRepresentationItemComputeTessellation()

A3DStatus A3DRiRepresentationItemComputeTessellation ( A3DRiRepresentationItem pRi,
const A3DRWParamsTessellationData pTessellationParametersData 
)

Calculates the tessellation of a previously created A3DRiRepresentationItem with an A3DRWParamsTessellationData parameters.

Version
4.0
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_DATA_STRUCT_NULL
A3D_SET_INCONSISTENT_EMPTY
A3D_SUCCESS
Note
If the A3DRiRepresentationItem entity has already been tessellated, the previous tessellation will be replaced by the new one. This function works for brep models and curves only.

◆ A3DRiReleaseTessellation()

A3DStatus A3DRiReleaseTessellation ( A3DRiRepresentationItem pRepresentationItem)

Function to release the tessellation stored on the representation item.

Version
5.0
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_DATA_STRUCT_NULL
A3D_SUCCESS

◆ A3DRiRepresentationItemEditCoordinateSystem()

A3DStatus A3DRiRepresentationItemEditCoordinateSystem ( A3DRiCoordinateSystem pNewCoordinateSystem,
A3DRiRepresentationItem pRepresentationItem 
)

Function to edit the coordinate system of a representation item.

Version
9.2
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_DATA_STRUCT_NULL
A3D_SUCCESS