All Frameworks Class Hierarchy This Framework Indexes Previous Next

GMModelInterfaces Interface CATICGMInclusionPtSur

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

interface CATICGMInclusionPtSur

Class defining the operator for testing the inclusion of a point in a surface.

The inclusion is tested within a given tolerance. The operator gets all the points closed enough (at the tolerance) to the surface, spaced each other by a curvilinear distance at least equal to 2*Tol. This operator is optimized for low values of Tol. It differs from the CATICGMDistanceMinPtSur operator, that only outputs one point realizing the minimum distance without tolerance.

The CATICGMInclusionPtSur operator is created with the CATCGMCreateInclusion method and directly released with the Release method. It is is not streamable.
In case of BASIC mode, the operation is automatically performed at the operator creation. In case of ADVANCED mode, options can be precised with the SetXxx methods, before asking for the computation with the Run method. The advanced mode also allows you to run the same operator with different points.
In both cases, the result is accessed with a specific interator.

Method Index

o BeginningPoint(): Initializes the iterator of the resulting points of this CATICGMInclusionPtSur operator.
o GetDistance(): Returns the distance of a solution point and the surface.
o GetNumberOfPoints(): Returns the number of resulting points of this CATICGMInclusionPtCrv operator.
o GetPointOnSurface(): Creates the next solution point of this CATICGMInclusionPtSur operator.
o GetSignature(): Returns the signature of the solution point.
o GetSurParam(): Retrieves the parameter of the next solution point of this CATICGMInclusionPtSur operator.
o NextPoint(): Skips to the next solution point of this CATICGMInclusionPtSur operator.
o SetLimits(CATSurLimits&): Defines the curve new limitations to take into account for this operator in ADVANCED mode.
o SetPoint(CATPoint*): Sets a new point for this operator (ADVANCED mode).
o SetPoint(CATMathPoint&): Sets a new point for this operator (ADVANCED mode).

Methods

o BeginningPoint

public virtual BeginningPoint(

)

Initializes the iterator of the resulting points of this CATICGMInclusionPtSur operator.
By default, the initialization is performed once the operator runs, and this is therefore only used to read the solutions again.

o GetDistance

public virtual GetDistance(

)

Returns the distance of a solution point and the surface.

Returns:: The distance.

o GetNumberOfPoints

public virtual GetNumberOfPoints(

)

Returns the number of resulting points of this CATICGMInclusionPtCrv operator.

Returns:: The number of solutions.

o GetPointOnSurface

public virtual GetPointOnSurface(

)

Creates the next solution point of this CATICGMInclusionPtSur operator.

Returns:: The pointer to the created point on surface. A new point is created each time this method is called. If you do not want to keep the created point, use the method.

o GetSignature

public virtual GetSignature(

)

Returns the signature of the solution point.

Returns:

The signature.
Legal values:

0: if the point is on the surface
-1 of 1: according to the sign of the dot product : (Point-Projection(Point))*NormalToSurface(Projection(Point)).

o GetSurParam

public virtual GetSurParam(

)

Retrieves the parameter of the next solution point of this CATICGMInclusionPtSur operator.

Returns:: The parameter.

o NextPoint

public virtual NextPoint(

)

Skips to the next solution point of this CATICGMInclusionPtSur operator.
After BeginningPoint, it skips to the first point. The points are spaced each other by a curvilinear length at least equal to 2*Tol.

Returns:

The existence of the next solution.
Legal values:

TRUE: if there is a solution point
FALSE: no more solution point.

o SetLimits

public virtual SetLimits( const iNewLimits)

Defines the curve new limitations to take into account for this operator in ADVANCED mode.

Parameters:

iNewLimits: The new limitations on the curve.

o SetPoint

public virtual SetPoint( iPt)

Sets a new point for this operator (ADVANCED mode).

Parameters:

iPt: The pointer to the new point to take into account.

o SetPoint

public virtual SetPoint( iMathPt)

Sets a new point for this operator (ADVANCED mode).

Parameters:

iMathPt: The new point to take into account.

This object is included in the file: CATICGMInclusionPtSur.h
If needed, your Imakefile.mk should include the module: CATGMModelInterfaces