Data Structures

struct  A3DRiPlaneData
 RiPlane structure. More...
 

Functions

A3DStatus A3DRiPlaneCreate (const A3DRiPlaneData *pData, A3DRiPlane **ppRIPlane)
 Creates an A3DSurfPlane from an A3DRiPlaneData structure. More...
 
A3DStatus A3DRiPlaneEdit (const A3DRiPlaneData *pData, A3DRiPlane *pRIPlane)
 Modifies an A3DSurfPlane from an A3DRiPlaneData structure. More...
 
A3DStatus A3DRiPlaneGet (const A3DRiPlane *pRiPlane, A3DRiPlaneData *pData)
 Populates the A3DRiPlaneData structure. More...
 
A3DStatus A3DRiPlaneSupportGet (const A3DRiPlane *pRiPlane, A3DMiscMarkupLinkedItem **ppLinkedItem)
 Get the geometrical element used to build the A3DRiPlane. More...
 

Detailed Description

An A3DRiPlane is a representation item that contains a A3DTopoBrepData made of one single planar face.

Function Documentation

◆ A3DRiPlaneGet()

A3DStatus A3DRiPlaneGet ( const A3DRiPlane pRiPlane,
A3DRiPlaneData pData 
)

Populates the A3DRiPlaneData 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

◆ A3DRiPlaneCreate()

A3DStatus A3DRiPlaneCreate ( const A3DRiPlaneData pData,
A3DRiPlane **  ppRIPlane 
)

Creates an A3DSurfPlane from an A3DRiPlaneData 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_SUCCESS

◆ A3DRiPlaneEdit()

A3DStatus A3DRiPlaneEdit ( const A3DRiPlaneData pData,
A3DRiPlane pRIPlane 
)

Modifies an A3DSurfPlane from an A3DRiPlaneData structure.

Version
10.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_INVALID_ENTITY_NULL
A3D_SUCCESS

◆ A3DRiPlaneSupportGet()

A3DStatus A3DRiPlaneSupportGet ( const A3DRiPlane pRiPlane,
A3DMiscMarkupLinkedItem **  ppLinkedItem 
)

Get the geometrical element used to build the A3DRiPlane.

Version
6.0
Parameters
[in]pRiPlaneThe A3DRiPlane to query
[out]ppLinkedItemThe entity used to build pRiPlane
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