GMOperatorsInterfaces CATHLRBodyInstanceIterator
Usage: you must use this class as is. You should never derive it.
public class CATHLRBodyInstanceIterator
Class defining an iterator over the input body instances used by the CATICGMHLROperator operator.
This iterator can only be accessed via a CATHLRResult object.
It provides result information for each body instance and gives access
to the CATHLRBodySubEdgeIterator iterator.
- See also:
- , ,
Method Index
- o
Begin()
- Sets the iterator to the beginning.
- o
End()
- Notifies if the iterator has reached the end.
- o
GetBody()
- Returns the body pointer of the current body instance.
- o
GetID()
- Returns the ID of the current body instance.
- o
GetSubEdgeIterator()
- Returns the iterator to get the HLR subdivision applied on the edges of the current Body instance
- o
GetTransformation()
- Returns the transformation associated with the current body instance.
- o
HasFailed()
- Notifies if the HLR calculation for the current body instance failed.
- o
IsFullyOccluded(CATULONG32&)
- Returns the full occlusion status for the current body instance.
- o
operator++()
- Increments the iterator.
Methods
o Begin
-
Sets the iterator to the beginning.
o End
-
Notifies if the iterator has reached the end.
- Returns:
- TRUE if the iterator has reached the end, FALSE otherwise.
o GetBody
-
Returns the body pointer of the current body instance.
- Returns:
- A CATBody object.
o GetID
-
Returns the ID of the current body instance.
- Returns:
- A CATULONG32 integer ID.
o GetSubEdgeIterator
| public virtual GetSubEdgeIterator( | ) |
-
Returns the iterator to get the HLR subdivision applied on the edges of the current Body instance
- Returns:
- a reference on the CATHLRBodySubEdgeIterator instance
This iterator instance is owned by the CATHLRBodyInstanceIterator which will release it.
This iterator can be get only once and its content depends automatically on the master CATHLRBodyInstanceIterator current status
o GetTransformation
| public virtual GetTransformation( | ) |
-
Returns the transformation associated with the current body instance.
- Returns:
- A CATMathTransformation object.
o HasFailed
| public virtual HasFailed( | ) |
-
Notifies if the HLR calculation for the current body instance failed.
- Returns:
- TRUE if the HLR calculation failed, FALSE otherwise.
o IsFullyOccluded
| public virtual IsFullyOccluded( | | oOccludingInstanceID) |
-
Returns the full occlusion status for the current body instance.
This situation might happen if two instances of the same body, each with a different transformation, are positioned
so that one is exactly placed in front of the other from the observer point of view.
- Returns:
- TRUE if the current body instance is fully occluded, FALSE otherwise.
o operator++
| public virtual operator++( | ) |
-
Increments the iterator.
This object is included in the file: CATHLRBodyInstanceIterator.h
If needed, your Imakefile.mk should include the module: CATGMOperatorsInterfaces
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.