All Frameworks Class Hierarchy This Framework Previous Indexes
TopologicalOperators Class CATWireExtrapolationOp
Mathematics.CATCGMVirtual
|
+---GeometricObjects.CATCGMOperator
|
+---NewTopologicalObjects.CATTopOperator
|
+---CATWireExtrapolationOp
Usage: you must use this class as is. You should never derive it.
public class CATWireExtrapolationOp
Class defining the extrapolation operator on a wire body.
To use it:
- Create it with the CATCreateWireExtrapolationOp global function.
- Tune it with appropriate options, using the SetXxx methods.
- Run it
- Get the resulting GetResult method. If you do not want
to keep these resulting body, use the CATICGMContainer.Remove method to remove them from the geometric factory, after the operator deletion.
- delete it after use with the usual C++ delete operator.
Constructor and Destructor Index
- o
~CATWireExtrapolationOp()
-
Method Index
- o
GetFreezeMode()
- Returns the freeze mode of this CATWireExtrapolationOp.
- o
GetResult()
- Returns a pointer to the resulting CATBody of this CATWireExtrapolationOp.
- o
Run()
- Runs this CATWireExtrapolationOp.
- o
SetExtrapolation(CATVertex*,double)
- Set extrapolation length for specified vertex.
- o
SetFreezeMode(short)
- Modifies the freeze mode of this CATWireExtrapolationOp.
Constructor and Destructor
- o ~CATWireExtrapolationOp
-
public virtual ~CATWireExtrapolationOp( | ) |
-
Methods
- o GetFreezeMode
-
public short GetFreezeMode( | )const |
-
Returns the freeze mode of this CATWireExtrapolationOp.
- Returns:
-
- 0
- The resulting CATBody is not frozen: it can be modified afterwards.
- 1
- The resulting CATBody is frozen: it cannot be modified afterwards.
- o GetResult
-
-
Returns a pointer to the resulting CATBody of this CATWireExtrapolationOp.
Must be called after the Run method.
- o Run
-
-
Runs this CATWireExtrapolationOp.
- o SetExtrapolation
-
public void SetExtrapolation( | CATVertex* | iVertex, |
| double | iLength) |
-
Set extrapolation length for specified vertex.
- Parameters:
-
- iVertex
- The vertex to be extrapolated.
- iLength
- The extrapolation length.
- o SetFreezeMode
-
public void SetFreezeMode( | short | iMode | =1) |
-
Modifies the freeze mode of this CATWireExtrapolationOp.
At the operator creation, the mode is set to 1.
- Parameters:
-
- iMode
-
- 0
- The resulting CATBody is not frozen: it can be modified afterwards.
- 1
- The resulting CATBody is frozen: it cannot be modified afterwards.
This object is included in the file: CATWireExtrapolationOp.h
If needed, your Imakefile.mk should include the module: CATTopologicalOperators