All Frameworks  Class Hierarchy  This Framework  Indexes   

NewTopologicalObjects Class CATTopPositionPtFaceOperator

Usage: you must use this class as is. You should never derive it.


public class CATTopPositionPtFaceOperator

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


Constructor and Destructor Index


o ~CATTopPositionPtFaceOperator()

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.

Constructor and Destructor


o ~CATTopPositionPtFaceOperator
public virtual ~CATTopPositionPtFaceOperator()

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

Copyright © 2003, Dassault Systèmes. All rights reserved.