CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

csShadowIterator Class Reference

An iterator to iterate over a list of shadows. More...

#include <lview.h>

Inheritance diagram for csShadowIterator:

iShadowIterator iBase List of all members.

Public Methods

virtual bool HasNext ()
 Return true if there are further elements to process. More...

virtual csFrustumNext ()
 Return the next element. More...

virtual void * GetUserData ()
 Get the user data for the last shadow. More...

virtual bool IsRelevant ()
 Return if the last shadow is relevant or not. More...

virtual void MarkRelevant (bool rel)
 Mark the last shadow as relevant. More...

virtual void Reset ()
 Reset the iterator to start again from initial setup. More...

virtual void DeleteCurrent ()
 Delete the last element returned. More...

virtual iShadowBlockGetCurrentShadowBlock ()
 Return the shadow list for the 'current' element. More...

virtual iShadowBlockGetNextShadowBlock ()
 Return the shadow list for the 'next' element. More...

csShadowBlockGetCsCurrentShadowBlock ()
 Return the shadow list for the 'current' element. More...

csShadowBlockGetCsNextShadowBlock ()
 Return the shadow list for the 'next' element. More...


Friends

class csShadowBlockList
class csShadowBlock

Detailed Description

An iterator to iterate over a list of shadows.

This iterator can work in two directions and also supports deleting the current element in the iterator.

Definition at line 83 of file lview.h.


Member Function Documentation

virtual void csShadowIterator::DeleteCurrent   [virtual]
 

Delete the last element returned.

Implements iShadowIterator.

csShadowBlock* csShadowIterator::GetCsCurrentShadowBlock  
 

Return the shadow list for the 'current' element.

csShadowBlock* csShadowIterator::GetCsNextShadowBlock   [inline]
 

Return the shadow list for the 'next' element.

Definition at line 123 of file lview.h.

virtual iShadowBlock* csShadowIterator::GetCurrentShadowBlock   [virtual]
 

Return the shadow list for the 'current' element.

Implements iShadowIterator.

virtual iShadowBlock* csShadowIterator::GetNextShadowBlock   [virtual]
 

Return the shadow list for the 'next' element.

Implements iShadowIterator.

virtual void* csShadowIterator::GetUserData   [inline, virtual]
 

Get the user data for the last shadow.

Implements iShadowIterator.

Definition at line 107 of file lview.h.

References csShadowFrustum::GetUserData.

virtual bool csShadowIterator::HasNext   [virtual]
 

Return true if there are further elements to process.

Implements iShadowIterator.

virtual bool csShadowIterator::IsRelevant   [inline, virtual]
 

Return if the last shadow is relevant or not.

Implements iShadowIterator.

Definition at line 109 of file lview.h.

References csShadowFrustum::IsRelevant.

virtual void csShadowIterator::MarkRelevant bool    rel [inline, virtual]
 

Mark the last shadow as relevant.

Implements iShadowIterator.

Definition at line 111 of file lview.h.

References csShadowFrustum::MarkRelevant.

virtual csFrustum* csShadowIterator::Next   [virtual]
 

Return the next element.

Implements iShadowIterator.

virtual void csShadowIterator::Reset   [virtual]
 

Reset the iterator to start again from initial setup.

Implements iShadowIterator.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14