All Frameworks Class Hierarchy This Framework Previous Next Indexes
GeometricOperators Class CATDistanceMinPtCrv
Mathematics.CATCGMVirtual
|
+---GeometricObjects.CATCGMOperator
|
+---CATDistanceMinPtCrv
Usage: you must use this class as is. You should never derive it.
public class CATDistanceMinPtCrv
Class defining the operator of the minimum distance between
a point and a curve.
- The CATDistanceMinPtCrv operator is created with the CreateDistanceMin method and
directly deleted with the usual C++ delete operator.
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.
Constructor and Destructor Index
- o
~CATDistanceMinPtCrv()
- Destructor.
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 CATPointCnCurve 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.
Constructor and Destructor
o ~CATDistanceMinPtCrv
public virtual ~CATDistanceMinPtCrv( | ) |
-
Destructor.
Methods
o GetCrvParam
-
Returns the global parameter of the point realizing the minimum
distance.
Note that only one point is proposed, even multiple solutions exist.
- Returns:
- The parameter on the curve.
o GetDistance
public virtual double GetDistance( | )const = 0 |
-
Returns the minimum distance between a curve and a point.
- Returns:
- The distance.
o GetPointOnCurve
-
Creates a CATPointCnCurve 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
CATICGMContainer.Remove method.
o SetLimits
-
Defines the new domain of the curve to take into account for this operator in
ADVANCED mode.
- Parameters:
-
- iLimits
- The new limitations on the curve.
o SetPoint
-
Sets the new point from which the main distance with the curve is computed.
- Parameters:
-
- iPoint
- The new point.
This object is included in the file: CATDistanceMinPtCrv.h
If needed, your Imakefile.mk should include the module: CATGeometricOperators