All Frameworks Class Hierarchy This Framework Next Indexes
NewTopologicalObjects Class CATBoundaryIterator
Mathematics.CATCGMVirtual
|
+---CATBoundaryIterator
Usage: you must use this class as is. You should never derive it.
public class CATBoundaryIterator
Class that defines the iterator on the cells that bound a given cell.
This iterator is often returned by scan methods on the cells.
Constructor and Destructor Index
- o
CATBoundaryIterator()
- Constructs an iterator on the bounding cells.
- o
~CATBoundaryIterator()
-
Method Index
- o
GetElement()
- Returns the cell which bounding cells are asked for.
- o
Next(CATSide*,CATDomain**,short*)
- Skips to the next cell of this iterator.
- o
Next(CATSide*,CATDomain**,short*,CATPCurve**,CATOrientation*,CATCrvParam*,CATCrvParam*)
- Skips to the next bounding cell of a face.
- o
Reset()
- Initializes the iterator at the first cell.
- o
SetElement(CATCell*)
- Defines the cell which boundary are asked for.
Constructor and Destructor
o CATBoundaryIterator
public CATBoundaryIterator( | ) |
-
Constructs an iterator on the bounding cells.
o ~CATBoundaryIterator
public virtual ~CATBoundaryIterator( | ) |
-
Methods
o GetElement
public virtual CATCell* GetElement( | )const = 0 |
-
Returns the cell which bounding cells are asked for.
- Returns:
- The pointer to the cell which boundaries are asked for.
o Next
-
Skips to the next cell of this iterator.
- Parameters:
-
- ioSide
- The pointer to the matter side of the next cell. If NULL in input, this is not output.
- oDomain
- The pointer to the corresponding domain. If NULL in input, this is not output.
- ioNewDomain
- The dectection of the scan of a new domain.
Legal values:
TRUE for the first cell of each new scanned domain, FALSE otherwise.
- Returns:
- The pointer to the next edge, NULL after the last one.
o Next
-
Skips to the next bounding cell of a face.
- Parameters:
-
- ioSide
- The pointer to the matter side of the next edge. If NULL in input, this is not output.
- oDomain
- The pointer to the corresponding domain. If NULL in input, this is not output.
- ioNewDomain
- The dectection of the scan of a new loop.
Legal values:
TRUE for the first edge of each new scanned loop, FALSE otherwise.
- oPCurve
- The pointer to the corresponding CATPCurve. If NULL in input, this is not output.
- oOrientation
- The pointer to the relative orientation of the returned edge with regards to its geometry
oPCurve. If NULL in input, this is not output.
- oStartParam
- A pointer to the low limitation of the returned edge on oPCurve.
- oEndParam
- A pointer to the high limitation of the returned edge on oPCurve.
- Returns:
- The pointer to the next edge, NULL after the last one.
o Reset
public virtual void Reset( | )=0 |
-
Initializes the iterator at the first cell.
This allows you to do multiple iterations around the same cell.
o SetElement
public virtual void SetElement( | CATCell* | iBoundedCell) = 0 |
-
Defines the cell which boundary are asked for.
- Parameters:
-
- iBoundedCell
- The pointer to the cell which boundaries are asked for.
This object is included in the file: CATBoundaryIterator.h
If needed, your Imakefile.mk should include the module: CATTopologicalObjects