All Frameworks Class Hierarchy This Framework Indexes Previous Next

GMModelInterfaces Interface CATICGMPositionPtFaceOperator

SystemTS.IUnknown

Mathematics.CATCGMVirtualItf

Mathematics.CATICGMVirtual

CATICGMPositionPtFaceOperator

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

interface CATICGMPositionPtFaceOperator

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

It is created with the CATCGMCreatePositionPtFaceOperator global function: It must be directly released with the Release method 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 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.

Methods

o GetOneResult

public virtual CATLocation GetOneResult(

)= 0

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 const CATLocation * GetResults(

)const = 0

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