crystalspace.jbind.impl.engine.fview
Class csFrustumView

java.lang.Object
  extended bycrystalspace.jbind.impl.csNativeObject
      extended bycrystalspace.jbind.impl.csutil.scf.csBase
          extended bycrystalspace.jbind.impl.engine.fview.csFrustumView
All Implemented Interfaces:
iBase, iFrustumView, iPointer

public class csFrustumView
extends csBase
implements iFrustumView

Author:
Quentin Anciaux

Field Summary
 
Fields inherited from class crystalspace.jbind.impl.csNativeObject
ImplFactory, nPointer
 
Constructor Summary
csFrustumView(iPointer nPointer)
           
 
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.
 java.lang.String getName()
          Return the name of the interface
 float getRadius()
          Get the radius.
 float getSquaredRadius()
          Get the squared radius.
 iFrustumViewUserdata getUserdata()
          Get userdata.
 int getVersion()
          Return the version of the interface
protected  boolean isNativePointerValidSafe(long pointer)
           
 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 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

csFrustumView

public csFrustumView(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)

getFrustumContext

public csFrustumContext getFrustumContext()
Description copied from interface: iFrustumView
Get the current frustum context.

Specified by:
getFrustumContext in interface iFrustumView
Returns:
See Also:
iFrustumView.getFrustumContext()

createFrustumContext

public void createFrustumContext()
Description copied from interface: iFrustumView
Create a new frustum context.

Specified by:
createFrustumContext in interface iFrustumView
See Also:
iFrustumView.createFrustumContext()

copyFrustumContext

public csFrustumContext copyFrustumContext()
Description copied from interface: iFrustumView
Create a copy of the current frustum context and return it.

Specified by:
copyFrustumContext in interface iFrustumView
Returns:
See Also:
iFrustumView.copyFrustumContext()

setFrustumContext

public void setFrustumContext(csFrustumContext ctxt)
Description copied from interface: iFrustumView
This function is similar to CreateFrustumContext() but it sets the given frustum context instead.

Specified by:
setFrustumContext in interface iFrustumView
Parameters:
ctxt -
See Also:
iFrustumView.setFrustumContext(crystalspace.jbind.impl.engine.fview.csFrustumContext)

restoreFrustumContext

public void restoreFrustumContext(csFrustumContext original)
Description copied from interface: iFrustumView
Restore a frustum context.

Specified by:
restoreFrustumContext in interface iFrustumView
Parameters:
original -
See Also:
iFrustumView.restoreFrustumContext(crystalspace.jbind.impl.engine.fview.csFrustumContext)

setObjectFunction

public void setObjectFunction(iFrustumViewObjectFunc func)
Description copied from interface: iFrustumView
Set the object function.

Specified by:
setObjectFunction in interface iFrustumView
Parameters:
func -
See Also:
iFrustumView.setObjectFunction(crystalspace.jbind.interfaces.iengine.fview.iFrustumViewObjectFunc)

callObjectFunction

public void callObjectFunction(iMeshWrapper mesh,
                               boolean vis)
Description copied from interface: iFrustumView
Call the object function.

Specified by:
callObjectFunction in interface iFrustumView
Parameters:
mesh -
vis -
See Also:
iFrustumView.callObjectFunction(crystalspace.jbind.interfaces.iengine.mesh.iMeshWrapper, boolean)

getRadius

public float getRadius()
Description copied from interface: iFrustumView
Get the radius.

Specified by:
getRadius in interface iFrustumView
Returns:
See Also:
iFrustumView.getRadius()

getSquaredRadius

public float getSquaredRadius()
Description copied from interface: iFrustumView
Get the squared radius.

Specified by:
getSquaredRadius in interface iFrustumView
Returns:
See Also:
iFrustumView.getSquaredRadius()

thingShadowsEnabled

public boolean thingShadowsEnabled()
Description copied from interface: iFrustumView
Return true if shadowing for things is enabled.

Specified by:
thingShadowsEnabled in interface iFrustumView
Returns:
See Also:
iFrustumView.thingShadowsEnabled()

checkShadowMask

public boolean checkShadowMask(int mask)
Description copied from interface: iFrustumView
Check if a mask corresponds with the shadow mask.

Specified by:
checkShadowMask in interface iFrustumView
Parameters:
mask -
Returns:
See Also:
iFrustumView.checkShadowMask(int)

checkProcessMask

public boolean checkProcessMask(int mask)
Description copied from interface: iFrustumView
Check if a mask corresponds with the process mask.

Specified by:
checkProcessMask in interface iFrustumView
Parameters:
mask -
Returns:
See Also:
iFrustumView.checkProcessMask(int)

startNewShadowBlock

public void startNewShadowBlock()
Description copied from interface: iFrustumView
Start new shadow list for this frustum.

Specified by:
startNewShadowBlock in interface iFrustumView
See Also:
iFrustumView.startNewShadowBlock()

setUserdata

public void setUserdata(iFrustumViewUserdata data)
Description copied from interface: iFrustumView
Set or clear userdata.

Specified by:
setUserdata in interface iFrustumView
Parameters:
data -
See Also:
iFrustumView.setUserdata(crystalspace.jbind.interfaces.iengine.fview.iFrustumViewUserdata)

getUserdata

public iFrustumViewUserdata getUserdata()
Description copied from interface: iFrustumView
Get userdata.

Specified by:
getUserdata in interface iFrustumView
Returns:
See Also:
iFrustumView.getUserdata()

createShadowBlock

public iShadowBlock createShadowBlock()
Description copied from interface: iFrustumView
Create a new empty shadow block.

Specified by:
createShadowBlock in interface iFrustumView
Returns:
See Also:
iFrustumView.createShadowBlock()