GMModelInterfaces Interface CATICGMDistanceMinPtSur
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICGMDistanceMinPtSur
Class defining the operator of the minimum distance between
a point and a surface.
- The CATICGMDistanceMinPtSur operator is created with the CATCGMCreateDistanceMin 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 points.
- In both cases, the result is accessed with specific methods.
Method Index
- o
GetDiagnostic()
- In the case of SetPointAndInit usage, the algorithm is limited to a maximum number of iterations.
- o
GetDistance()
- Returns the minimum distance between a surface and a point.
- o
GetPointOnSurface()
- Creates a CATPointOnSurface realizing the minimum distance
between a surface and a point.
- o
GetSurParam()
- Returns the parameter of a point realizing the minimum distance
between a surface and a point.
- o
IsASolution()
- Tests whether a solution exists in case of an
excluded boundary seach (iSearchOnBoundary=FALSE).
- o
SetLimits(CATSurLimits&)
- Defines the new domain of the surface to take into account for this operator
(ADVANCED mode).
- o
SetPoint(CATPoint*)
- Sets a new point from which the distance to the same surface is evaluated
(ADVANCED mode).
- o
SetPoint(CATMathPoint&)
- Sets a new point from which the distance to the same surface is evaluated
(ADVANCED mode).
- o
SetPointAndInit(CATPoint*,CATSurParam&)
- Sets a new point and an initialization
(ADVANCED mode).
- o
SetPointAndInit(CATMathPoint&,CATSurParam&)
- Sets a new point and an initialization
(ADVANCED mode).
- o
SetSearchOnBoundary(CATBoolean)
- Defines whether the boundaries are taken into account or not (ADVANCED mode).
Methods
o GetDiagnostic
| public virtual GetDiagnostic( | ) |
-
In the case of SetPointAndInit usage, the algorithm is limited to a maximum number of iterations.
If a maximum number of iterations is reached, the returned point is not fully reconverged but
can be used as a new init, using the SetPointAndInit method.
- Returns:
- The diagnostic (CATMathOK or CATMathMaxIteration)
o GetDistance
| public virtual GetDistance( | ) |
-
Returns the minimum distance between a surface and a point.
- Returns:
- The distance.
o GetPointOnSurface
| public virtual GetPointOnSurface( | ) |
-
Creates a CATPointOnSurface realizing the minimum distance
between a surface and a point.
Note that only one point is proposed, even multiple solutions exist.
- 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
method.
o GetSurParam
| public virtual GetSurParam( | ) |
-
Returns the parameter of a point realizing the minimum distance
between a surface and a point.
Note that only one point is proposed, even multiple solutions exist.
- Returns:
- The parameter on the surface.
o IsASolution
| public virtual IsASolution( | ) |
-
Tests whether a solution exists in case of an
excluded boundary seach (iSearchOnBoundary=FALSE).
To use after the run.
- Returns:
- The result of the test.
- TRUE
- the solution exists inside the surface,
(with excluded boundary).
- FALSE
- the solution exists only on the surface
boundary.
o SetLimits
| public virtual SetLimits( | const | iLimits) |
-
Defines the new domain of the surface to take into account for this operator
(ADVANCED mode).
- Parameters:
-
- iLimits
- The limitations on the surface.
o SetPoint
| public virtual SetPoint( | | iNewPointToOperate) |
-
Sets a new point from which the distance to the same surface is evaluated
(ADVANCED mode).
- Parameters:
-
- iNewPointToOperate
- The pointer to the new point to take into account.
o SetPoint
| public virtual SetPoint( | | iNewMathPointToOperate) |
-
Sets a new point from which the distance to the same surface is evaluated
(ADVANCED mode).
- Parameters:
-
- iNewMathPointToOperate
- The new point to take into account.
o SetPointAndInit
| public virtual SetPointAndInit( | | iNewPointToOperate, |
| const | iSolutionInit) |
-
Sets a new point and an initialization
(ADVANCED mode).
This is usefull for computing the distance to a new point near a another one, whose CATSurParam
solution is already known.
- Parameters:
-
- iNewPointToOperate
- The pointer to the new point to take into account.
- iSolutionInit
- The parameter of a point close from the solution.
o SetPointAndInit
| public virtual SetPointAndInit( | | iNewPointToOperate, |
| const | iSolutionInit) |
-
Sets a new point and an initialization
(ADVANCED mode).
This is usefull for computing the distance to a new point near a another one, whose CATSurParam
solution is already known.
- Parameters:
-
- iMathNewPointToOperate
- The new point to take into account.
- iSolutionInit
- The parameter of a point close from the solution.
o SetSearchOnBoundary
| public virtual SetSearchOnBoundary( | | iSearchOnBoundary) |
-
Defines whether the boundaries are taken into account or not (ADVANCED mode).
- Parameters:
-
- iSearchMode
- The type of search.
Legal values:
- FALSE
- the operator is equivalent to an orthogonal
projection which realizes the minimum distance.
- TRUE
- the operator always return a solution realizing minimum
distance even if it is not a projection.
This object is included in the file: CATICGMDistanceMinPtSur.h
If needed, your Imakefile.mk should include the module: CATGMModelInterfaces
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.