All Frameworks Class Hierarchy This Framework Indexes
GeometricOperators Class CATProjectionPtSur
Usage: you must use this class as is. You should never derive it.
public class CATProjectionPtSur
Class defining the operator of projection of a CATPoint onto a
CATSurface.
The projection can be orthogonal or directional.
The resulting objects are points.
- The CATProjectionPtSur operator is created with the CATCreateProjection 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. Note
that the resulting projection depends on the limitations specified. For example,
the operator may find no projection when using the current limitations while it may return
a projection when using the maximum limitations.
Constructor and Destructor Index
- o
~CATProjectionPtSur()
- Destructor.
Method Index
- o
BeginningPoint()
- Initializes the iterator of the resulting points.
- o
GetCartesianPoint()
- Creates the next solution point of this CATProjectionPtSur operator.
- o
GetDistance()
- Returns the distance between the CATPoint and its Projection on the CATSurface.
- o
GetNumberOfPoints()
- Returns the number of solution points of this CATProjectionPtSur operator.
- o
GetParam()
- Returns the parameter on the surface of the next solution point of this CATProjectionPtSur operator.
- o
GetPointOnSurface()
- Creates the next solution as a point on surface.
- o
NextPoint()
- Skips to the next solution point of this CATProjectionPtSur operator.
- o
SetPoint(CATMathPoint&)
- Defines a new point to project (ADVANCED mode).
- o
UseLimits(CATSurLimits*)
- Modifies the surface domain to be taken into account for this CATProjectionPtSur
operator (ADVANCED mode).
Constructor and Destructor
o ~CATProjectionPtSur
| public virtual ~CATProjectionPtSur( | ) |
-
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 CATProjectionPtSur 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 distance between the CATPoint and its Projection on the CATSurface.
- Returns:
- The distance.
o GetNumberOfPoints
| public virtual GetNumberOfPoints( | ) |
-
Returns the number of solution points of this CATProjectionPtSur operator.
- Returns:
- The number of solution points.
WARNING: the operator may find no projection when using the current limitations while it may return
a projection when using the maximum limitations. Therefore, when using the ADVANCED mode, it is recommended
to specify the max limits of the surface by using the UseLimits method.
o GetParam
| public virtual GetParam( | ) |
-
Returns the parameter on the surface of the next solution point of this CATProjectionPtSur operator.
- Returns:
- The parameter.
o GetPointOnSurface
| public virtual GetPointOnSurface( | ) |
-
Creates the next solution as a point on surface.
- 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 CATProjectionPtSur 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 SetPoint
| public virtual SetPoint( | const | iPoint) |
-
Defines a new point to project (ADVANCED mode).
- Parameters:
-
- iPoint
- The new point.
o UseLimits
| public virtual UseLimits( | | iLimitsToTakeForSurface) |
-
Modifies the surface domain to be taken into account for this CATProjectionPtSur
operator (ADVANCED mode).
It does not change the current surface
limitations.
- Parameters:
-
- iNewLimits
- The new limitations of the surface, NULL to take the current limitations. Note
that the resulting projection depends on the limitations specified. For example,
the operator may find no projection when using the current limitations while it may return
a projection when using the maximum limitations.
This object is included in the file: CATProjectionPtSur.h
If needed, your Imakefile.mk should include the module: CATGeometricOperators