GMModelInterfaces Interface CATICGMInclusionPtCrv
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICGMInclusionPtCrv
Class defining the operator for testing the inclusion of a point
in a curve.
The inclusion is tested within a given tolerance. The operator gets all
the points closed enough (at the tolerance) to the curve, 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
CATICGMDistanceMinPtCrv operator, that only outputs one point realizing
the minimum distance without tolerance.
- The CATICGMInclusionPtCrv 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 limitations of the curve.
- In both cases, the result is accessed with a specific interator.
Method Index
- o
BeginningPoint()
- Initializes the iterator of the resulting points of this
CATICGMInclusionPtCrv operator.
- o
GetCurveParam(CATCrvParam&)
- Retrieves the parameter of the next solution point of this CATICGMInclusionPtCrv operator.
- o
GetDistance()
- Returns the distance of a solution point and the curve.
- o
GetNumberOfPoints()
- Returns the number of resulting points of this CATICGMInclusionPtCrv operator.
- o
GetPointOnCurve()
- Creates the next solution point of this CATICGMInclusionPtCrv operator.
- o
NextPoint()
- Skips to the next solution point of this CATICGMInclusionPtCrv operator.
- o
SetLimits(CATCrvLimits&)
- Modifies the curve domain to take into account (ADVANCED mode).
Methods
o BeginningPoint
| public virtual void BeginningPoint( | )= 0 |
-
Initializes the iterator of the resulting points of this
CATICGMInclusionPtCrv operator.
By default, the initialization is performed once the operator runs, and
this is therefore only used to read the solutions again.
o GetCurveParam
| public virtual void GetCurveParam( | CATCrvParam& | ioParam) const = 0 |
-
Retrieves the parameter of the next solution point of this CATICGMInclusionPtCrv operator.
- Parameters:
-
- ioParam
- The parameter.
o GetDistance
| public virtual double GetDistance( | )const = 0 |
-
Returns the distance of a solution point and the curve.
- Returns:
- The distance.
o GetNumberOfPoints
| public virtual CATLONG32 GetNumberOfPoints( | )const = 0 |
-
Returns the number of resulting points of this CATICGMInclusionPtCrv operator.
- Returns:
- The number of solutions.
o GetPointOnCurve
-
Creates the next solution point of this CATICGMInclusionPtCrv operator.
- Returns:
- The pointer to the created point on curve. 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 NextPoint
-
Skips to the next solution point of this CATICGMInclusionPtCrv 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 void SetLimits( | const CATCrvLimits& | iNewLimits) = 0 |
-
Modifies the curve domain to take into account (ADVANCED mode).
It does not change the current CATCurve
limitations. The proposed limitations have to be included into the
current limitations.
- Parameters:
-
- iNewLimits
- The new limitations to take into account.
This object is included in the file: CATICGMInclusionPtCrv.h
If needed, your Imakefile.mk should include the module: CATGMModelInterfaces
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.