All Frameworks Class Hierarchy This Framework Previous Next Indexes
Tessellation Class CATTessPolyIter
CATTessPolyIter
Usage: you must use this class as is. You should never derive it.
public class CATTessPolyIter
Class defining the iterator on the polygons resulting from a Tessellation operator.
Such iterator is directly created by the CATBodyTessellator.GetFace or
CATCellTessellator.GetFace methods. Its deletion is managed at the CATBodyTessellator and CATCellTessellator deletion.
Use it according to the following scheme:
- Retrieve the number of polygons
- Go the next result
- Retrieve the result
- Optionally, reset to begin again.
If the polygon is closed, the first and last point of the polygon are different.
This class also allows you to directly retrieve the results in an array that
you have to allocate and deallocate after use.
Method Index
- o
GetNbPoly(CATLONG32&)
- Returns the number of polygons.
- o
GetPolyAllNuPts(int[],int[])
- Globally retrieves the points ranks for all the polygons.
- o
GetPolyNbPts()
- Returns the number of points of the current polygon.
- o
GetPolyNuPts(CATLONG32[])
- Retrieves the points ranks (as CATLONG32) defining the current polygon.
- o
GetPolyNuPts(int[])
- Retrieves the points ranks (as int) defining the current polygon.
- o
GoToNext()
- Skips to the next polygon.
- o
IsExhausted()
- Tests whether the list is completed.
- o
Reset()
- Resets the iterator to the beginning.
Methods
o GetNbPoly
-
Returns the number of polygons.
- Parameters:
-
- ioNbPtsAll
- The sum of the number of points for the definition of all the polygons.
- Returns:
- The number of polygons.
o GetPolyAllNuPts
public virtual void GetPolyAllNuPts( | int[] | oNbPts, |
| int[] | oNuPts) const |
-
Globally retrieves the points ranks for all the polygons.
- Parameters:
-
- ioNbPts[]
- The array of the number of points for each polygon. The allocation has to be managed by
the caller: use GetNbPoly for its dimension.
- oNuPts[]
- The array of the points ranks. The allocation has to be managed by
the caller: use oNbPtsAll for its dimension.
o GetPolyNbPts
-
Returns the number of points of the current polygon.
- Returns:
- The number of points.
o GetPolyNuPts
public virtual void GetPolyNuPts( | CATLONG32[] | iNuPts) const |
-
Retrieves the points ranks (as CATLONG32) defining the current polygon.
- Parameters:
-
- iNuPts[]
- The array of the points ranks. The allocation has to be managed by
the caller: use GetPolyNbPts for its dimension.
o GetPolyNuPts
public virtual void GetPolyNuPts( | int[] | oNuPts) const |
-
Retrieves the points ranks (as int) defining the current polygon.
- Parameters:
-
- iNuPts[]
- The array of the points ranks. The allocation has to be managed by
the caller: use GetPolyNbPts for its dimension.
o GoToNext
public virtual void GoToNext( | ) |
-
Skips to the next polygon.
o IsExhausted
-
Tests whether the list is completed.
- Returns:
- The result of the test.
Legal values: 1 if the list is completed, 0 otherwise.
o Reset
public virtual void Reset( | ) |
-
Resets the iterator to the beginning.
This object is included in the file: CATTessPolyIter.h
If needed, your Imakefile.mk should include the module: CATTessellation