All Frameworks Class Hierarchy This Framework Previous Next Indexes
GeometricOperators Class CATConvertCurveToCanonic
Mathematics.CATCGMVirtual
|
+---GeometricObjects.CATCGMOperator
|
+---GeometricOperators.CATGeoOperator
|
+---CATConvertCurveToCanonic
Usage: you must use this class as is. You should never derive it.
public class CATConvertCurveToCanonic
Class representing the geometric operator to compute the most approaching canonical
curve of a given curve.
- The CATConvertCurveToCanonic operator is created with the CATCreateConvertCurveToCanonic global function and
directly deleted with the usual C++ delete operator.
It is is not streamable.
- In case of BASIC
mode, the operation is automatically performed at the operator creation.
In case of ADVANCED
mode, options can be precised with the SetXxx methods, before
asking for the computation with the Run method.
- In both cases, the result is accessed with the GetResult method, that
can return NULL, if no approaching canonic is found.
Constructor and Destructor Index
- o
~CATConvertCurveToCanonic()
- Destructor.
Method Index
- o
GetPResult(CATLONG32&,CATCrvLimits&)
- Returns the pointer to the created canonical curve, as a CATPCurve.
- o
GetResult(CATCrvLimits&)
- Returns the pointer to the created canonical curve.
- o
Run()
- Runs this operator.
- o
SetRecognitionMode(CATBoolean)
- Defines the recognition mode.
- o
SetTolerance(double)
- Defines the tolerance to fit the input curve, in case of approximated recognition mode.
Constructor and Destructor
o ~CATConvertCurveToCanonic
public ~CATConvertCurveToCanonic( | ) |
-
Destructor.
Methods
o GetPResult
-
Returns the pointer to the created canonical curve, as a CATPCurve.
To use when the input curve is a CATEdgeCurve. In this case, a CATSurface
must be set at the operator creation.
- Parameters:
-
- ioOrientation
- The orientation of the created curve, with regards to the input CATEdgeCurve.
- ioLimits
- The limits of the created curve.
- Returns:
- The pointer to the created canonical CATPCurve, or NULL if no result was found.
If you do not want to keep it, you must remove it with the
CATICGMContainer.Remove method.
o GetResult
-
Returns the pointer to the created canonical curve.
- Parameters:
-
- ioLimits
- The limits of the created curve.
- Returns:
- The pointer to the created canonical curve, or NULL if no result was found.
If you do not want to keep it, you must remove it with the
CATICGMContainer.Remove method.
o Run
-
Runs this operator.
o SetRecognitionMode
public void SetRecognitionMode( | CATBoolean | iMode | =TRUE) |
-
Defines the recognition mode.
- Parameters:
-
- iMode
- The recognition mode.
Legal values:
- TRUE
- Exact recognition: the input curve must exactly fit a canonical curve.
- FALSE
- Approximated recognition.
o SetTolerance
public void SetTolerance( | double | iTolerance) |
-
Defines the tolerance to fit the input curve, in case of approximated recognition mode.
- Parameters:
-
- iTolerance
- The tolerance used in case of an approximated recognition.
This object is included in the file: CATConvertCurveToCanonic.h
If needed, your Imakefile.mk should include the module: CATGeometricOperators