All Frameworks Class Hierarchy This Framework Indexes
GeometricOperators Class CATProjectionPtCrv
Usage: you must use this class as is. You should never derive it.
public class CATProjectionPtCrv
Class defining the operator of projection of a CATPoint onto a
CATCurve.
The projection can be orthogonal or directional.
The resulting objects are points.
- The CATProjectionPtCrv operator is created with the CreateProjection 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 a specific interator.
Constructor and Destructor Index
- o
~CATProjectionPtCrv()
- Destructor.
Method Index
- o
BeginningPoint()
- Initializes the iterator of the resulting points.
- o
GetCartesianPoint()
- Creates the next solution point of this CATProjectionPtCrv operator.
- o
GetDistance()
- Returns the maximum orthogonal distance between the CATCurve and the
CATPoint.
- o
GetNumberOfPoints()
- Returns the number of solution points of this CATProjectionPtCrv operator.
- o
GetParam()
- Returns the parameter on the curve of the next solution point of this CATProjectionPtCrv operator.
- o
GetPointOnCurve()
- Creates the next solution as a point on curve of this CATProjectionPtCrv operator.
- o
NextPoint()
- Skips to the next solution point of this CATProjectionPtCrv operator.
- o
SetLimits(CATCrvLimits&)
- Modifies the curve domain to take into account for this CATIntersectionCrvSur
operator (ADVANCED mode).
- o
SetPoint(CATMathPoint&)
- Defines a new point to project (ADVANCED mode).
Constructor and Destructor
o ~CATProjectionPtCrv
| public virtual ~CATProjectionPtCrv( | ) |
-
Destructor.
Methods
o BeginningPoint
| public virtual BeginningPoint( | ) |
-
Initializes the iterator of the resulting points.
By default, the initialization is performed once the operator runs,
and this is therefore only used to read the solutions again.
o GetCartesianPoint
| public virtual GetCartesianPoint( | ) |
-
Creates the next solution point of this CATProjectionPtCrv operator.
- 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 GetDistance
| public virtual GetDistance( | ) |
-
Returns the maximum orthogonal distance between the CATCurve and the
CATPoint.
- Returns:
- The distance.
o GetNumberOfPoints
| public virtual GetNumberOfPoints( | ) |
-
Returns the number of solution points of this CATProjectionPtCrv operator.
- Returns:
- The number of solution points.
o GetParam
| public virtual GetParam( | ) |
-
Returns the parameter on the curve of the next solution point of this CATProjectionPtCrv operator.
- Returns:
- The parameter.
o GetPointOnCurve
| public virtual GetPointOnCurve( | ) |
-
Creates the next solution as a point on curve of this CATProjectionPtCrv 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
| public virtual NextPoint( | ) |
-
Skips to the next solution point of this CATProjectionPtCrv operator.
After BeginningPoint, it skips to the first point.
- 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 | iLimits) |
-
Modifies the curve domain to take into account for this CATIntersectionCrvSur
operator (ADVANCED mode).
It does not change the current curve
limitations.
- Parameters:
-
- iNewLimits
- The new limitations of the curve.
o SetPoint
| public virtual SetPoint( | const | iPoint) |
-
Defines a new point to project (ADVANCED mode).
- Parameters:
-
- iPoint
- The new point.
This object is included in the file: CATProjectionPtCrv.h
If needed, your Imakefile.mk should include the module: CATGeometricOperators