GMOperatorsInterfaces Interface CATICGMDistanceBodyBody
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICGMDistanceBodyBody
Class defining an operator that computes the distance between two bodies, two groups of bodies
or two groups of cells in the same or different bodies.
- A CATICGMDistanceBodyBody operator is created with the CATCGMCreateDistanceBodyBodyOp global function.
- It is the user's responsibility to release the operator after it has been used.
- The results are retrieved by the Get methods.
Method Index
- o
GetDistance()
- Returns the distance between two bodies.
- o
GetPoints(CATPoint*&,CATPoint*&)
- Returns the CATPoint objects representing the locations of closest approach on each body.
- o
GetPoints(CATMathPoint&,CATMathPoint&)
- Returns the CATMathPoint positions representing the locations of closest approach on each body.
- o
GetReferencePoint(CATMathPoint&)
- Returns the reference point.
- o
GetSupportCells(CATCell*&,CATCell*&)
- Returns the CATCell objects on which the closest point for each body is found.
- o
SetDistanceMax(double)
- Defines an upper bound of the distance between the two bodies.
- o
SetReferencePoint(CATMathPoint&)
- Sets the reference point.
Methods
o GetDistance
| public virtual GetDistance( | ) |
-
Returns the distance between two bodies.
- Returns:
- The distance.
o GetPoints
| public virtual GetPoints( | | oPoint1, |
| | oPoint2) |
-
Returns the CATPoint objects representing the locations of closest approach on each body.
The points, once returned, are owned by the caller.
- Parameters:
-
- oPoint1
- The closest point on the first body.
- oPoint2
- The closest point on the second body.
o GetPoints
| public virtual GetPoints( | | oPoint1, |
| | oPoint2) |
-
Returns the CATMathPoint positions representing the locations of closest approach on each body.
- Parameters:
-
- oPoint1
- The closest point on the first body.
- oPoint2
- The closest point on the second body.
o GetReferencePoint
| public virtual GetReferencePoint( | | oRefPoint) |
-
Returns the reference point.
- Parameters:
-
- oRefPoint
- The reference point.
o GetSupportCells
| public virtual GetSupportCells( | | oCell1, |
| | oCell2) |
-
Returns the CATCell objects on which the closest point for each body is found.
- Parameters:
-
- oCell1
- The support cell on the first body.
- oCell2
- The support cell on the second body.
o SetDistanceMax
| public virtual SetDistanceMax( | | iDistanceMax) |
-
Defines an upper bound of the distance between the two bodies.
If known, this can be used to optimize the performance of the computation.
- Parameters:
-
- iDistanceMax
- The value of the upper bound.
o SetReferencePoint
| public virtual SetReferencePoint( | const | iRefPoint) |
-
Sets the reference point.
The reference point is used to specify the nearest solution when there are multiple solutions.
If not set, position (0,0,0) will be used instead.
- Parameters:
-
- iRefPoint
- The reference point.
This object is included in the file: CATICGMDistanceBodyBody.h
If needed, your Imakefile.mk should include the module: CATGMOperatorsInterfaces
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.