GMOperatorsInterfaces Interface CATICGMThickPlus
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICGMThickPlus
Operator to blow or shrink the faces of a volume.
Each face may have its own offset value. The offset values
may be negative: the body is shrunk.
This operator can also be used to offset a shell. In this case, it is recommended to use the
SetSharpBorderMode API with the optimization parameter.
As all the topological operators, the input objects are not modified. The resulting body is
a new one to retrieve by using the CATICGMThickPlus::GetResult method.
To use it:
- Create it with the CATICGMCreateThickPlus global function.
- Tune it with appropriate options, using the SetXxx methods.
- Run it
- Get the result in body with the GetResult method. If you do not want
to keep these resulting body, use the method to remove them from the geometric factory, after the operator deletion.
- Release the operator with the Release method after use.
Method Index
- o
Append(CATFace*,CATLength)
- Appends a face to offset.
- o
Append(CATLISTP(CATFace)&,CATLength)
- Appends a list of faces to offset by a common offset value.
- o
GetResult()
- Returns the pointer to the resulting body.
- o
Run()
- Runs this operator.
- o
SetDefaultOffsetValue(CATLength)
- Defines the default offset value for all the faces of the input body.
- o
SetDeviationAllowed(CATLength)
- Sets the deviation allowed by the user.
- o
SetDeviationMode(CATBoolean)
- Sets the deviation mode.
- o
SetJournalTypeForFaceOffset(CATCGMJournal::Type,CATCGMJournalInfo*)
- Modifies the type of the journal items created during this CATICGMThickPlus operation.
- o
SetLocalRegularization(CATBoolean)
- Activates/Deactivates local regularisation treatment (which may split faces) to
smooth subparts of the non offsetable faces.
- o
SetOffsetMixte(CATBoolean,CATBoolean)
- Sets the OffsetMixte options.
- o
SetPropagationOff()
- Deactivates tangent propagation of offset values.
- o
SetSharpBorderMode(short)
- Defines how borders are transformed in the neighborhood of sharp edges.
Methods
o Append
public virtual Append( | | iFaceToOffset, |
| | iOffsetValue) |
-
Appends a face to offset.
- Parameters:
-
- iFace
- The pointer to the face to offset with iOffsetValue.
- iOffsetValue
- The offset value.
o Append
public virtual Append( | const | iFacesToOffset, |
| | iOffsetValue) |
-
Appends a list of faces to offset by a common offset value.
- Parameters:
-
- iFacesToOffset
- The list of pointers to faces to offset with iOffsetValue.
- iOffsetValue
- The offset value.
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
-
Runs this operator.
o SetDefaultOffsetValue
public virtual SetDefaultOffsetValue( | | iOffsetValue) |
-
Defines the default offset value for all the faces of the input body.
The Append methods can still be used after this method to
locally modify the default on some faces.
- Parameters:
-
- iOffsetValue
- The default offset value.
o SetDeviationAllowed
public virtual SetDeviationAllowed( | | iDeviation) |
-
Sets the deviation allowed by the user.
Legal Values:
- iDeviation : represents the value of the deviation.This
value must be positive.
NOTE : If you use this method, the distribution of the tolerances is
determined by the value containing in the file : CATFuzzyOffsetManagerConst.h
o SetDeviationMode
public virtual SetDeviationMode( | | iWithDeviation) |
-
Sets the deviation mode.
Legal Values:
- iWithDeviation: If it's TRUE, then the regularisator uses the derivation value of the user.
If it's FALSE, then the regularisator does not use the derivation value of the user.
NOTE : By default the DeviationMode is false.
o SetJournalTypeForFaceOffset
public virtual SetJournalTypeForFaceOffset( | | iTypeForFaceCreation, |
| | iAdditionalInfo | = NULL) |
-
Modifies the type of the journal items created during this CATICGMThickPlus operation.
- Parameters:
-
- iTypeForFaceCreation
- The item type.
- iAdditionalInfo
- The pointer to an additional information. If NULL, no additional information is added.
o SetLocalRegularization
public virtual SetLocalRegularization( | | iLocalRegul) |
-
Activates/Deactivates local regularisation treatment (which may split faces) to
smooth subparts of the non offsetable faces.
- Parameters:
-
- iLocalRegul
-
- TRUE: Activates local regularisation.
- FALSE: Deactivates local regularisation.
o SetOffsetMixte
public virtual SetOffsetMixte( | | iWithRegul, |
| | iRemoveTrickyOnlyThenRegul | = FALSE) |
-
Sets the OffsetMixte options.
Legal Values:
- iWithRegul: Activates the regularisation of tricky faces with a regularisation diagnosis
- iRemoveTrickyOnlyThenRegul : Default value: FALSE.
If this option is activated, it changes the behaviour of GetTrickyFaces().
If there are non regularisable tricky faces, the method
GetTrickyFaces() gives only the non regularisable tricky
faces. If there are not non regularisable tricky faces,
then GetTrickyFaces gives regularisable tricky faces that
fail.
NOTE: iRemoveTrickyOnlyThenRegul should be activated just if you use
CATICGMThickPlus in iterative mode with remove faces.
o SetPropagationOff
public virtual SetPropagationOff( | ) |
-
Deactivates tangent propagation of offset values.
o SetSharpBorderMode
public virtual SetSharpBorderMode( | | iSharpBorderOptimisation) |
-
Defines how borders are transformed in the neighborhood of sharp edges.
- Parameters:
-
- iSharpBorderOptimisation
-
Legal values:
- 0
- Optimization not required
- 1
- Optimization required (Skin handled like a Volume)
This object is included in the file: CATICGMThickPlus.h
If needed, your Imakefile.mk should include the module: CATGMOperatorsInterfaces
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.