Public API Reference

                 

---

iShadowIterator Struct Reference
[Lighting]

A shadow iterator allows someone to iterate over all shadows in a iShadowBlock or iShadowBlockList. More...

#include <shadows.h>

Inheritance diagram for iShadowIterator:

List of all members.

Public Methods
virtual void	Reset ()=0
	Reset the iterator to start again. More...
virtual bool	HasNext ()=0
	Is there still an element in this iterator? More...
virtual csFrustum *	Next ()=0
	Get the next shadow. More...
virtual void *	GetUserData ()=0
	Get the user data for the last shadow. More...
virtual bool	IsRelevant ()=0
	Return if the last shadow is relevant or not. More...
virtual void	MarkRelevant (bool rel)=0
	Mark the last shadow as relevant. More...
virtual void	DeleteCurrent ()=0
	Delete the last returned shadow. More...
virtual iShadowBlock *	GetCurrentShadowBlock ()=0
	Return the shadow list for the current element. More...
virtual iShadowBlock *	GetNextShadowBlock ()=0
	Return the shadow list for the next element. More...

---

Detailed Description

A shadow iterator allows someone to iterate over all shadows in a iShadowBlock or iShadowBlockList.

Definition at line 44 of file shadows.h.

---

Member Function Documentation

virtual void iShadowIterator::DeleteCurrent (    )  [pure virtual]

Delete the last returned shadow. Implemented in csShadowIterator.

virtual iShadowBlock* iShadowIterator::GetCurrentShadowBlock (    )  [pure virtual]

Return the shadow list for the current element. Implemented in csShadowIterator.

virtual iShadowBlock* iShadowIterator::GetNextShadowBlock (    )  [pure virtual]

Return the shadow list for the next element. Implemented in csShadowIterator.

virtual void* iShadowIterator::GetUserData (    )  [pure virtual]

Get the user data for the last shadow. Implemented in csShadowIterator.

virtual bool iShadowIterator::HasNext (    )  [pure virtual]

Is there still an element in this iterator? Implemented in csShadowIterator.

virtual bool iShadowIterator::IsRelevant (    )  [pure virtual]

Return if the last shadow is relevant or not. Implemented in csShadowIterator.

virtual void iShadowIterator::MarkRelevant (  bool    rel )  [pure virtual]

Mark the last shadow as relevant. Implemented in csShadowIterator.

virtual csFrustum* iShadowIterator::Next (    )  [pure virtual]

Get the next shadow. Implemented in csShadowIterator.

virtual void iShadowIterator::Reset (    )  [pure virtual]

Reset the iterator to start again. Implemented in csShadowIterator.

---

The documentation for this struct was generated from the following file:

• shadows.h

---