crystalspace.jbind.interfaces.iengine.fview
Interface iFrustumView

All Superinterfaces:
iBase, iPointer
All Known Implementing Classes:
csFrustumView

public interface iFrustumView
extends iBase

Author:
Quentin Anciaux

Method Summary
 void callObjectFunction(iMeshWrapper mesh, boolean vis)
          Call the object function.
 boolean checkProcessMask(int mask)
          Check if a mask corresponds with the process mask.
 boolean checkShadowMask(int mask)
          Check if a mask corresponds with the shadow mask.
 csFrustumContext copyFrustumContext()
          Create a copy of the current frustum context and return it.
 void createFrustumContext()
          Create a new frustum context.
 iShadowBlock createShadowBlock()
          Create a new empty shadow block.
 csFrustumContext getFrustumContext()
          Get the current frustum context.
 float getRadius()
          Get the radius.
 float getSquaredRadius()
          Get the squared radius.
 iFrustumViewUserdata getUserdata()
          Get userdata.
 void restoreFrustumContext(csFrustumContext original)
          Restore a frustum context.
 void setFrustumContext(csFrustumContext ctxt)
          This function is similar to CreateFrustumContext() but it sets the given frustum context instead.
 void setObjectFunction(iFrustumViewObjectFunc func)
          Set the object function.
 void setUserdata(iFrustumViewUserdata data)
          Set or clear userdata.
 void startNewShadowBlock()
          Start new shadow list for this frustum.
 boolean thingShadowsEnabled()
          Return true if shadowing for things is enabled.
 
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

getFrustumContext

public csFrustumContext getFrustumContext()
Get the current frustum context.

Returns:

createFrustumContext

public void createFrustumContext()
Create a new frustum context.


copyFrustumContext

public csFrustumContext copyFrustumContext()
Create a copy of the current frustum context and return it.

Returns:

setFrustumContext

public void setFrustumContext(csFrustumContext ctxt)
This function is similar to CreateFrustumContext() but it sets the given frustum context instead.

Parameters:
ctxt -

restoreFrustumContext

public void restoreFrustumContext(csFrustumContext original)
Restore a frustum context.

Parameters:
original -

setObjectFunction

public void setObjectFunction(iFrustumViewObjectFunc func)
Set the object function.

Parameters:
func -

callObjectFunction

public void callObjectFunction(iMeshWrapper mesh,
                               boolean vis)
Call the object function.

Parameters:
mesh -
vis -

getRadius

public float getRadius()
Get the radius.

Returns:

getSquaredRadius

public float getSquaredRadius()
Get the squared radius.

Returns:

thingShadowsEnabled

public boolean thingShadowsEnabled()
Return true if shadowing for things is enabled.

Returns:

checkShadowMask

public boolean checkShadowMask(int mask)
Check if a mask corresponds with the shadow mask.

Parameters:
mask -
Returns:

checkProcessMask

public boolean checkProcessMask(int mask)
Check if a mask corresponds with the process mask.

Parameters:
mask -
Returns:

startNewShadowBlock

public void startNewShadowBlock()
Start new shadow list for this frustum.


setUserdata

public void setUserdata(iFrustumViewUserdata data)
Set or clear userdata.

Parameters:
data -

getUserdata

public iFrustumViewUserdata getUserdata()
Get userdata.

Returns:

createShadowBlock

public iShadowBlock createShadowBlock()
Create a new empty shadow block.

Returns: