Mathematics CATMathGridOfPoints
Usage: you must use this class as is. You should never derive it.
public class CATMathGridOfPoints
Class representing a bi-dimensionnal grid of CATMathPoints.
The size is defined by a number of rows NbRows and a
number of columns NbColumns. The index of the fisrt
CATMathPoints are (0,0).
The SetNumberOfPoints method enlarges the memory if
needed, while the Compress inherited method releases the free
unused memory.
Constructor and Destructor Index
- o
CATMathGridOfPoints()
- Constructs an empty CATMathGridOfPoints with 0 row and 0 column.
- o
CATMathGridOfPoints(CATLONG32,CATLONG32)
-
- o
CATMathGridOfPoints(CATMathGridOfPoints&)
- Copy constructor.
- o
CATMathGridOfPoints(CATLONG32,CATLONG32,CATMathPoint[])
-
- o
CATMathGridOfPoints(CATMathSetOfPoints&,CATLONG32,CATLONG32)
-
- o
CATMathGridOfPoints(CATMathGridOfPoints&,CATLONG32,CATLONG32,CATLONG32,CATLONG32)
-
- o
~CATMathGridOfPoints()
- Destructor
Method Index
- o
ApplyTransformation(CATMathTransformation&)
- Transforms the CATMathPoints of this CATMathGridOfPoints.
- o
DistanceTo(CATMathPoint&,CATLONG32&,CATLONG32&)
- Returns the distance between a CATMathPoint and
a point of this CATMathGridOfPoints.
- o
DistanceTo(CATMathSetOfPoints*,CATLONG32&,CATLONG32&,CATLONG32&)
- Returns the distance between a point of a CATMathSetOfPoints and
a point of this CATMathGridOfPoints.
- o
DistanceTo(CATMathGridOfPoints*,CATLONG32&,CATLONG32&,CATLONG32&,CATLONG32&)
- Returns the distance between
a point of this CATMathGridOfPoints and
a point of another CATMathGridOfPoints.
- o
GetOnePoint(CATLONG32,CATLONG32,CATMathPoint&)
- Retrieves the CATMathPoint locating at a given row and column.
- o
GetPoint(CATLONG32,CATLONG32)
-
- o
GetPoint(CATLONG32,CATLONG32,CATMathPoint&)
-
- o
GetPoints()
- Returns the array of CATMathPoints sorted row by row.
- o
Set(CATLONG32,CATLONG32,CATMathPoint[])
- Modifies a CATMAthGridOfPoints from an array of CATMathPoints, assuming it is ordered row
after row.
- o
Set(CATMathSetOfPoints&,CATLONG32,CATLONG32)
- Modifies a CATMAthGridOfPoints from a CATMathSetOfPoints, assuming it is ordered column
after column.
- o
Set(CATMathGridOfPoints&,CATLONG32,CATLONG32,CATLONG32,CATLONG32)
- Modifies a CATMAthGridOfPoints by extracting a smaller grid from another one.
- o
SetOnePoint(CATMathPoint&,CATLONG32,CATLONG32)
-
- o
SetPoint(CATMathPoint&,CATLONG32,CATLONG32)
-
- o
SquareDistanceTo(CATMathPoint&,CATLONG32&,CATLONG32&)
- Returns the square distance between a CATMathPoint and
a point of this CATMathGridOfPoints.
- o
SquareDistanceTo(CATMathSetOfPoints*,CATLONG32&,CATLONG32&,CATLONG32&)
- Returns the square distance between a point of a CATMathSetOfPoints and
a point of this CATMathGridOfPoints.
- o
SquareDistanceTo(CATMathGridOfPoints*,CATLONG32&,CATLONG32&,CATLONG32&,CATLONG32&)
- Returns the square distance between
a point of this CATMathGridOfPoints and
a point of another CATMathGridOfPoints.
Constructor and Destructor
o CATMathGridOfPoints
| public CATMathGridOfPoints( | ) |
-
Constructs an empty CATMathGridOfPoints with 0 row and 0 column.
o CATMathGridOfPoints
| public CATMathGridOfPoints( | | iNbRows, |
| | iNbColumns) |
-
- Deprecated:
- V5R20 SetNumberOfGridElements
Constructs a CATMathGridOfPoints of a given size.
The memory is allocated, but the values of the points are not initialized.
Use SetPoint to initialize them.
o CATMathGridOfPoints
| public CATMathGridOfPoints( | const | iGridToCopy) |
-
Copy constructor.
o CATMathGridOfPoints
| public CATMathGridOfPoints( | | iNbRows, |
| | iNbColumns, |
| const | iArrayPoint) |
-
- Deprecated:
- V5R20 Set
Constructs from an array of CATMathPoints, assuming it is ordered row
after row.
o CATMathGridOfPoints
| public CATMathGridOfPoints( | const | iSourceSet, |
| | iNbRows, |
| | iNbColumns) |
-
- Deprecated:
- V5R20 Set
Constructs from a CATMathSetOfPoints, assuming it is ordered column
after column.
o CATMathGridOfPoints
| public CATMathGridOfPoints( | const | iSourceGrid, |
| | iStartRow, |
| | iEndRow, |
| | iStartColumn, |
| | iEndColumn) |
-
- Deprecated:
- V5R20 Set
Constructs by extracting a smaller grid from another one.
o ~CATMathGridOfPoints
| public virtual ~CATMathGridOfPoints( | ) |
-
Destructor
Methods
o ApplyTransformation
| public virtual ApplyTransformation( | const | iTransfo) |
-
Transforms the CATMathPoints of this CATMathGridOfPoints.
o DistanceTo
| public DistanceTo( | const | iP, |
| | iRow, |
| | iColumn) |
-
Returns the distance between a CATMathPoint and
a point of this CATMathGridOfPoints.
- Parameters:
-
- iP
- The point to which the distance is computed.
- iRow
- The row (beginning at 0) of the point of this
to which the distance is computed.
- iColumn
- The column (beginning at 0) of the point of this
to which the distance is computed.
o DistanceTo
| public DistanceTo( | const | iSetOfPoints2, |
| | iRow1, |
| | iColumn1, |
| | iIndex2) |
-
Returns the distance between a point of a CATMathSetOfPoints and
a point of this CATMathGridOfPoints.
- Parameters:
-
- iSetOfPoints2
- The set of points which the second point belongs to.
- iRow1
- The row (beginning at 0) of the point of this
to which the distance is computed.
- iColumn1
- The column (beginning at 0) of the point of this
to which the distance is computed.
- iIndex2
- The index (beginning at 0) of the second point in its set to which
the distance is computed.
o DistanceTo
| public DistanceTo( | const | iGridOfPoints2, |
| | iRow1, |
| | iColumn1, |
| | iRow2, |
| | Column2) |
-
Returns the distance between
a point of this CATMathGridOfPoints and
a point of another CATMathGridOfPoints.
- Parameters:
-
- iGridOfPoints2
- The other grid of points which the second point belongs to.
- iRow1
- The row (beginning at 0) of the point of this
to which the distance is computed.
- iColumn1
- The column (beginning at 0) of the point of this
to which the distance is computed.
- iRow2
- The row (beginning at 0) of the point of the second grid of points
to which the distance is computed.
- iColumn2
- The column (beginning at 0) of the point of the second grid of points
to which the distance is computed.
o GetOnePoint
| public GetOnePoint( | | iRow, |
| | iColumn, |
| | ioPoint) |
-
Retrieves the CATMathPoint locating at a given row and column.
The indexes iRow and iColumn start at 0.
- Returns:
- E_FAIL if the given indexes are inconsistent, S_OK otherwise.
o GetPoint
| public GetPoint( | | iRow, |
| | iColumn) |
-
- Deprecated:
- V5R20 GetOnePoint
Returns the CATMathPoint locating at a given row and column.
The indexes iRow and iColumn start at 0.
Use preferently the second method signature if you want to avoid an
useless constructor.
o GetPoint
| public GetPoint( | | iRow, |
| | iColumn, |
| | ioPoint) |
-
- Deprecated:
- V5R20 GetOnePoint
Retrieves the CATMathPoint locating at a given row and column.
The indexes iRow and iColumn start at 0.
o GetPoints
-
Returns the array of CATMathPoints sorted row by row.
A CATMathPoint at the (iRow,iColumn) location is accessed
using the formula iRow*NbRows+iColumn in the returned array.
Note that the returned array is used by the CATMathGridOfPoints and
must not be deleted.
o Set
| public Set( | | iNbRows, |
| | iNbColumns, |
| const | iArrayPoint) |
-
Modifies a CATMAthGridOfPoints from an array of CATMathPoints, assuming it is ordered row
after row.
- Returns:
- E_FAIL if the given indexes are inconsistent, S_OK otherwise.
o Set
| public Set( | const | iSourceSet, |
| | iNbRows, |
| | iNbColumns) |
-
Modifies a CATMAthGridOfPoints from a CATMathSetOfPoints, assuming it is ordered column
after column.
- Returns:
- E_FAIL if the given indexes are inconsistent, S_OK otherwise.
o Set
| public Set( | const | iSourceGrid, |
| | iStartRow, |
| | iEndRow, |
| | iStartColumn, |
| | iEndColumn) |
-
Modifies a CATMAthGridOfPoints by extracting a smaller grid from another one.
- Returns:
- E_FAIL if the given indexes are inconsistent, S_OK otherwise.
o SetOnePoint
| public SetOnePoint( | const | iPoint, |
| | iRow, |
| | iColumn) |
-
o SetPoint
| public SetPoint( | const | iPoint, |
| | iRow, |
| | iColumn) |
-
- Deprecated:
- V5R20 SetOnePoint
Initializes the values of a CATMathPoint in this CATMathGridOfPoints.
The indexes iRow and iColumn start at 0.
o SquareDistanceTo
| public SquareDistanceTo( | const | iP, |
| | iRow, |
| | iColumn) |
-
Returns the square distance between a CATMathPoint and
a point of this CATMathGridOfPoints.
- Parameters:
-
- iP
- The point to which the distance is computed.
- iRow
- The row (beginning at 0) of the point of this
to which the distance is computed.
- iColumn
- The column (beginning at 0) of the point of this
to which the distance is computed.
o SquareDistanceTo
| public SquareDistanceTo( | const | iSetOfPointst2, |
| | iRow1, |
| | iColumn1, |
| | iIndex2) |
-
Returns the square distance between a point of a CATMathSetOfPoints and
a point of this CATMathGridOfPoints.
- Parameters:
-
- iSetOfPoints2
- The set of points which the second point belongs to.
- iRow1
- The row (beginning at 0) of the point of this
to which the distance is computed.
- iColumn1
- The column (beginning at 0) of the point of this
to which the distance is computed.
- iIndex2
- The index (beginning at 0) of the second point in its set to which
the distance is computed.
o SquareDistanceTo
| public SquareDistanceTo( | const | iGridOfPoints2, |
| | iRow1, |
| | iColumn1, |
| | iRow2, |
| | iColumn2) |
-
Returns the square distance between
a point of this CATMathGridOfPoints and
a point of another CATMathGridOfPoints.
- Parameters:
-
- iGridOfPoints2
- The other grid of points which the second point belongs to.
- iRow1
- The row (beginning at 0) of the point of this
to which the distance is computed.
- iColumn1
- The column (beginning at 0) of the point of this
to which the distance is computed.
- iRow2
- The row (beginning at 0) of the point of the second grid of points
to which the distance is computed.
- iColumn2
- The column (beginning at 0) of the point of the second grid of points
to which the distance is computed.
This object is included in the file: CATMathGridOfPoints.h
If needed, your Imakefile.mk should include the module: CATMathematics
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.