crystalspace.jbind.impl.engine.shadows
Class csShadowIterator

java.lang.Object
  extended bycrystalspace.jbind.impl.csNativeObject
      extended bycrystalspace.jbind.impl.csutil.scf.csBase
          extended bycrystalspace.jbind.impl.engine.shadows.csShadowIterator
All Implemented Interfaces:
iBase, iPointer, iShadowIterator

public class csShadowIterator
extends csBase
implements iShadowIterator

Author:
Quentin Anciaux

Field Summary
 
Fields inherited from class crystalspace.jbind.impl.csNativeObject
ImplFactory, nPointer
 
Constructor Summary
csShadowIterator(iPointer nPointer)
           
 
Method Summary
 void deleteCurrent()
          Delete the last returned shadow.
 iShadowBlock getCurrentShadowBlock()
          Return the shadow list for the current element.
 java.lang.String getName()
          Return the name of the interface
 iShadowBlock getNextShadowBlock()
          Return the shadow list for the next element.
 iPointer getUserData()
          Get the user data for the last shadow.
 int getVersion()
          Return the version of the interface
 boolean hasNext()
          Is there still an element in this iterator?
protected  boolean isNativePointerValidSafe(long pointer)
           
 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 class crystalspace.jbind.impl.csutil.scf.csBase
decRef, equals, finalize, getRefCount, incRef, nDelete, queryInterface, queryInterfaceSafe
 
Methods inherited from class crystalspace.jbind.impl.csNativeObject
changePointer, getPointer, getPointer, getPointerArray, hashCode, isMemoryOwner, isNativePointerValid, newNativeObject, setMemoryOwner, toString
 
Methods inherited from class java.lang.Object
clone, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface crystalspace.jbind.interfaces.iutil.scf.iBase
decRef, getRefCount, incRef, queryInterface, queryInterfaceSafe
 
Methods inherited from interface crystalspace.jbind.interfaces.iPointer
changePointer, getPointer, isMemoryOwner, setMemoryOwner
 

Constructor Detail

csShadowIterator

public csShadowIterator(iPointer nPointer)
Parameters:
nPointer -
Method Detail

getVersion

public int getVersion()
Description copied from interface: iBase
Return the version of the interface

Specified by:
getVersion in interface iBase
Specified by:
getVersion in class csBase
See Also:
iBase.getVersion()

getName

public java.lang.String getName()
Description copied from interface: iBase
Return the name of the interface

Specified by:
getName in interface iBase
Specified by:
getName in class csBase
See Also:
iBase.getName()

isNativePointerValidSafe

protected boolean isNativePointerValidSafe(long pointer)
Specified by:
isNativePointerValidSafe in class csNativeObject
See Also:
csNativeObject.isNativePointerValidSafe(long)

deleteCurrent

public void deleteCurrent()
Description copied from interface: iShadowIterator
Delete the last returned shadow.

Specified by:
deleteCurrent in interface iShadowIterator
See Also:
iShadowIterator.deleteCurrent()

getCurrentShadowBlock

public iShadowBlock getCurrentShadowBlock()
Description copied from interface: iShadowIterator
Return the shadow list for the current element.

Specified by:
getCurrentShadowBlock in interface iShadowIterator
Returns:
See Also:
iShadowIterator.getCurrentShadowBlock()

getNextShadowBlock

public iShadowBlock getNextShadowBlock()
Description copied from interface: iShadowIterator
Return the shadow list for the next element.

Specified by:
getNextShadowBlock in interface iShadowIterator
Returns:
See Also:
iShadowIterator.getNextShadowBlock()

getUserData

public iPointer getUserData()
Description copied from interface: iShadowIterator
Get the user data for the last shadow.

Specified by:
getUserData in interface iShadowIterator
Returns:
See Also:
iShadowIterator.getUserData()

hasNext

public boolean hasNext()
Description copied from interface: iShadowIterator
Is there still an element in this iterator?

Specified by:
hasNext in interface iShadowIterator
Returns:
See Also:
iShadowIterator.hasNext()

isRelevant

public boolean isRelevant()
Description copied from interface: iShadowIterator
Return if the last shadow is relevant or not.

Specified by:
isRelevant in interface iShadowIterator
Returns:
See Also:
iShadowIterator.isRelevant()

markRelevant

public void markRelevant(boolean rel)
Description copied from interface: iShadowIterator
Mark the last shadow as relevant.

Specified by:
markRelevant in interface iShadowIterator
Parameters:
rel -
See Also:
iShadowIterator.markRelevant(boolean)

next

public csFrustum next()
Description copied from interface: iShadowIterator
Get the next shadow.

Specified by:
next in interface iShadowIterator
Returns:
See Also:
iShadowIterator.next()

reset

public void reset()
Description copied from interface: iShadowIterator
Reset the iterator to start again.

Specified by:
reset in interface iShadowIterator
See Also:
iShadowIterator.reset()