crystalspace.jbind.interfaces.iengine.shadows
Interface iShadowIterator

All Superinterfaces:

iBase, iPointer

All Known Implementing Classes:

csShadowIterator

public interface iShadowIterator

extends iBase

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

Author:

Java wrapper - Quentin Anciaux, c++ version - http://crystal.sourceforge.net/docs/online/pubapi/structiShadowIterator.php

Method Summary

void	deleteCurrent() Delete the last returned shadow.
iShadowBlock	getCurrentShadowBlock() Return the shadow list for the current element.
iShadowBlock	getNextShadowBlock() Return the shadow list for the next element.
iPointer	getUserData() Get the user data for the last shadow.
boolean	hasNext() Is there still an element in this iterator?
boolean	isRelevant() Return if the last shadow is relevant or not.
void	markRelevant(boolean rel) Mark the last shadow as relevant.
csFrustum	next() Get the next shadow.
void	reset() Reset the iterator to start again.

Methods inherited from interface crystalspace.jbind.interfaces.iutil.scf.iBase

decRef, getName, getRefCount, getVersion, incRef, queryInterface, queryInterfaceSafe

Methods inherited from interface crystalspace.jbind.interfaces.iPointer

changePointer, getPointer, isMemoryOwner, setMemoryOwner

Method Detail

deleteCurrent

public void deleteCurrent()

Delete the last returned shadow.

getCurrentShadowBlock

public iShadowBlock getCurrentShadowBlock()

Return the shadow list for the current element.

Returns:

getNextShadowBlock

public iShadowBlock getNextShadowBlock()

Return the shadow list for the next element.

Returns:

getUserData

public iPointer getUserData()

Get the user data for the last shadow.

Returns:

hasNext

public boolean hasNext()

Is there still an element in this iterator?

Returns:

isRelevant

public boolean isRelevant()

Return if the last shadow is relevant or not.

Returns:

markRelevant

public void markRelevant(boolean rel)

Mark the last shadow as relevant.

Parameters:

rel -

next

public csFrustum next()

Get the next shadow.

Returns:

reset

public void reset()

Reset the iterator to start again.