All Frameworks Class Hierarchy This Framework Previous Next Indexes
GeometricOperators Class CATInclusionPtSur
Mathematics.CATCGMVirtual
|
+---GeometricObjects.CATCGMOperator
|
+---GeometricOperators.CATGeoOperator
|
+---CATInclusionPtSur
Usage: you must use this class as is. You should never derive it.
public class CATInclusionPtSur
Class defining the operator for testing the inclusion of a point
in a surface.
The inclusion is tested within a given tolerance. The operator gets all
the points closed enough (at the tolerance) to the surface, 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
CATDistanceMinPtSur operator, that only outputs one point realizing
the minimum distance without tolerance.
- The CATInclusionPtSur operator is created with the CreateInclusion 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
~CATInclusionPtSur()
- Destructor.
Method Index
- o
BeginningPoint()
- Initializes the iterator of the resulting points of this
CATInclusionPtSur operator.
- o
GetDistance()
- Returns the distance of a solution point and the surface.
- o
GetNumberOfPoints()
- Returns the number of resulting points of this CATInclusionPtCrv operator.
- o
GetPointOnSurface()
- Creates the next solution point of this CATInclusionPtSur operator.
- o
GetSignature()
- Returns the signature of the solution point.
- o
GetSurParam()
- Retrieves the parameter of the next solution point of this CATInclusionPtSur operator.
- o
NextPoint()
- Skips to the next solution point of this CATInclusionPtSur operator.
- o
SetLimits(CATSurLimits&)
- Defines the curve new limitations to take into account for this operator in
ADVANCED mode.
- o
SetPoint(CATMathPoint&)
- Sets a new point for this operator (ADVANCED mode).
- o
SetPoint(CATPoint*)
- Sets a new point for this operator (ADVANCED mode).
Constructor and Destructor
o ~CATInclusionPtSur
public virtual ~CATInclusionPtSur( | ) |
-
Destructor.
Methods
o BeginningPoint
public virtual void BeginningPoint( | )=0 |
-
Initializes the iterator of the resulting points of this
CATInclusionPtSur operator.
By default, the initialization is performed once the operator runs,
and this is therefore only used to read the solutions again.
o GetDistance
public virtual double GetDistance( | )const=0 |
-
Returns the distance of a solution point and the surface.
- Returns:
- The distance.
o GetNumberOfPoints
public virtual CATLONG32 GetNumberOfPoints( | )const=0 |
-
Returns the number of resulting points of this CATInclusionPtCrv operator.
- Returns:
- The number of solutions.
o GetPointOnSurface
-
Creates the next solution point of this CATInclusionPtSur operator.
- Returns:
- The pointer to the created point on surface. 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 GetSignature
public virtual CATLONG32 GetSignature( | )const = 0 |
-
Returns the signature of the solution point.
- Returns:
- The signature.
Legal values:
- 0
- if the point is on the surface
- -1 of 1
- according to the sign of the
dot product : (Point-Projection(Point))*NormalToSurface(Projection(Point)).
o GetSurParam
-
Retrieves the parameter of the next solution point of this CATInclusionPtSur operator.
- Returns:
- The parameter.
o NextPoint
-
Skips to the next solution point of this CATInclusionPtSur 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 CATSurLimits& | iNewLimits) = 0 |
-
Defines the curve new limitations to take into account for this operator in
ADVANCED mode.
- Parameters:
-
- iNewLimits
- The new limitations on the curve.
o SetPoint
-
Sets a new point for this operator (ADVANCED mode).
- Parameters:
-
- iMathPt
- The new point to take into account.
o SetPoint
public virtual void SetPoint( | CATPoint* | iPt) = 0 |
-
Sets a new point for this operator (ADVANCED mode).
- Parameters:
-
- iPt
- The pointer to the new point to take into account.
This object is included in the file: CATInclusionPtSur.h