All Frameworks Class Hierarchy This Framework Previous Next Indexes
NewTopologicalObjects Class CATTopOperator
Mathematics.CATCGMVirtual
|
+---GeometricObjects.CATCGMOperator
|
+---CATTopOperator
Usage: you must use this class as is. You should never derive it.
public class CATTopOperator
Abstract class for the topological operators.
The topological operators follow the use frame of all operator and satisfy to the smart mechanism: the
input bodies are not modified. A new resulting body is created,
possibly sharing data with the input ones. They are not streamable.
To use a topological operator:
- Create it with the CATCreateTopXxx global methods
- Tune it with appropriate options, using the SetXxx methods.
- Run it
- Get the result with the GetResult method. If you do not want
to keep the resulting body, use the CATICGMContainer.Remove method to remove it from the geometric factory.
- delete it after use.
Constructor and Destructor Index
- o
~CATTopOperator()
- Destructor.
Method Index
- o
GetFreezeMode()
- Returns the mode in which the resulting body is created.
- o
GetInputObjectsForJournal(CATBoolean&,CATLISTP(CATICGMObject)&,CATTopCheckJournalType,CATGeometricType)
- Returns the input objects used by this CATTopOperator to create its journal.
- o
GetJournal()
- Returns a pointer to the topological journal associated with this CATTopOperator.
- o
GetResult()
- Returns a pointer to the resulting body.
- o
GetResult(CATCGMJournalList*)
- Returns the pointer to the resulting body.
- o
SetFreezeMode(CATBodyFreezeMode)
- Defines the state of the resulting body.
Data Member Index
- o
iCGMODTScaleManager
-
- o
iCGMODTScaleManager
-
Constructor and Destructor
o ~CATTopOperator
public virtual ~CATTopOperator( | ) |
-
Destructor.
Methods
o GetFreezeMode
-
Returns the mode in which the resulting body is created.
- Returns:
- The smart mode.
o GetInputObjectsForJournal
-
Returns the input objects used by this CATTopOperator to create its journal.
- Parameters:
-
- oSucceeded
- This returned value tells whether this CATTopOperator
actually defined its journal inputs or not. If FALSE,
the content of oObjects should not be relied on.
- oObjects
- The list of requested inputs.
- iCopy_Or_Not
- The copy status of requested input objects.
Legal values:
- CATTopCheckCopy
-
- CATTopCheckNoCopy
-
- CATTopCheckNeutral
- iTypeOfObjects
- The geometric type of the requested input objects.
o GetJournal
-
Returns a pointer to the topological journal associated with this CATTopOperator.
Only available if a journal was given at the operator creation.
- Returns:
- The pointer to the journal of the operation.
o GetResult
-
Returns a pointer to the resulting body.
The body is frozen and completed if CATBodyFreezeOn is active (default mode).
- Returns:
- The pointer to the resulting body. Use
CATICGMContainer.Remove if you do not want to keep it.
o GetResult
-
Returns the pointer to the resulting body.
The pointer to the journal of the operation.
- Parameters:
-
- iJournal
- The pointer to the journal to fill.
- Returns:
- The pointer to the resulting body. If you do not want to keep it,
use the
CATICGMContainer.Remove method to remove it from the geometric factory.
o SetFreezeMode
-
Defines the state of the resulting body.
- Parameters:
-
- iOnOrOff
- The state of the resulting body.
Data Members
o iCGMODTScaleManager
public CATCGMODTScaleManager *iCGMODTScaleManager=NULL)
-
o iCGMODTScaleManager
public CATCGMODTScaleManager *iCGMODTScaleManager=NULL)
-
This object is included in the file: CATTopOperator.h
If needed, your Imakefile.mk should include the module: CATTopologicalObjects