Modules

 Type of HLR curves result.
 

Data Structures

struct  A3DHLRCurveData
 A3DHLRCurveData structure. More...
 
struct  A3DHLROptionsData
 A3DHLROptionsData structure. More...
 
struct  A3DHLRRepresentationItemData
 A3DHLRCurveData structure. More...
 
struct  A3DHLRSectionFaceData
 A3DHLRSectionFaceData structure. More...
 

Functions

A3DStatus A3DComputeOrthoHLROnModelFile (A3DAsmModelFile const *pModelFile, A3DMkpView const *pOptMrkRView, A3DHLRViewPlaneData const *psHLRViewPlaneData, A3DUns32 *pNumberHLRData, A3DHLRRepresentationItemData **pppHLRData)
 Function to compute Hidden Line Removal on a A3DAsmModelFile. More...
 
A3DStatus A3DComputeOrthoHLROnModelFile2 (A3DAsmModelFile const *pModelFile, A3DMkpView const *pOptMrkRView, A3DHLRViewPlaneData const *psHLRViewPlaneData, A3DUns32 *pNumberHLRRepItem, A3DHLRRepresentationItem ***pppHLRRepItem)
 Function to compute Hidden Line Removal on a A3DAsmModelFile. More...
 
A3DStatus A3DComputeOrthoHLROnModelFile3 (A3DAsmModelFile const *pModelFile, A3DMkpView const *pOptMrkRView, A3DHLRViewPlaneData const *psHLRViewPlaneData, A3DHLROptionsData const *psHLROptionsData, A3DUns32 *pNumberHLRRepItem, A3DHLRRepresentationItem ***ppHLRRepItems)
 Function to compute Hidden Line Removal on a A3DAsmModelFile. More...
 
A3DStatus A3DComputeOrthoHLROnRepresentationItems (A3DUns32 uiNbRepItems, A3DRiRepresentationItem const **apRepItems, A3DDouble **pOptPlacements, A3DHLRViewPlaneData const *psHLRViewPlaneData, A3DUns32 *pNumberHLRData, A3DHLRRepresentationItemData **pppHLRData)
 Function to compute Hidden Line Removal on a set of A3DRiRepresentationItem. More...
 
A3DStatus A3DHLRRepresentationItemGet (A3DHLRRepresentationItem const *pHLRRepItem, A3DHLRRepresentationItemData *psRIData)
 Populates the A3DHLRRepresentationItemData structure. More...
 

Detailed Description

Version
8.1

Compute HLR functions for model file.

See also
A3DComputeOthoHLROnRepresentationItem
A3DComputeOrthoHLROnModelFile

Function Documentation

◆ A3DComputeOrthoHLROnRepresentationItems()

A3DStatus A3DComputeOrthoHLROnRepresentationItems ( A3DUns32  uiNbRepItems,
A3DRiRepresentationItem const **  apRepItems,
A3DDouble **  pOptPlacements,
A3DHLRViewPlaneData const *  psHLRViewPlaneData,
A3DUns32 pNumberHLRData,
A3DHLRRepresentationItemData **  pppHLRData 
)

Function to compute Hidden Line Removal on a set of A3DRiRepresentationItem.

Version
8.1

Call A3DComputeOrthoHLROnRepresentationItems( 0, NULL, NULL, NULL, pNumberHLRData, pppHLRData) to release pppHLRData structure ( A3DCrvPolyLine was not released)

Parameters
[in]uiNbRepItemsNumber of A3DRiRepresentationItem.
[in]apRepItemsset of A3DRiRepresentationItem.
[in]pOptPlacementsOptional set of representation item placements (16 A3DDouble matrix).
[in]psHLRViewPlaneDatadefine a plane as a camera with orthogonal projection.
[out]pNumberHLRDataNumber A3DHLRRepresentationItemData.
[out]pppHLRDataHLR curve result grouped by A3DRiRepresentationItem entity. pppHLRData is automatically allocated by A3DComputeOrthoHLROnRepresentationItems.
Returns
A3D_SUCCESS
A3D_INVALID_DATA_STRUCT_NULL
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_ENTITY_TYPE
A3D_INVALID_DATA
A3D_INVALID_ENTITY_NULL if apRepItems contains null pointers
A3D_ERROR
A3D_BREPDATA_INCONSISTENT_DATA if bUseExactComputation is set and if is missing A3DTopoBrepData
A3D_TOPO_GEOMETRY_MISSING if bUseExactComputation is set and if is missing UV curves
A3D_INCOMPATIBLE_FUNCTION_WITH_KEEP_PARSED_ENTITY_MODE

◆ A3DComputeOrthoHLROnModelFile()

A3DStatus A3DComputeOrthoHLROnModelFile ( A3DAsmModelFile const *  pModelFile,
A3DMkpView const *  pOptMrkRView,
A3DHLRViewPlaneData const *  psHLRViewPlaneData,
A3DUns32 pNumberHLRData,
A3DHLRRepresentationItemData **  pppHLRData 
)

Function to compute Hidden Line Removal on a A3DAsmModelFile.

Deprecated:
use A3DComputeOrthoHLROnModelFile2
Version
8.1

Call A3DComputeOrthoHLROnModelFile( NULL, pOptMrkRView, NULL, pNumberHLRData, pppHLRData) to release pppHLRData structure ( A3DCrvPolyLine was not released) Note: If the model file doesn't contain any representation items, function returns A3D_INVALID_DATA error;

Parameters
[in]pModelFileModel file to work on.
[in]pOptMrkRViewoptional A3DMkpView (cut, filter and/or move entities).
[in]psHLRViewPlaneDatadefine a plane as a camera with orthogonal projection.
[out]pNumberHLRDataNumber A3DHLRRepresentationItemData.
[out]pppHLRDataHLR curve result grouped by A3DRiRepresentationItem entity. pppHLRData is automatically allocated by A3DComputeOrthoHLROnModelFile.
Returns
A3D_SUCCESS
A3D_INVALID_DATA_STRUCT_NULL
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_ENTITY_TYPE
A3D_INVALID_DATA
A3D_ERROR
A3D_INCOMPATIBLE_FUNCTION_WITH_KEEP_PARSED_ENTITY_MODE

◆ A3DComputeOrthoHLROnModelFile2()

A3DStatus A3DComputeOrthoHLROnModelFile2 ( A3DAsmModelFile const *  pModelFile,
A3DMkpView const *  pOptMrkRView,
A3DHLRViewPlaneData const *  psHLRViewPlaneData,
A3DUns32 pNumberHLRRepItem,
A3DHLRRepresentationItem ***  pppHLRRepItem 
)

Function to compute Hidden Line Removal on a A3DAsmModelFile.

Version
9.0
Deprecated:
use A3DComputeOrthoHLROnModelFile3

Call A3DComputeOrthoHLROnModelFile2( NULL, NULL, NULL, pNumberHLRRepItem, pppHLRRepItem) to release pppHLRRepItem structure ( internal A3DCrvPolyLine was not released)

If pOptMrkRView is a cutting view, psSectionParametersData can be set to 0. In this case, the cutting planes within pOptMrkRView are used for the computation. Planes must to ordered and be set a profile, otherwise the function will return A3D_TOOLS_INVALID_SECTION_PLANE.

Remarks
If the model file doesn't contain any representation item, the function will return A3D_INVALID_DATA error
Parameters
[in]pModelFileModel file to work on.
[in]pOptMrkRViewoptional A3DMkpView (cut, filter and/or move entities).
[in]psHLRViewPlaneDatadefine a plane as a camera with orthogonal projection.
[out]pNumberHLRRepItemNumber A3DHLRRepresentationItem.
[out]pppHLRRepItemHLR curve result grouped by A3DRiRepresentationItem entity. pppHLRRepItem is automatically allocated by A3DComputeOrthoHLROnModelFile.
Returns
A3D_SUCCESS
A3D_INVALID_DATA_STRUCT_NULL
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_ENTITY_TYPE
A3D_INVALID_DATA
A3D_ERROR
A3D_TOOLS_INVALID_SECTION_PLANE
A3D_INCOMPATIBLE_FUNCTION_WITH_KEEP_PARSED_ENTITY_MODE

◆ A3DComputeOrthoHLROnModelFile3()

A3DStatus A3DComputeOrthoHLROnModelFile3 ( A3DAsmModelFile const *  pModelFile,
A3DMkpView const *  pOptMrkRView,
A3DHLRViewPlaneData const *  psHLRViewPlaneData,
A3DHLROptionsData const *  psHLROptionsData,
A3DUns32 pNumberHLRRepItem,
A3DHLRRepresentationItem ***  ppHLRRepItems 
)

Function to compute Hidden Line Removal on a A3DAsmModelFile.

Version
10.1

Call A3DComputeOrthoHLROnModelFile3( NULL, NULL, NULL, NULL, pNumberHLRRepItem, pppHLRRepItem) to release pppHLRRepItem structure ( internal A3DCrvPolyLine was not released)

If pOptMrkRView is a cutting view, psSectionParametersData can be set to 0. In this case, the cutting planes within pOptMrkRView are used for the computation. Planes must to ordered and be set a profile, otherwise the function will return A3D_TOOLS_INVALID_SECTION_PLANE.

Remarks
If the model file doesn't contain any representation item, the function will return A3D_INVALID_DATA error
Parameters
[in]pModelFileModel file to work on.
[in]pOptMrkRViewoptional A3DMkpView (cut, filter and/or move entities).
[in]psHLRViewPlaneDatadefine a plane as a camera with orthogonal projection.
[in]psHLROptionsDatadefine options used to compute HLR. if set to NULL, default A3DHLROptionsData value are used.
[out]pNumberHLRRepItemNumber A3DHLRRepresentationItem.
[out]pppHLRRepItemHLR curve result grouped by A3DRiRepresentationItem entity. pppHLRRepItem is automatically allocated by A3DComputeOrthoHLROnModelFile.
Returns
A3D_SUCCESS
A3D_INVALID_DATA_STRUCT_NULL
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_ENTITY_TYPE
A3D_INVALID_DATA
A3D_ERROR
A3D_TOOLS_INVALID_SECTION_PLANE
A3D_INCOMPATIBLE_FUNCTION_WITH_KEEP_PARSED_ENTITY_MODE

◆ A3DHLRRepresentationItemGet()

A3DStatus A3DHLRRepresentationItemGet ( A3DHLRRepresentationItem const *  pHLRRepItem,
A3DHLRRepresentationItemData psRIData 
)

Populates the A3DHLRRepresentationItemData structure.

Version
9.0

Call A3DHLRRepresentationItemGet( NULL, psRIData) to release psRIData structure ( A3DCrvPolyLine was not released)

Parameters
[in]pHLRRepItemThe input entity
[out]psRIDataThe structure to populate
Returns
A3D_SUCCESS
A3D_INVALID_DATA_STRUCT_NULL
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_ENTITY_TYPE
A3D_ERROR