All Frameworks Class Hierarchy This Framework Previous Next Indexes
BasicTopologicalOpe Class CATTopSplineOperator
Mathematics.CATCGMVirtual
|
+---GeometricObjects.CATCGMOperator
|
+---NewTopologicalObjects.CATTopOperator
|
+---BasicTopologicalOpe.CATTopCurveOperator
|
+---CATTopSplineOperator
Usage: you must use this class as is. You should never derive it.
public class CATTopSplineOperator
Class defining a topological operator that creates a spline body.
This operator follows the general scheme of the topological operators.
For a basic use, use directly the global function
CATCreateTopSpline, that directly returns the resulting body.
If you need to tune specific parameters, use the advanced scheme:
- Create the operator with the global function CATCreateTopSplineOperator
- Set parameters
- Run
- Get the resulting body
- Delete the operator with the usual C++ delete operator.
Constaints can be imposed on each points in the following way:
- 0
- no constraint, neither on the tangent, nor on the curvature.
- 1
- the direction of the tangent is imposed.
- 2
- the tangent is imposed.
- 4
- the tangent and the direction of the curvature are imposed.
- 6
- the tangent and the curvature are imposed.
Constructor and Destructor Index
- o
~CATTopSplineOperator()
-
Method Index
- o
GetComputedCurvatureVectors(CATMathVector*)
- Retrieves, after a Run, the computed curvatures at each point.
- o
GetComputedTangents(CATMathVector*&)
- Retrieves, after a Run, the computed tangents at each point.
- o
GetImposedCurvatureVectors(CATMathVector*,CATLONG32*)
- Retrieves the tangent constraints, as put in the operator definition.
- o
GetImposedTangents(CATMathVector*&,CATLONG32*&)
- Retrieves the tangent constraints, as put in the operator definition.
- o
GetNbPoints()
- Returns the number of points defined at the operator construction.
- o
GetSplineMode(CATSplineMode&)
- Returns the spline mode construction.
- o
SetCurvatureVectors(CATMathVector*,CATLONG32*)
- Sets new curvature contraints.
- o
SetSplineMode(CATSplineMode)
- Sets the type of spline computation.
- o
SetTangents(CATMathVector*,CATLONG32*)
- Sets new tangent contraints.
Constructor and Destructor
o ~CATTopSplineOperator
public virtual ~CATTopSplineOperator( | ) |
-
Methods
o GetComputedCurvatureVectors
-
Retrieves, after a Run, the computed curvatures at each point.
The array must not be deallocated.
- Parameters:
-
- oCurvatures
- The computed curvatures.
- Returns:
- A diagnosis .
Legal values::
0 if curvatures are computed, 1 otherwise.
o GetComputedTangents
-
Retrieves, after a Run, the computed tangents at each point.
The array must not be deallocated.
- Parameters:
-
- oTangents
- The computed tangents.
- Returns:
- A diagnosis .
Legal values::
0 if tangents are computed, 1 otherwise.
o GetImposedCurvatureVectors
-
Retrieves the tangent constraints, as put in the operator definition.
The array must not be deallocated.
- Parameters:
-
- oCurvatures
- The array of the curvature constraints at each point.
If some curvatures are constraints, all
the array is allocated.
- oImposition
- An array that defines the type of constraint for each point.
- Returns:
- A diagnosis .
Legal values::
0 if curvatures where defined, 1 otherwise.
o GetImposedTangents
-
Retrieves the tangent constraints, as put in the operator definition.
The array must not be deallocated.
- Parameters:
-
- oTangents
- The array of tangential constraints at each point.
If some tangents are constraints, all
the array is allocated.
- oImposition
- An array that defines the type of constraint for each point.
- Returns:
- A diagnosis .
Legal values::
0 if tangents where defined, 1 otherwise.
o GetNbPoints
-
Returns the number of points defined at the operator construction.
- Returns:
- The number of points.
o GetSplineMode
-
Returns the spline mode construction.
- Parameters:
-
- ioSplineConstruction
- The spline mode.
o SetCurvatureVectors
-
Sets new curvature contraints.
If a curvature is imposed, the tangent at the same point point must also be imposed.
- Parameters:
-
- iCurvatures
- The array of the curvature constraints at each point.
If some curvatures are constraints, all
the array must be allocated.
- iImposition
- An array that defines the type of constraint for each point.
Legal values:
- 0
- no constraint, neither on the tangent, nor on the curvature.
- 1
- the direction of the tangent is imposed.
- 2
- the tangent is imposed.
- 4
- the tangent and the direction of the curvature are imposed.
- 6
- the tangent and the curvature are imposed.
o SetSplineMode
-
Sets the type of spline computation.
- Parameters:
-
- iSplineConstruction
- The type of interpolation.
o SetTangents
-
Sets new tangent contraints.
This method resets already existing results
(obtained by GetComputedTangents and GetComputedCurvatureVectors)
- Parameters:
-
- iTangents
- The array of tangential constraints at each point.
If some tangents are constraints, all
the array must be allocated.
- iImposition
- An array that defines the type of constraint for each point.
Legal values:
- 0
- no constraint, neither on the tangent, nor on the curvature.
- 1
- the direction of the tangent is imposed.
- 2
- the tangent is imposed.
- 4
- the tangent and the direction of the curvature are imposed.
- 6
- the tangent and the curvature are imposed.
If 4 and 6, the methof checks that the curvatures are already been imposed.
This object is included in the file: CATTopSplineOperator.h
If needed, your Imakefile.mk should include the module: CATBasicTopologicalOpe