All Frameworks Class Hierarchy This Framework Indexes Previous Next

GMModelInterfaces Interface CATICGMDistanceMinCrvCrv

SystemTS.IUnknown

Mathematics.CATCGMVirtualItf

Mathematics.CATICGMVirtual

GeometricObjects.CATICGMOperator

GMModelInterfaces.CATICGMGeoOperator

CATICGMDistanceMinCrvCrv

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

interface CATICGMDistanceMinCrvCrv

Class defining the operator of the minimum distance between two curves.

The CATICGMDistanceMinCrvCrv 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, the user can precise options with the SetXxx methods, before asking for the computation with the Run method.
In both cases, the result is accessed with specific methods.

Method Index

o GetCurveParam(CATCurve*,CATCrvParam&): Returns a parameter on a given curve realizing the minimum distance between the two input CATCurves.
o GetDistance(): Returns the minimum distance between two CATCurves.
o GetPointOnCurve(CATCurve*): Creates a CATPointOnCurve realizing the minimum distance between two CATCurves.
o SetLimits(CATCrvLimits&,CATCrvLimits&): Defines the curve domain to take into account for this operator in case of ADVANCED mode.

Methods

o GetCurveParam

public virtual void GetCurveParam(	CATCurve*	`iCurve`,
	CATCrvParam&	`ioParam`) const = 0

Returns a parameter on a given curve realizing the minimum distance between the two input CATCurves.
Note that only one point is proposed, even multiple solutions exist.

Parameters:

iCurve: The pointer to the curve on which the parameter is retrieved.
ioParam: The parameter value of the point realizing the minimum distance on iCurve.

o GetDistance

public virtual double GetDistance(

)const = 0

Returns the minimum distance between two CATCurves.

Returns:: The minimum distance.

o GetPointOnCurve

public virtual CATPointOnCurve * GetPointOnCurve( CATCurve* iCurve) const = 0

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

Parameters:

iCurve: The pointer to the curve on which the point is created.

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 CATICGMContainer.Remove method.

o SetLimits

public virtual void SetLimits(	const CATCrvLimits&	`iCrvLim1`,
	const CATCrvLimits&	`iCrvLim2`) = 0

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

Parameters:

iCrvLim1: The limitations on the first curve.
iCrvLim2: The limitations on the second curve.

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