Version: 6.5.0
Home
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions
GEOM::GEOM_IHealingOperations Interface Reference

Interface for shape healing operations. More...

import "GEOM_Gen.idl";

Public Member Functions

GEOM_Object ProcessShape (in GEOM_Object theShapes, in string_array theOperators, in string_array theParameters, in string_array theValues)
 Apply a sequence of Shape Healing operators to the given object.
void GetShapeProcessParameters (out string_array theOperators, out string_array theParameters, out string_array theValues)
 Get default sequence of operators, their parameters and parameters' values of Shape Process operation.
void GetOperatorParameters (in string theOperator, out string_array theParameters, out string_array theValues)
 Get parameters and parameters' values for the given Shape Process operation.
GEOM_Object SuppressFaces (in GEOM_Object theObject, in short_array theFaces)
 Remove faces from the given object (shape).
GEOM_Object CloseContour (in GEOM_Object theObject, in short_array theWires, in boolean isCommonVertex)
 Close an open wire.
GEOM_Object RemoveIntWires (in GEOM_Object theObject, in short_array theWires)
 Remove internal wires and edges from the given object (face).
GEOM_Object FillHoles (in GEOM_Object theObject, in short_array theWires)
 Remove internal closed contours (holes) from the given object.
GEOM_Object Sew (in GEOM_Object theObject, in double theTolerance)
GEOM_Object DivideEdge (in GEOM_Object theObject, in short theEdgeIndex, in double theValue, in boolean isByParameter)
 Addition of a point to a given edge object.
boolean GetFreeBoundary (in GEOM_Object theObject, out ListOfGO theClosedWires, out ListOfGO theOpenWires)
 Get a list of wires (wrapped in GEOM_Object-s), that constitute a free boundary of the given shape.
GEOM_Object ChangeOrientation (in GEOM_Object theObject)
 Change orientation of the given object.
GEOM_Object ChangeOrientationCopy (in GEOM_Object theObject)
GEOM_Object LimitTolerance (in GEOM_Object theObject, in double theTolerance)
 Try to limit tolerance of the given object by value theTolerance.
boolean IsDone ()
 To know, if the operation was successfully performed.
void SetErrorCode (in string theErrorID)
 Set the operation error code.
string GetErrorCode ()
 Get the operation error code.
long GetStudyID ()
 Get ID of study, where the operation is defined.
void StartOperation ()
 Opens a new transaction.
void FinishOperation ()
 Closes the previously opened trasaction.
void AbortOperation ()
 Aborts the previously opened transaction.

Detailed Description

Interface for shape healing operations.

Shape Processing, SuppressFaces, etc.

Member Function Documentation

GEOM_Object GEOM::GEOM_IHealingOperations::ProcessShape ( in GEOM_Object  theShapes,
in string_array  theOperators,
in string_array  theParameters,
in string_array  theValues 
)

Apply a sequence of Shape Healing operators to the given object.

Parameters
theShapesShape to be processed.
theOperatorsList of names of operators ("FixShape", "SplitClosedFaces", etc.).
theParametersList of names of parameters ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
theValuesList of values of parameters, in the same order as parameters are listed in theParameters list.
Returns
New GEOM_Object, containing processed shape.
void GEOM::GEOM_IHealingOperations::GetShapeProcessParameters ( out string_array  theOperators,
out string_array  theParameters,
out string_array  theValues 
)

Get default sequence of operators, their parameters and parameters' values of Shape Process operation.

In the current implementation the defaults are read from the file pointed by CSF_ShHealingDefaults environmental variable.

Parameters
theOperatorsOutput. Default list of names of operators.
theParametersOutput. Default list of names of parameters.
theValuesOutput. List of default values of parameters, in the same order as parameters are listed in theParameters list.
void GEOM::GEOM_IHealingOperations::GetOperatorParameters ( in string  theOperator,
out string_array  theParameters,
out string_array  theValues 
)

Get parameters and parameters' values for the given Shape Process operation.

In the current implementation the defaults are read from the file pointed by CSF_ShHealingDefaults environmental variable.

Parameters
theOperatorInput. The operator's name.
theParametersOutput. Default list of names of parameters.
theValuesOutput. List of default values of parameters, in the same order as parameters are listed in theParameters list.
GEOM_Object GEOM::GEOM_IHealingOperations::SuppressFaces ( in GEOM_Object  theObject,
in short_array  theFaces 
)

Remove faces from the given object (shape).

Parameters
theObjectShape to be processed.
theFacesIndices of faces to be removed, if EMPTY then the method removes ALL faces of the given object.
Returns
New GEOM_Object, containing processed shape.
GEOM_Object GEOM::GEOM_IHealingOperations::CloseContour ( in GEOM_Object  theObject,
in short_array  theWires,
in boolean  isCommonVertex 
)

Close an open wire.

Parameters
theObjectShape to be processed.
theWiresIndexes of edge(s) and wire(s) to be closed within theObject's shape, if -1, then theObject itself is a wire.
isCommonVertexIf TRUE : closure by creation of a common vertex, If FALS : closure by creation of an edge between ends.
Returns
New GEOM_Object, containing processed shape.
GEOM_Object GEOM::GEOM_IHealingOperations::RemoveIntWires ( in GEOM_Object  theObject,
in short_array  theWires 
)

Remove internal wires and edges from the given object (face).

Parameters
theObjectShape to be processed.
theWiresIndices of wires to be removed, if EMPTY then the method removes ALL internal wires of the given object.
Returns
New GEOM_Object, containing processed shape.
GEOM_Object GEOM::GEOM_IHealingOperations::FillHoles ( in GEOM_Object  theObject,
in short_array  theWires 
)

Remove internal closed contours (holes) from the given object.

Parameters
theObjectShape to be processed.
theWiresIndices of wires to be removed, if EMPTY then the method removes ALL internal holes of the given object
Returns
New GEOM_Object, containing processed shape.
GEOM_Object GEOM::GEOM_IHealingOperations::Sew ( in GEOM_Object  theObject,
in double  theTolerance 
)

Sewing of the given object.

Parameters
theObjectShape to be processed.
theToleranceRequired tolerance value.
Returns
New GEOM_Object, containing processed shape.
GEOM_Object GEOM::GEOM_IHealingOperations::DivideEdge ( in GEOM_Object  theObject,
in short  theEdgeIndex,
in double  theValue,
in boolean  isByParameter 
)

Addition of a point to a given edge object.

Parameters
theObjectShape to be processed.
theEdgeIndexIndex of edge to be divided within theObject's shape, if -1, then theObject itself is the edge.
theValueValue of parameter on edge or length parameter, depending on isByParameter.
isByParameterIf TRUE : theValue is treated as a curve parameter [0..1], if FALSE : theValue is treated as a length parameter [0..1]
Returns
New GEOM_Object, containing processed shape.
boolean GEOM::GEOM_IHealingOperations::GetFreeBoundary ( in GEOM_Object  theObject,
out ListOfGO  theClosedWires,
out ListOfGO  theOpenWires 
)

Get a list of wires (wrapped in GEOM_Object-s), that constitute a free boundary of the given shape.

Parameters
theObjectShape to get free boundary of.
theClosedWiresOutput. Closed wires on the free boundary of the given shape.
theOpenWiresOutput. Open wires on the free boundary of the given shape.
Returns
FALSE, if an error(s) occured during the method execution.
GEOM_Object GEOM::GEOM_IHealingOperations::ChangeOrientation ( in GEOM_Object  theObject)

Change orientation of the given object.

Parameters
theObjectShape to be processed.
Returns
New GEOM_Object, containing processed shape.
GEOM_Object GEOM::GEOM_IHealingOperations::ChangeOrientationCopy ( in GEOM_Object  theObject)
GEOM_Object GEOM::GEOM_IHealingOperations::LimitTolerance ( in GEOM_Object  theObject,
in double  theTolerance 
)

Try to limit tolerance of the given object by value theTolerance.

Parameters
theObjectShape to be processed.
theToleranceRequired tolerance value.
Returns
New GEOM_Object, containing processed shape.
boolean GEOM::GEOM_IOperations::IsDone ( )
inherited

To know, if the operation was successfully performed.

void GEOM::GEOM_IOperations::SetErrorCode ( in string  theErrorID)
inherited

Set the operation error code.

Parameters
theErrorIDis a string describing the error occured
Note
This method is supposed to be used only by interfaces inheriting from IOperations.
string GEOM::GEOM_IOperations::GetErrorCode ( )
inherited

Get the operation error code.

long GEOM::GEOM_IOperations::GetStudyID ( )
inherited

Get ID of study, where the operation is defined.

void GEOM::GEOM_IOperations::StartOperation ( )
inherited

Opens a new transaction.

void GEOM::GEOM_IOperations::FinishOperation ( )
inherited

Closes the previously opened trasaction.

void GEOM::GEOM_IOperations::AbortOperation ( )
inherited

Aborts the previously opened transaction.

Copyright © 2007-2012 CEA/DEN, EDF R&D, OPEN CASCADE
Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS