All Frameworks Class Hierarchy This Framework Previous Next Indexes
GeometricOperators Class CATProjectionCrvSur
Mathematics.CATCGMVirtual
|
+---GeometricObjects.CATCGMOperator
|
+---GeometricOperators.CATGeoOperator
|
+---CATProjectionCrvSur
Usage: you must use this class as is. You should never derive it.
public class CATProjectionCrvSur
Class defining the operator of projection of a CATCurve onto a
CATSurface.
The projection can be orthogonal or directional.
The resulting objects are points or curves.
- The CATProjectionCrvSur 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 curves or surfaces.
- In both cases, the result is accessed with specific interators.
Constructor and Destructor Index
- o
~CATProjectionCrvSur()
- Destructor.
Method Index
- o
BeginningCurve()
- Initializes the iterator of the solution curves of this
CATProjectionCrvSur operator.
- o
BeginningPoint()
- Initializes the iterator of the resulting points.
- o
GetCartesianPoint()
- Creates the next solution point of this CATProjectionCrvSur operator.
- o
GetCurve()
- Creates the next solution curve.
- o
GetDistance()
- Returns the maximum orthogonal distance between the CATCurve and the
CATSurface.
- o
GetLimitsOnCurve(CATCrvLimits&)
- Maps the limitations of the next solution curve on the original curve.
- o
GetLimitsOnCurve(CATCrvParam&,CATCrvParam&)
- Maps the limitations of the next solution curve on the original curve.
- o
GetLimitsOnProjection(CATCrvLimits&)
- Retrieves the limitations of the next resulting curve.
- o
GetLimitsOnProjection(CATCrvParam&,CATCrvParam&)
- Retrieves the limitations of the next resulting curve.
- o
GetLimitsOnSurface(CATSurParam&,CATSurParam&)
- Retrieves the limits of the next resulting curve on the surface.
- o
GetMappingParam(CATCrvParam&,CATCrvParam&)
- Maps a parameter on the curve to project to a parameter on the projection.
- o
GetNumberOfCurves()
- Returns the number of solution curves resulting of this CATProjectionCrvSur operator.
- o
GetNumberOfPoints()
- Returns the number of solution points of this CATProjectionCrvSur operator.
- o
GetPCurve()
- Creates the next solution curve as a curve on surface.
- o
GetPointOnSurface()
- Creates the next solution as a point on surface.
- o
IsComplete()
- Tests whether the curve is entirely projected.
- o
IsCompletelyOnSurface()
- Tests whether the curve is entirely lying on the surfae.
- o
IsPartial()
- Tests whether the curve is partially projected.
- o
IsPartiallyOnSurface()
- Tests whether the curve is partially lying on the surfae.
- o
NextCurve()
- Skips to the next solution curve of this CATProjectionCrvSur operator.
- o
NextPoint()
- Skips to the next solution point of this CATProjectionCrvSur operator.
- o
SetClosestProjection()
- Asks for the closest projection solution (ADVANCED mode).
- o
SetCurve(CATCurve*)
- Asks for the projection of a new CATCurve (ADVANCED mode).
- o
SetCuspCut(CATBoolean)
- Asks for cusp cut setting (ADVANCED mode).
- o
SetLayDown(double)
- Sets the "LayDown" mode.
- o
SetLimits(CATCrvLimits*)
- Modifies the curve domain to take into account for this CATIntersectionCrvSur
operator (ADVANCED mode).
- o
SetLimits(CATSurLimits*)
- Modifies the surface domain to take into account for this CATIntersectionCrvSur
operator (ADVANCED mode).
- o
SetMaximalDistance(double)
- Set the maximal distance between a pint and its projected (ADVANCED mode).
- o
SetNoClosedProjection()
- Asks for the projection solution not closed (ADVANCED mode).
- o
SetSurface(CATSurface*)
- Asks for the projection on a new CATSurface (ADVANCED mode).
- o
UnSetClosestProjection()
- Asks for the all the solutions (ADVANCED mode).
Constructor and Destructor
o ~CATProjectionCrvSur
public virtual ~CATProjectionCrvSur( | ) |
-
Destructor.
Methods
o BeginningCurve
public virtual void BeginningCurve( | )= 0 |
-
Initializes the iterator of the solution curves of this
CATProjectionCrvSur operator.
By default, the initialization is performed once the operator runs,
and this is therefore only used to read the solutions again.
o BeginningPoint
public virtual void BeginningPoint( | )= 0 |
-
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
-
Creates the next solution point of this CATProjectionCrvSur 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 GetCurve
-
Creates the next solution curve.
- Returns:
- The pointer to the created curve. A new curve is created each time this method is called.
If you do not want to keep the created curve, use the
CATICGMContainer.Remove method.
o GetDistance
public virtual double GetDistance( | )= 0 |
-
Returns the maximum orthogonal distance between the CATCurve and the
CATSurface.
- Returns:
- The distance.
o GetLimitsOnCurve
public virtual void GetLimitsOnCurve( | CATCrvLimits& | ioLim) const = 0 |
-
Maps the limitations of the next solution curve on the original curve.
- Parameters:
-
- ioLim
- The corresponding domain on the curve to projact.
o GetLimitsOnCurve
-
Maps the limitations of the next solution curve on the original curve.
- Parameters:
-
- ioStartParam
- The parameter of the first limitation on the curve to project.
- ioEndParam
- The parameter of the first limitation on the curve to project.
o GetLimitsOnProjection
public virtual void GetLimitsOnProjection( | CATCrvLimits& | ioLim) = 0 |
-
Retrieves the limitations of the next resulting curve.
- Parameters:
-
- ioLim
- The domain of the next solution curve.
o GetLimitsOnProjection
-
Retrieves the limitations of the next resulting curve.
- Parameters:
-
- ioStartParam
- The parameter on the projection of the first limitation of the solution.
- ioEndParam
- The parameter on the projection of the last limitation of the solution.
o GetLimitsOnSurface
-
Retrieves the limits of the next resulting curve on the surface.
- Parameters:
-
- ioFirstParam
- The surface parameter of the first limitation of the solution.
- ioLastParam
- The surface parameter of the last limitation of the solution.
o GetMappingParam
-
Maps a parameter on the curve to project to a parameter on the projection.
The PCurve must be previously created.
- Parameters:
-
- iCrvParam
- The parameter on the curve to project.
- ioProjParam
- The corresponding parameter on the projection.
o GetNumberOfCurves
public virtual CATLONG32 GetNumberOfCurves( | )const = 0 |
-
Returns the number of solution curves resulting of this CATProjectionCrvSur operator.
- Returns:
- The number of curves.
o GetNumberOfPoints
public virtual CATLONG32 GetNumberOfPoints( | )const = 0 |
-
Returns the number of solution points of this CATProjectionCrvSur operator.
- Returns:
- The number of points.
o GetPCurve
-
Creates the next solution curve as a curve on surface.
- Returns:
- The pointer to the created curve on surface. A new curve is created each time this method is called.
If you do not want to keep the created curve, use the
CATICGMContainer.Remove method.
o 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 IsComplete
-
Tests whether the curve is entirely projected.
- Returns:
- The result of the test.
Legal values: TRUE if it is entirely projected, FALSE otherwise.
o IsCompletelyOnSurface
public virtual CATBoolean IsCompletelyOnSurface( | )= 0 |
-
Tests whether the curve is entirely lying on the surfae.
- Returns:
- The result of the test.
Legal values: TRUE if it is entirely laying, FALSE otherwise.
o IsPartial
-
Tests whether the curve is partially projected.
- Returns:
- The result of the test.
Legal values: TRUE if it is partially projected, FALSE otherwise.
o IsPartiallyOnSurface
public virtual CATBoolean IsPartiallyOnSurface( | )= 0 |
-
Tests whether the curve is partially lying on the surfae.
- Returns:
- The result of the test.
Legal values: TRUE if it is partially laying, FALSE otherwise.
o NextCurve
-
Skips to the next solution curve of this CATProjectionCrvSur operator.
After BeginningCurve, it skips to the first curve.
- Returns:
- The existence of the next solution.
Legal values:
- TRUE
- if there is a solution point
- FALSE
- no more solution point.
o NextPoint
-
Skips to the next solution point of this CATProjectionCrvSur 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 SetClosestProjection
public virtual void SetClosestProjection( | )= 0 |
-
Asks for the closest projection solution (ADVANCED mode).
The operator only outputs the closest projection.
o SetCurve
public virtual void SetCurve( | CATCurve* | iNewCurveToProject) = 0 |
-
Asks for the projection of a new CATCurve (ADVANCED mode).
- Parameters:
-
- iNewCurveToProject
- The pointer to the new curve.
o SetCuspCut
public virtual void SetCuspCut( | CATBoolean | iBool) = 0 |
-
Asks for cusp cut setting (ADVANCED mode).
- Parameters:
-
- iBool
-
Legal values: TRUE if operator cuts solution on cusp points, FALSE otherwise.
o SetLayDown
public virtual void SetLayDown( | double | iLayDownDistance) = 0 |
-
Sets the "LayDown" mode. In "LayDown" mode, the operator returns a projection result
only if the distance between each point of the curve and its projection
is smaller than iLayDownDistance.
This API can only be used in ADVANCED mode and is available only in
normal projections.
o SetLimits
-
Modifies the curve domain to take into account for this CATIntersectionCrvSur
operator (ADVANCED mode).
It does not change the current curve
limitations.
- Parameters:
-
- iNewCurveLimits
- The new limitations of the curve, NULL to take the current limitations.
o SetLimits
public virtual void SetLimits( | CATSurLimits* | iNewSurfaceLimits) = 0 |
-
Modifies the surface domain to take into account for this CATIntersectionCrvSur
operator (ADVANCED mode).
It does not change the current surface
limitations.
- Parameters:
-
- iNewSurfaceLimits
- The new limitations of the surface, NULL to take the current limitations.
o SetMaximalDistance
public virtual void SetMaximalDistance( | double | MaxDist) = 0 |
-
Set the maximal distance between a pint and its projected (ADVANCED mode).
The operator only outputs the projection under the distance.
o SetNoClosedProjection
public virtual void SetNoClosedProjection( | )= 0 |
-
Asks for the projection solution not closed (ADVANCED mode).
The operator only outputs projection not closed.
o SetSurface
public virtual void SetSurface( | CATSurface* | iOnNewSurface) = 0 |
-
Asks for the projection on a new CATSurface (ADVANCED mode).
- Parameters:
-
- iOnNewSurface
- The pointer to the new surface.
o UnSetClosestProjection
public virtual void UnSetClosestProjection( | )= 0 |
-
Asks for the all the solutions (ADVANCED mode).
To call after a Run with SetClosestProjection.
This object is included in the file: CATProjectionCrvSur.h
If needed, your Imakefile.mk should include the module: CATGeometricOperators