Compute Section

Types

	A3DPlanarSectionData
	A3DMultiPlanarSectionData

Functions

`A3DStatus`	`A3DComputePlanarSectionOnRepresentationItem`
`A3DStatus`	`A3DComputePlanarSectionOnModelFile`
`A3DStatus`	`A3DCutWithMultiPlanarSectionOnRepresentationItems`
`A3DStatus`	`A3DCutWithMultiPlanarSectionOnModelFile`

Detailed Description

group a3d_ComputeSection

Compute section functions for model file.

Function Documentation

A3DStatus A3DComputePlanarSectionOnRepresentationItem(A3DRiBrepModel const *pRiBrepModel, A3DPlanarSectionData const *psSectionParametersData, A3DRiSet **ppRISectionResults)

Function to compute plane section on BrepModel.

Version: 7.0

Parameters:	pRiBrepModel – [in] B-rep models. psSectionParametersData – [in] Parameters of the planar section. ppRISectionResults – [out] Array of section curves. ppRISectionResults is automatically allocated by A3DComputePlanarSectionOnRepresentationItem. It has to be freed with a call to A3DComputePlanarSectionOnRepresentationItem(NULL, psSectionParametersData, ppRISectionCurvesis).
Return values:	A3D_SUCCESS – A3D_INITIALIZE_NOT_CALLED – A3D_INVALID_DATA_STRUCT_SIZE – A3D_INVALID_DATA_STRUCT_NULL – A3D_INVALID_ENTITY_NULL – A3D_INVALID_ENTITY_TYPE – A3D_INCOMPATIBLE_FUNCTION_WITH_KEEP_PARSED_ENTITY_MODE – A3D_ERROR –
Returns:	`A3D_SUCCESS` on success, or an error code on failure

A3DStatus A3DComputePlanarSectionOnModelFile(A3DAsmModelFile const *pModelFile, A3DPlanarSectionData const *psSectionParametersData, A3DUns32 *pNumberOfSections, A3DRiSet ***pppRISectionElements)

Function to compute plane section on ModelFile.

Version: 7.0

Parameters:	pModelFile – [in] Model file to section. psSectionParametersData – [in] Parameters of the planar section. pNumberOfSections – [out] Number of A3DRiSets. pppRISectionElements – [out] Array of A3DRiSets. ppRISectionElements is automatically allocated by A3DComputePlanarSectionOnModelFile. It has to be freed with a call to A3DComputePlanarSectionOnModelFile(NULL, psSectionParametersData, pNumberOfSections, ppRISectionElements).
Return values:	A3D_SUCCESS – A3D_INITIALIZE_NOT_CALLED – A3D_INVALID_DATA_STRUCT_SIZE – A3D_INVALID_DATA_STRUCT_NULL – A3D_INVALID_ENTITY_NULL – A3D_INVALID_ENTITY_TYPE – A3D_INCOMPATIBLE_FUNCTION_WITH_KEEP_PARSED_ENTITY_MODE – A3D_ERROR –
Returns:	`A3D_SUCCESS` on success, or an error code on failure

A3DStatus A3DCutWithMultiPlanarSectionOnRepresentationItems(A3DUns32 uiNbRepItems, A3DRiRepresentationItem const **apRepItems, A3DDouble **pOptPlacements, A3DMultiPlanarSectionData const *psSectionParametersData, A3DUns32 *pNumberOfRepItems, A3DRiRepresentationItem ***pppRIRepresentationItem, A3DRiRepresentationItem ***pppRIPlanarSections)

Function to compute the result of a section with several planes on a set of A3DRiRepresentationItem.

Call A3DCutWithMultiPlanarSectionOnRepresentationItems( 0, NULL, NULL, NULL, pNumberOfRepItems, pppRIRepresentationItem, pppRIPlanarSections) to release pppRIRepresentationItem and pppRIPlanarSections data

Version: 8.2

Parameters:	uiNbRepItems – [in] Number of A3DRiRepresentationItem. apRepItems – [in] set of A3DRiRepresentationItem. pOptPlacements – [in] Optional set of representation item placements (16 A3DDouble matrix). psSectionParametersData – [in] define the section to use. pNumberOfRepItems – [out] Number of A3DRiRepresentationItem in pppRIRepresentationItem and pppRIPlanarSections array. pppRIRepresentationItem – [out] A3DRiRepresentationItem corresponding to the boolean section results. Can be NULL if a A3DRiRepresentationItem if fully cutted by the section. pppRIPlanarSections – [out] A3DRiRepresentationItem corresponding to planar section for each A3DRiRepresentationItem
Return values:	A3D_SUCCESS – A3D_INVALID_DATA_STRUCT_NULL – A3D_INVALID_DATA_STRUCT_SIZE – A3D_INVALID_ENTITY_TYPE – A3D_INVALID_DATA – A3D_INCOMPATIBLE_FUNCTION_WITH_KEEP_PARSED_ENTITY_MODE – A3D_ERROR –
Returns:	`A3D_SUCCESS` on success, or an error code on failure

A3DStatus A3DCutWithMultiPlanarSectionOnModelFile(A3DAsmModelFile const *pModelFile, A3DMkpView const *pOptMrkRView, A3DMultiPlanarSectionData const *psSectionParametersData, A3DUns32 *pNumberOfRepItems, A3DRiRepresentationItem ***pppRIRepresentationItem, A3DRiRepresentationItem ***pppRIPlanarSections)

Function to compute the result of a section with several planes on a A3DAsmModelFile.

Call A3DCutWithMultiPlanarSectionOnModelFile( NULL, pOptMrkRView, psSectionParametersData, NULL, pNumberOfRepItems, pppRIRepresentationItem, pppRIPlanarSections) to release pppRIRepresentationItem and pppRIPlanarSections data

Version: 8.2

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.

Remark

If the model file doesn’t contain any representation item, the function will return #A3D_INVALID_DATA error

Parameters:	pModelFile – [in] Model file to section. pOptMrkRView – [in] optional A3DMkpView (filter and/or move entities). psSectionParametersData – [in] define the section to use (can be NULL if pOptMrkRView is a cutting view). pNumberOfRepItems – [out] Number of A3DRiRepresentationItem in pppRIRepresentationItem and pppRIPlanarSections array. pppRIRepresentationItem – [out] A3DRiRepresentationItem corresponding to the section results. Can be NULL if a A3DRiRepresentationItem if fully cutted by the section. pppRIPlanarSections – [out] A3DRiRepresentationItem corresponding to planar section for each A3DRiRepresentationItem
Return values:	A3D_SUCCESS – A3D_INVALID_DATA_STRUCT_NULL – A3D_INVALID_DATA_STRUCT_SIZE – A3D_INVALID_ENTITY_TYPE – A3D_INVALID_DATA – A3D_INCOMPATIBLE_FUNCTION_WITH_KEEP_PARSED_ENTITY_MODE – A3D_ERROR – A3D_TOOLS_INVALID_SECTION_PLANE –
Returns:	`A3D_SUCCESS` on success, or an error code on failure