crystalspace.jbind.interfaces.iengine.viscul
Interface iVisibilityObject

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

public interface iVisibilityObject
extends iBase

An object that wants to know if it is visible or not for some visibility culler needs to implement this interface.

Author:
Java wrapper - Quentin Anciaux, c++ version - http://crystal.sourceforge.net/docs/online/devapi/structiVisibilityObject.php

Method Summary
 csFlags getCullerFlags()
          Get flags for this object.
 iMeshWrapper getMeshWrapper()
          Get the reference to the mesh wrapper from this object.
 iMovable getMovable()
          Get the reference to the movable from this object.
 iObjectModel getObjectModel()
          Get the object model corresponding with this object.
 int getVisibilityNumber()
          Get the visibility number.
 void setVisibilityNumber(int visnr)
          Set the visibility number for this object.
 
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

getCullerFlags

public csFlags getCullerFlags()
Get flags for this object. This is a combination of zero or more of the following flags. See the documentation with these flags for more info: CS_CULLER_HINT_GOODOCCLUDER CS_CULLER_HINT_BADOCCLUDER Implemented in csMeshWrapper.

Returns:

getMeshWrapper

public iMeshWrapper getMeshWrapper()
Get the reference to the mesh wrapper from this object. Implemented in csMeshWrapper.

Returns:

getMovable

public iMovable getMovable()
Get the reference to the movable from this object. Implemented in csMeshWrapper.

Returns:

getObjectModel

public iObjectModel getObjectModel()
Get the object model corresponding with this object. Implemented in csMeshWrapper.

Returns:

getVisibilityNumber

public int getVisibilityNumber()
Get the visibility number. You can compare this with iVisibilityCuller->GetCurrentVisibilityNumber();. If equal then this object is visible. Implemented in csMeshWrapper.

Returns:

setVisibilityNumber

public void setVisibilityNumber(int visnr)
Set the visibility number for this object. A visibility culler will set the visibility number of an object equal to the current visibility culler number if the object is visible. Implemented in csMeshWrapper.

Parameters:
visnr -