GMModelInterfaces Interface CATICGMDistanceMinPtCrv

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

interface CATICGMDistanceMinPtCrv

Class defining the operator of the minimum distance between a point and a curve.

The CATICGMDistanceMinPtCrv operator is created with the CATCGMCreateDistanceMin 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 specific methods.

Method Index

o GetCrvParam(): Returns the global parameter of the point realizing the minimum distance.
o GetDistance(): Returns the minimum distance between a curve and a point.
o GetPointOnCurve(): Creates a CATPointOnCurve realizing the minimum distance.
o SetLimits(CATCrvLimits&): Defines the new domain of the curve to take into account for this operator in ADVANCED mode.
o SetPoint(CATMathPoint&): Sets the new point from which the main distance with the curve is computed.

o GetCrvParam

public virtual GetCrvParam(

)

Returns the global parameter of the point realizing the minimum distance.
Note that only one point is proposed, even multiple solutions exist.

o GetDistance

public virtual GetDistance(

)

Returns the minimum distance between a curve and a point.

o GetPointOnCurve

public virtual GetPointOnCurve(

)

Creates a CATPointOnCurve realizing the minimum distance.
Note that only one point is proposed, even multiple solutions exist.

Returns:: The pointer to the created point. 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 SetLimits

public virtual SetLimits( const iLimits)

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

Parameters:

o SetPoint

public virtual SetPoint( const iPoint)

Sets the new point from which the main distance with the curve is computed.

Parameters:

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