All Frameworks Class Hierarchy This Framework Indexes Previous Next

GMOperatorsInterfaces Interface CATICGMTopPositionPtFaceOperator

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATICGMTopPositionPtFaceOperator

Class defining the operator that tests the position of a 2D point with respect to a face.
The CATICGMTopPositionPtFaceOperator operator follows the global frame of the topological operators:

It is created with the CATCGMCreatePositionPtFaceOperator 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.

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 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.

Methods

o GetOneResult

public virtual 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

public virtual 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 SetSurParams

public virtual SetSurParams(		`iNbPoints`,
		`iPoints`)

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 SetToleranceOnBoundary( iTol)

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: CATICGMTopPositionPtFaceOperator.h
If needed, your Imakefile.mk should include the module: CATGMOperatorsInterfaces