crystalspace.jbind.interfaces.iengine.region
Interface iRegion

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

public interface iRegion
extends iBase

A region. A region is basically a collection of objects in the 3D engine that can be treated as a unit.

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

Method Summary
 void add(iObject obj)
          Add an object to this region.
 void clear()
          Clear this region without removing the entities in it.
 void deleteAll()
          Delete all entities in this region.
 iCameraPosition findCameraPosition(java.lang.String iName)
          Find a camera position in this region by name.
 iCollection findCollection(java.lang.String iName)
          Find a collection in this region by name.
 iMaterialWrapper findMaterial(java.lang.String iName)
          Find a material in this region by name.
 iMeshFactoryWrapper findMeshFactory(java.lang.String iName)
          Find a mesh factory in this region by name.
 iMeshWrapper findMeshObject(java.lang.String iName)
          Find a sprite in this region by name.
 iSector findSector(java.lang.String iName)
          Find a sector in this region by name.
 iTextureWrapper findTexture(java.lang.String iName)
          Find a texture in this region by name.
 boolean isInRegion(iObject obj)
          Check if some object is in this region.
 boolean prepare()
          Prepare all objects in this region.
 boolean prepareTextures()
          Prepare all textures and materials in this region.
 iObject queryObject()
          Get the iObject for this region.
 boolean shineLights()
          Do lighting calculations (or read from cache).
 
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

add

public void add(iObject obj)
Add an object to this region.

Parameters:
obj -

clear

public void clear()
Clear this region without removing the entities in it. The entities will simply get unconnected from this region.


deleteAll

public void deleteAll()
Delete all entities in this region.


findCameraPosition

public iCameraPosition findCameraPosition(java.lang.String iName)
Find a camera position in this region by name.

Returns:

findCollection

public iCollection findCollection(java.lang.String iName)
Find a collection in this region by name.

Parameters:
iName -
Returns:

findMaterial

public iMaterialWrapper findMaterial(java.lang.String iName)
Find a material in this region by name.

Parameters:
iName -
Returns:

findMeshFactory

public iMeshFactoryWrapper findMeshFactory(java.lang.String iName)
Find a mesh factory in this region by name.

Parameters:
iName -
Returns:

findMeshObject

public iMeshWrapper findMeshObject(java.lang.String iName)
Find a sprite in this region by name.

Parameters:
iName -
Returns:

findSector

public iSector findSector(java.lang.String iName)
Find a sector in this region by name.

Parameters:
iName -
Returns:

findTexture

public iTextureWrapper findTexture(java.lang.String iName)
Find a texture in this region by name.

Parameters:
iName -
Returns:

isInRegion

public boolean isInRegion(iObject obj)
Check if some object is in this region. The speed of this function is independent of the number of objects in this region (i.e. very fast).

Parameters:
obj -
Returns:

prepare

public boolean prepare()
Prepare all objects in this region. This has to be called directly after loading new objects. This function is equivalent to calling PrepareTextures() followed by ShineLights().


prepareTextures

public boolean prepareTextures()
Prepare all textures and materials in this region.

Returns:

queryObject

public iObject queryObject()
Get the iObject for this region.

Returns:

shineLights

public boolean shineLights()
Do lighting calculations (or read from cache).

Returns: