Plane Representation Item

Detailed Description

group a3d_riplane

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

Function Documentation

A3DStatus A3DRiPlaneGet(const A3DRiPlane *pRiPlane, A3DRiPlaneData *pData)

Populates the A3DRiPlaneData 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 on success, or an error code on failure
A3DStatus A3DRiPlaneCreate(const A3DRiPlaneData *pData, A3DRiPlane **ppRIPlane)

Creates an A3DSurfPlane from an A3DRiPlaneData structure.

Version
2.0

Return values:
  • A3D_INVALID_DATA_STRUCT_SIZE –
  • A3D_INVALID_DATA_STRUCT_NULL –
  • A3D_SUCCESS –
Returns:

A3D_SUCCESS on success, or an error code on failure
A3DStatus A3DRiPlaneEdit(const A3DRiPlaneData *pData, A3DRiPlane *pRIPlane)

Modifies an A3DSurfPlane from an A3DRiPlaneData 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 on success, or an error code on failure
A3DStatus A3DRiPlaneSupportGet(const A3DRiPlane *pRiPlane, A3DMiscMarkupLinkedItem **ppLinkedItem)

Get the geometrical element used to build the A3DRiPlane.

Version
6.0

Parameters:
  • pRiPlane – [in] The A3DRiPlane to query
  • ppLinkedItem – [out] The entity used to build pRiPlane
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 on success, or an error code on failure