All Frameworks Class Hierarchy This Framework Indexes Previous Next

GMOperatorsInterfaces Interface CATICGMRemoveFace

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATICGMRemoveFace

Class defining a topological operator which removes a set of faces from a volume or a skin.

This operator does not change the dimension of the body: a volume remains a volume, a skin remains a skin.
Unlike in the Part Design interactive command, the specified faces to be removed are not propagated, so that in your application, you should either provide a consistent set of faces or propagate the faces. The operation completes when the body can be closed by extrapolation of the faces which were adjacent to the ones removed but this extrapolation should not generate any tangency configuration.
To use this operator, you must:

Create it with the CATCGMCreateRemoveFace global function
Tune it with appropriate options, using the SetXxx or Append methods.
Run it
Get the result with the GetResult method. If you do not want to keep the resulting body, use the method to remove it from the geometric factory, after the operator deletion.
Release the operator with the Release method after use.

Method Index

o Append(CATLISTP(CATFace)&): Appends a list of faces to be removed.
o AppendLimiting(CATFace*,CATBody*,CATOrientation): Restricts the removal of a face to a portion delimited by a single-face skin.
o GetAllTrickyFaces(CATLISTP(CATFace)&,CATListOfInt&): Returns the complete list of faces when the operation cannot complete.
o GetResult(): Returns the pointer to the resulting body.
o Run(): Runs this operator.
o SetFreezeMode(CATBodyFreezeMode): Defines the "Freeze" mode of the resulting body.
o SetTwistDetection(short): Enables or disables twist detection.

Methods

o Append

public virtual Append( const iFacesToRemove)

Appends a list of faces to be removed.

Parameters:

iFacesToRemove: The list of pointers to faces to remove.

o AppendLimiting

public virtual AppendLimiting(		`iFaceToRelimit`,
		`iLimitingBody`,
		`iOri`)

Restricts the removal of a face to a portion delimited by a single-face skin.

Parameters:

iFaceToRemove: The face to be removed.
iLimitingBody: The limiting body.
iOri: The orientation defining the portion of the face to be removed.

o GetAllTrickyFaces

public virtual GetAllTrickyFaces(		`oAllTrickyFaces`,
		`oAllDiag`)

Returns the complete list of faces when the operation cannot complete. This method is mainly used by the interactive command to help the end-user determine why the operator cannot complete. When the operation completes, this list is empty.

Parameters:

oAllTrickyFaces: The list of faces intended to be removed, but not removed.
oAllDiag: The list of diagnosis.

o GetResult

public virtual GetResult(

)

Returns the pointer to the resulting body.

Returns:: The pointer to the resulting body, NULL if the operation failed. If you do not want to keep the resulting body, use the method to remove it from the geometric factory, after the operator deletion.

o Run

public virtual Run(

)

Runs this operator.

o SetFreezeMode

public virtual SetFreezeMode( iOnOrOff)

Defines the "Freeze" mode of the resulting body.

Parameters:

iOnOrOff

The "Freeze" mode of the resulting body.

CATBodyFreezeOff: the resulting body can be modified.
CATBodyFreezeOn: the resulting body cannot be modified. Any cell to be modified will have to be duplicated.

o SetTwistDetection

public virtual SetTwistDetection( iTwistDetection)

Enables or disables twist detection.

Parameters:

iTwistDetection

0: Twist detection is disabled : result body may lie on twisted surfaces. This mode is used by default at the creation of the operator.
1: Twist detection is enabled : face removal fails if at least one of the extrapolated surfaces is twisted.

This object is included in the file: CATICGMRemoveFace.h
If needed, your Imakefile.mk should include the module: CATGMOperatorsInterfaces