All Frameworks Class Hierarchy This Framework Previous Next Indexes
AdvancedTopologicalOpe Class CATTopGeodesicPtPt
Mathematics.CATCGMVirtual
|
+---GeometricObjects.CATCGMOperator
|
+---NewTopologicalObjects.CATTopOperator
|
+---CATTopGeodesicPtPt
Usage: you must use this class as is. You should never derive it.
public class CATTopGeodesicPtPt
Class defining the operator that creates a geodesic line from two points.
This operator follows the general scheme of the topological operators:
- Creates the operator with the CATCreateGeodesicLinePtPt global function.
- Specifies the options by using the Setxxx methods.
- Runs with the Run method.
- Gets the result body by the GetResult method.
- Deletes the operator with the usual C++ delete operator.
Constructor and Destructor Index
- o
~CATTopGeodesicPtPt()
-
Method Index
- o
GetParam(CATMathVector&,double&,CATLONG32&)
- Retrieves the curve parameters.
- o
GetResult()
- Returns the resulting body.
- o
Run()
- Runs this operator.
- o
SetLength(double,double)
- Adds a given length at the extremities of the line.
- o
SetParam(CATMathVector&,double,CATLONG32)
- Re-specifies the curve parameters.
- o
SetTolerance(double)
- Defines the tolerance of the geometrically coincident elements to be taken
into account by this operator on start and end points.
Constructor and Destructor
o ~CATTopGeodesicPtPt
public virtual ~CATTopGeodesicPtPt( | ) |
-
Methods
o GetParam
-
Retrieves the curve parameters.
- Parameters:
-
- iovect
- The direction.
- iolength
- The length.
- ioinversion
- Legal values:
0: a solution is found from start to end point. iovect is tangent
to the line at the start point.
1/tt>: a solution is found from end to start point. iovect is tangent
to the line at the end point.
o GetResult
-
Returns the resulting body.
o Run
public virtual int Run( | )=0 |
-
Runs this operator. Returns 0 if the operation completes properly.
o SetLength
public virtual int SetLength( | double | ilength1 | =0, |
| double | ilength2 | =0)=0 |
-
Adds a given length at the extremities of the line.
- Parameters:
-
- ilength1
- From the start point.
- ilength2
- From the end point.
o SetParam
-
Re-specifies the curve parameters.
- Parameters:
-
- ivect
- The direction.
- ilength
- The length.
- iinversion
- To invert the direction.
o SetTolerance
public virtual void SetTolerance( | double | itolerance)=0 |
-
Defines the tolerance of the geometrically coincident elements to be taken
into account by this operator on start and end points.
The default value is the factory resolution,
and it is strongly recommended to keep it.
- Parameters:
-
- itolerance
- The tolerance.
This object is included in the file: CATTopGeodesicPtPt.h
If needed, your Imakefile.mk should include the module: CATAdvancedTopologicalOpe