Shape Processing module. Allows to define and apply general Shape Processing as a customizable sequence of operators. More...

#include <XSAlgo_ShapeProcessor.hxx>

Public Types
using	ParameterMap = NCollection_DataMap<TCollection_AsciiString, TCollection_AsciiString>

using	ProcessingData = std::pair<ParameterMap, ShapeProcess::OperationsFlags>

using	ProcessingFlags = std::pair<ShapeProcess::OperationsFlags, bool>

Public Member Functions
	XSAlgo_ShapeProcessor (const ParameterMap &theParameters, const DE_ShapeFixParameters &theShapeFixParameters={})
	Constructor.

	XSAlgo_ShapeProcessor (const DE_ShapeFixParameters &theParameters)
	Constructor.

TopoDS_Shape	ProcessShape (const TopoDS_Shape &theShape, const ShapeProcess::OperationsFlags &theOperations, const Message_ProgressRange &theProgress)
	Process the shape by applying the specified operations.

Handle< ShapeProcess_ShapeContext >	GetContext ()
	Get the context of the last processing. Only valid after the ProcessShape() method was called.

void	MergeTransferInfo (const Handle< Transfer_TransientProcess > &theTransientProcess, const Standard_Integer theFirstTPItemIndex) const
	Merge the results of the shape processing with the transfer process.

void	MergeTransferInfo (const Handle< Transfer_FinderProcess > &theFinderProcess) const
	Merge the results of the shape processing with the finder process.

Static Public Member Functions
static Standard_Boolean	CheckPCurve (const TopoDS_Edge &theEdge, const TopoDS_Face &theFace, const Standard_Real thePrecision, const Standard_Boolean theIsSeam)
	Check quality of pcurve of the edge on the given face, and correct it if necessary.

static ProcessingData	ReadProcessingData (const TCollection_AsciiString &theFileResourceName, const TCollection_AsciiString &theScopeResourceName)
	Reads the parameter map from and operation flags from the file specified in static interface.

static void	FillParameterMap (const DE_ShapeFixParameters &theParameters, const bool theIsReplace, ParameterMap &theMap)
	Fill the parameter map with the values from the specified parameters.

static void	SetShapeFixParameters (const DE_ShapeFixParameters &theParameters, const ParameterMap &theAdditionalParameters, ParameterMap &theTargetParameterMap)
	Sets parameters for shape processing. Parameters from `theParameters` are copied to the output map. Parameters from `theAdditionalParameters` are copied to the output map if they are not present in `theParameters`.

static void	SetParameter (const char *theKey, const DE_ShapeFixParameters::FixMode theValue, const bool theIsReplace, XSAlgo_ShapeProcessor::ParameterMap &theMap)
	Set the parameter in the map.

static void	SetParameter (const char *theKey, const double theValue, const bool theIsReplace, ParameterMap &theMap)
	Set the parameter in the map.

static void	SetParameter (const char *theKey, const TCollection_AsciiString &theValue, const bool theIsReplace, ParameterMap &theMap)
	Set the parameter in the map.

static void	PrepareForTransfer ()
	The function is designed to set the length unit for the application before performing a transfer operation. It ensures that the length unit is correctly configured based on the value associated with the key "xstep.cascade.unit".

static void	MergeShapeTransferInfo (const Handle< Transfer_TransientProcess > &theFinderProcess, const TopTools_DataMapOfShapeShape &theModifiedShapesMap, const Standard_Integer theFirstTPItemIndex, Handle< ShapeExtend_MsgRegistrator > theMessages)
	Merge the results of the shape processing with the finder process.

static void	MergeShapeTransferInfo (const Handle< Transfer_FinderProcess > &theTransientProcess, const TopTools_DataMapOfShapeShape &theModifiedShapesMap, Handle< ShapeExtend_MsgRegistrator > theMessages)
	Merge the results of the shape processing with the transfer process.

Detailed Description

Shape Processing module. Allows to define and apply general Shape Processing as a customizable sequence of operators.

Member Typedef Documentation

◆ ParameterMap

using XSAlgo_ShapeProcessor::ParameterMap = NCollection_DataMap<TCollection_AsciiString, TCollection_AsciiString>

◆ ProcessingData

using XSAlgo_ShapeProcessor::ProcessingData = std::pair<ParameterMap, ShapeProcess::OperationsFlags>

◆ ProcessingFlags

using XSAlgo_ShapeProcessor::ProcessingFlags = std::pair<ShapeProcess::OperationsFlags, bool>

Constructor & Destructor Documentation

◆ XSAlgo_ShapeProcessor() [1/2]

XSAlgo_ShapeProcessor::XSAlgo_ShapeProcessor	(	const ParameterMap &	theParameters,
		const DE_ShapeFixParameters &	theShapeFixParameters = {} )

Constructor.

Parameters

theParameters	Pre-filled parameter map to be used in the processing.
theShapeFixParameters	Shape healing parameters to be used in the processing. If `theParameters` has some shape healing values, they will override the corresponding values from `theShapeFixParameters`.

◆ XSAlgo_ShapeProcessor() [2/2]

XSAlgo_ShapeProcessor::XSAlgo_ShapeProcessor ( const DE_ShapeFixParameters & theParameters )

Constructor.

Parameters

theParameters Parameters to be used in the processing.

Member Function Documentation

◆ CheckPCurve()

static Standard_Boolean XSAlgo_ShapeProcessor::CheckPCurve	(	const TopoDS_Edge &	theEdge,
		const TopoDS_Face &	theFace,
		const Standard_Real	thePrecision,
		const Standard_Boolean	theIsSeam )

static

Check quality of pcurve of the edge on the given face, and correct it if necessary.

Parameters

theEdge	Edge to check.
theFace	Face on which the edge is located.
thePrecision	Precision to use for checking.
theIsSeam	Flag indicating whether the edge is a seam edge.

Returns: True if the pcurve was corrected, false if it was dropped.

◆ FillParameterMap()

static void XSAlgo_ShapeProcessor::FillParameterMap	(	const DE_ShapeFixParameters &	theParameters,
		const bool	theIsReplace,
		ParameterMap &	theMap )

static

Fill the parameter map with the values from the specified parameters.

Parameters

theParameters	Parameters to be used in the processing.
theIsForce	Flag indicating whether parameter should be replaced if it already exists in the map.
theMap	Map to fill.

◆ GetContext()

Handle< ShapeProcess_ShapeContext > XSAlgo_ShapeProcessor::GetContext ( )

inline

Get the context of the last processing. Only valid after the ProcessShape() method was called.

Returns: Shape context.

◆ MergeShapeTransferInfo() [1/2]

static void XSAlgo_ShapeProcessor::MergeShapeTransferInfo	(	const Handle< Transfer_FinderProcess > &	theTransientProcess,
		const TopTools_DataMapOfShapeShape &	theModifiedShapesMap,
		Handle< ShapeExtend_MsgRegistrator >	theMessages )

static

Merge the results of the shape processing with the transfer process.

Parameters

theTransientProcess	Transfer process to merge with.
theModifiedShapesMap	Map of modified shapes.
theFirstTPItemIndex	Index of the first item in the transfer process to merge with.
theMessages	Messages to add.

◆ MergeShapeTransferInfo() [2/2]

static void XSAlgo_ShapeProcessor::MergeShapeTransferInfo	(	const Handle< Transfer_TransientProcess > &	theFinderProcess,
		const TopTools_DataMapOfShapeShape &	theModifiedShapesMap,
		const Standard_Integer	theFirstTPItemIndex,
		Handle< ShapeExtend_MsgRegistrator >	theMessages )

static

Merge the results of the shape processing with the finder process.

Parameters

theTransientProcess	Transfer process to merge with.
theModifiedShapesMap	Map of modified shapes.
theFirstTPItemIndex	Index of the first item in the transfer process to merge with.
theMessages	Messages to add.

◆ MergeTransferInfo() [1/2]

void XSAlgo_ShapeProcessor::MergeTransferInfo ( const Handle< Transfer_FinderProcess > & theFinderProcess ) const

Merge the results of the shape processing with the finder process.

Parameters

theFinderProcess Finder process to merge with.

◆ MergeTransferInfo() [2/2]

void XSAlgo_ShapeProcessor::MergeTransferInfo	(	const Handle< Transfer_TransientProcess > &	theTransientProcess,
		const Standard_Integer	theFirstTPItemIndex ) const

Merge the results of the shape processing with the transfer process.

Parameters

theTransientProcess	Transfer process to merge with.
theFirstTPItemIndex	Index of the first item in the transfer process to merge with.

◆ PrepareForTransfer()

static void XSAlgo_ShapeProcessor::PrepareForTransfer ( )

static

The function is designed to set the length unit for the application before performing a transfer operation. It ensures that the length unit is correctly configured based on the value associated with the key "xstep.cascade.unit".

◆ ProcessShape()

TopoDS_Shape XSAlgo_ShapeProcessor::ProcessShape	(	const TopoDS_Shape &	theShape,
		const ShapeProcess::OperationsFlags &	theOperations,
		const Message_ProgressRange &	theProgress )

Process the shape by applying the specified operations.

Parameters

theShape	Shape to process.
theOperations	Operations to be performed.
theProgress	Progress indicator.

Returns: Processed shape. May be the same as the input shape if no modifications were made.

◆ ReadProcessingData()

static ProcessingData XSAlgo_ShapeProcessor::ReadProcessingData	(	const TCollection_AsciiString &	theFileResourceName,
		const TCollection_AsciiString &	theScopeResourceName )

static

Reads the parameter map from and operation flags from the file specified in static interface.

Parameters

theFileResourceName	Name of the parameter in interface static that contains the name of the file. For example, parameter "read.iges.resource.name" may contain string "IGES".
theScopeResourceName	Name of the parameter in interface static that contains the name of the scope. For example, parameter "read.iges.sequence" may contain string "FromIGES".

Returns: Read parameter map.

◆ SetParameter() [1/3]

static void XSAlgo_ShapeProcessor::SetParameter	(	const char *	theKey,
		const DE_ShapeFixParameters::FixMode	theValue,
		const bool	theIsReplace,
		XSAlgo_ShapeProcessor::ParameterMap &	theMap )

static

Set the parameter in the map.

Parameters

theKey	Key of the parameter.
theValue	Value of the parameter.
theIsReplace	Flag indicating whether parameter should be replaced if it already exists in the map.
theMap	Map to set the parameter in.

◆ SetParameter() [2/3]

static void XSAlgo_ShapeProcessor::SetParameter	(	const char *	theKey,
		const double	theValue,
		const bool	theIsReplace,
		ParameterMap &	theMap )

static

Set the parameter in the map.

Parameters

theKey	Key of the parameter.
theValue	Value of the parameter.
theIsReplace	Flag indicating whether parameter should be replaced if it already exists in the map.
theMap	Map to set the parameter in.

◆ SetParameter() [3/3]

static void XSAlgo_ShapeProcessor::SetParameter	(	const char *	theKey,
		const TCollection_AsciiString &	theValue,
		const bool	theIsReplace,
		ParameterMap &	theMap )

static

Set the parameter in the map.

Parameters

theKey	Key of the parameter.
theValue	Value of the parameter.
theIsReplace	Flag indicating whether parameter should be replaced if it already exists in the map.
theMap	Map to set the parameter in.

◆ SetShapeFixParameters()

static void XSAlgo_ShapeProcessor::SetShapeFixParameters	(	const DE_ShapeFixParameters &	theParameters,
		const ParameterMap &	theAdditionalParameters,
		ParameterMap &	theTargetParameterMap )

static

Sets parameters for shape processing. Parameters from theParameters are copied to the output map. Parameters from theAdditionalParameters are copied to the output map if they are not present in theParameters.

Parameters

theParameters	the parameters for shape processing.
theAdditionalParameters	the additional parameters for shape processing.
theTargetParameterMap	Map to set the parameters in.

The documentation for this class was generated from the following file:

XSAlgo_ShapeProcessor.hxx

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ParameterMap

◆ ProcessingData

◆ ProcessingFlags

Constructor & Destructor Documentation

◆ XSAlgo_ShapeProcessor() [1/2]

◆ XSAlgo_ShapeProcessor() [2/2]

Member Function Documentation

◆ CheckPCurve()

◆ FillParameterMap()

◆ GetContext()

◆ MergeShapeTransferInfo() [1/2]

◆ MergeShapeTransferInfo() [2/2]

◆ MergeTransferInfo() [1/2]

◆ MergeTransferInfo() [2/2]

◆ PrepareForTransfer()

◆ ProcessShape()

◆ ReadProcessingData()

◆ SetParameter() [1/3]

◆ SetParameter() [2/3]

◆ SetParameter() [3/3]

◆ SetShapeFixParameters()