All Frameworks Class Hierarchy This Framework Previous Next Indexes
AdvancedTopologicalOpe Class CATTopSimilarCurve
Mathematics.CATCGMVirtual
|
+---GeometricObjects.CATCGMOperator
|
+---NewTopologicalObjects.CATTopOperator
|
+---CATTopSimilarCurve
Usage: you must use this class as is. You should never derive it.
public class CATTopSimilarCurve
Class defining the topological operator that connects two wires with
the "Base Curve" option.
- A CATTopSimilarCurve operator is created with the CATCreateTopSimilarCurve global function;
it must be directly deleted with the usual C++ delete operator after use.
It is is not streamable.
- Options such as the start and end points must be
precised with the SetXxx methods, before
asking for the computation with the Run method.
- The result is accessed 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.Although several sucessive
Runs with different inputs
are possible, it is strongly recommended to Run it only once.
Constructor and Destructor Index
- o
~CATTopSimilarCurve()
-
Method Index
- o
GetResult()
- Returns the result of this operator.
- o
Run()
- Runs this operator.
- o
SetEndPoint(CATBody*,CATBody*)
- Defines the end point.
- o
SetStartPoint(CATBody*,CATBody*)
- Defines the start point.
- o
SetTrimmingMode(CATLONG32,CATLONG32)
- Defines whether the input bodies must be trimmed.
Constructor and Destructor
o ~CATTopSimilarCurve
public virtual ~CATTopSimilarCurve( | ) |
-
Methods
o GetResult
-
Returns the result of this operator.
- Returns:
- The pointer to the created body. You must delete it with the
CATICGMContainer.Remove method if you do not want to keep it.
o Run
public virtual int Run( | )=0 |
-
Runs this operator.
o SetEndPoint
-
Defines the end point.
- Parameters:
-
- iEndPoint
- The endpoint. It must be laid down on iCurve2
- iCurve2
- The second curve. If iCurve2 is NULL the point is free.
o SetStartPoint
-
Defines the start point.
- Parameters:
-
- iStartPoint
- The start point. It must be laid down on iCurve1
- iCurve
- The first curve. If iCurve1 is NULL the point is free.
o SetTrimmingMode
public virtual void SetTrimmingMode( | const CATLONG32 | iWire, |
| const CATLONG32 | iTrimmingMode)=0 |
-
Defines whether the input bodies must be trimmed.
- Parameters:
-
- iWire
- The first (1) or the second (2) wire body.
If not precised and if iTrimmingMode is set to ON,
the two wire bodies are trimmed.
- iTrimmingMode
- trim ON (1), trim OFF (0)
This object is included in the file: CATTopSimilarCurve.h
If needed, your Imakefile.mk should include the module: CATAdvancedTopologicalOpe