All Frameworks Class Hierarchy This Framework Previous Next Indexes
NewTopologicalObjects Class CATPositionPtFaceOperator
CATPositionPtFaceOperator
Usage: you must use this class as is. You should never derive it.
public class CATPositionPtFaceOperator
Class defining the operator that tests the position of a 2D point with respect to a face.
The CATPositionPtFaceOperator operator follows the global frame of the topological operators:
- It is created with the CATCreatePositionPtFaceOperator global function:
It must be directly deleted with the usual C++ delete operator after use. It is not streamable.
- Options can be precised (such as the point to test) with the SetXxx methods, before
asking for the computation with the Run method.
- The result ot the test is accessed with the GetOneResult method for a point,
and theGetResults method for an array of points.
Constructor and Destructor Index
- o
~CATPositionPtFaceOperator()
-
Method Index
- o
GetOneResult()
- Returns the result of the test in case of a point.
- o
GetResults()
- Returns the result of the test in case of an array of points.
- o
Run()
- Runs this operator.
- o
SetSurParam(CATSurParam&)
- Defines another point to test.
- o
SetSurParams(int,CATSurParam[])
- Defines another array of points to test.
- o
SetToleranceOnBoundary(double)
- Defines the tolerance for a point to be on the face boundary.
Constructor and Destructor
o ~CATPositionPtFaceOperator
public virtual ~CATPositionPtFaceOperator( | ) |
-
Methods
o GetOneResult
-
Returns the result of the test in case of a point.
To call after the Run method.
- Returns:
- The result of the location test.
Legal values:
- CATLocationInner
- if the point is inside the face
- CATLocationOuter
- if the point is outside the face
- CATLocationFull
- if the point is on the boundary of
the face.
o GetResults
-
Returns the result of the test in case of an array of points.
To call after the Run method.
- Returns:
- The pointer to the array [iNbPoints] of locations.
Legal values:
- CATLocationInner
- if the point is inside the face
- CATLocationOuter
- if the point is outside the face
- CATLocationFull
- if the point is on the boundary of
the face.
o Run
public virtual void Run( | )= 0 |
-
Runs this operator.
o SetSurParam
public virtual void SetSurParam( | const CATSurParam& | iPoint) = 0 |
-
Defines another point to test.
To have the result, Run again the operator.
- Parameters:
-
- iPoint
- The 2D point to test.
o SetSurParams
public virtual void SetSurParams( | int | iNbPoints, |
| CATSurParam[] | iPoints) = 0 |
-
Defines another array of points to test.
To have the result, Run again the operator.
- Parameters:
-
- iNbPoints
- The number of points to test in the array iPoints.
- iPoints
- The array [iNbPoints] of points to test.
o SetToleranceOnBoundary
public virtual void SetToleranceOnBoundary( | double | iTol) = 0 |
-
Defines the tolerance for a point to be on the face boundary.
To call before the Run method if needed. By default, the tolerance is
set to the factory resolution.
- Parameters:
-
- iTol
- The tolerance.
This object is included in the file: CATPositionPtFaceOperator.h
If needed, your Imakefile.mk should include the module: CATTopologicalObjects