crystalspace.jbind.impl.engine.engine
Class csEngine

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

public class csEngine
extends csBase
implements iEngine

Author:
qan To change the template for this generated type comment go to Window>Preferences>Java>Code Generation>Code and Comments

Field Summary
 
Fields inherited from class crystalspace.jbind.impl.csNativeObject
ImplFactory, nPointer
 
Constructor Summary
csEngine(iPointer nPointer)
           
 
Method Summary
 void clearRenderPriorities()
          Clear all render priorities.
 iMaterial createBaseMaterial(iTextureWrapper txt)
          Create a base material that can be used to give to the texture manager.
 iMaterial createBaseMaterial(iTextureWrapper txt, int num_layers, iTextureWrapper[] wrappers, csTextureLayer[] layers)
          Create a base material that can be used to give to the texture manager.
 iTextureWrapper createBlackTexture(java.lang.String name, int w, int h, csColor iTransp, int iFlags)
          Create a black texture.
 iCamera createCamera()
          Create a new camera.
 iFrustumView createFrustumView()
          Create a iFrustumView instance that you can give to iVisibilityCuller->CastShadows().
 iLight createLight(java.lang.String name, csVector3 pos, float radius, csColor color, boolean pseudoDyn)
          Create a static/pseudo-dynamic light.
 iLoaderContext createLoaderContext()
          Create a loader context that you can give to loader plugins.
 iLoaderContext createLoaderContext(iRegion region)
          Create a loader context that you can give to loader plugins.
 iLoaderContext createLoaderContext(iRegion region, boolean curRegOnly)
          Create a loader context that you can give to loader plugins.
 iMaterialWrapper createMaterial(java.lang.String name, iTextureWrapper texture)
          Register a material to be loaded during Prepare().
 iMeshFactoryWrapper createMeshFactory(iMeshObjectFactory factory, java.lang.String name)
          Create a mesh factory wrapper for an existing mesh factory
 iMeshFactoryWrapper createMeshFactory(java.lang.String name)
          Create an uninitialized mesh factory wrapper.
 iMeshFactoryWrapper createMeshFactory(java.lang.String classId, java.lang.String name)
          Convenience function to create a mesh factory from a given type.
 iMeshWrapper createMeshWrapper(iMeshFactoryWrapper factory, java.lang.String name)
          Convenience function to create a mesh object for a given factory.
 iMeshWrapper createMeshWrapper(iMeshFactoryWrapper factory, java.lang.String name, iSector sector)
          Convenience function to create a mesh object for a given factory.
 iMeshWrapper createMeshWrapper(iMeshFactoryWrapper factory, java.lang.String name, iSector sector, csVector3 pos)
          Convenience function to create a mesh object for a given factory.
 iMeshWrapper createMeshWrapper(iMeshObject meshobj, java.lang.String name)
          Create a mesh wrapper for an existing mesh object.
 iMeshWrapper createMeshWrapper(iMeshObject meshobj, java.lang.String name, iSector sector)
          Create a mesh wrapper for an existing mesh object.
 iMeshWrapper createMeshWrapper(iMeshObject meshobj, java.lang.String name, iSector sector, csVector3 pos)
          Create a mesh wrapper for an existing mesh object.
 iMeshWrapper createMeshWrapper(java.lang.String name)
          Create an uninitialized mesh wrapper
 iMeshWrapper createMeshWrapper(java.lang.String classid, java.lang.String name)
          Create a mesh wrapper from a class id.
 iMeshWrapper createMeshWrapper(java.lang.String classid, java.lang.String name, iSector sector)
          Create a mesh wrapper from a class id.
 iMeshWrapper createMeshWrapper(java.lang.String classid, java.lang.String name, iSector sector, csVector3 pos)
          Create a mesh wrapper from a class id.
 iObjectWatcher createObjectWatcher()
          Create an object watcher instance that you can use to watch other objects.
 iMeshWrapper createPortal(java.lang.String name, iMeshWrapper parentMesh, iSector destSector, csVector3 vertices, int num_vertices, iPortal portal)
          Conveniance function to create a portal from one sector to another and make this portal a child mesh of another mesh.
 iMeshWrapper createPortal(java.lang.String name, iSector sourceSector, csVector3 pos, iSector destSector, csVector3 vertices, int num_vertices, iPortal portal)
          Conveniance function to create a portal from one sector to another.
 iMeshWrapper createPortalContainer(java.lang.String name)
          Create an empty portal container in some sector.
 iMeshWrapper createPortalContainer(java.lang.String name, iSector sector)
          Create an empty portal container in some sector.
 iMeshWrapper createPortalContainer(java.lang.String name, iSector sector, csVector3 pos)
          Create an empty portal container in some sector.
 iRegion createRegion(java.lang.String name)
          Create a new region and add it to the region list.
 iSector createSector(java.lang.String name)
          Create a empty sector with given name.
 iMeshWrapper createSectorWallsMesh(iSector sector, java.lang.String name)
          Convenience function to create the thing containing the convex outline of a sector.
 iTextureWrapper createTexture(java.lang.String name, java.lang.String fileName, csColor transp, int flags)
          Create a texture from a file.
 iMeshWrapper createThingMesh(iSector sector, java.lang.String name)
          Convenience function to create a thing mesh in a sector.
 void deleteAll()
          Delete everything in the engine.
 void draw(iCamera c, iClipper2D clipper)
          Draw the 3D world given a camera and a clipper.
 iCameraPosition findCameraPosition(java.lang.String name)
          Find the given camera position.
 iCameraPosition findCameraPosition(java.lang.String name, iRegion region)
          Find the given camera position.
 iCollection findCollection(java.lang.String name)
          Find the given collection.
 iCollection findCollection(java.lang.String name, iRegion region)
          Find the given collection.
 iLight findLight(java.lang.String Name)
          Find a static/pseudo-dynamic light by name.
 iLight findLight(java.lang.String Name, boolean RegionOnly)
          Find a static/pseudo-dynamic light by name.
 iLight findLightID(java.lang.String light_id)
          Find a static/pseudo-dynamic light by id.
 iMaterialWrapper findMaterial(java.lang.String name)
          Find the given material.
 iMaterialWrapper findMaterial(java.lang.String name, iRegion region)
          Find the given material.
 iMeshFactoryWrapper findMeshFactory(java.lang.String name)
          Find the given mesh factory.
 iMeshFactoryWrapper findMeshFactory(java.lang.String name, iRegion region)
          Find the given mesh factory.
 iMeshWrapper findMeshObject(java.lang.String name)
          Find the given mesh object.
 iMeshWrapper findMeshObject(java.lang.String name, iRegion region)
          Find the given mesh object.
 iSector findSector(java.lang.String name)
          Find the given sector.
 iSector findSector(java.lang.String name, iRegion region)
          Find the given sector.
 iTextureWrapper findTexture(java.lang.String name)
          Find the given texture.
 iTextureWrapper findTexture(java.lang.String name, iRegion region)
          Find the given texture.
 void forceRelight()
          Force a relight of all lighting.
 void forceRelight(iLight light)
          Force a relight for the given light.
 void forceRelight(iLight light, iRegion region)
          Force a relight for the given light.
 void forceRelight(iRegion region)
          Force a relight of all lighting.
 void forceRelight(iRegion region, iProgressMeter meter)
          Force a relight of all lighting.
 long getAlphaRenderPriority()
          Get the render priority for alpha objects (attached to 'alpha' name).
 csColor getAmbientLight()
          Return the amount of ambient light.
 int getBeginDrawFlags()
          Get the required flags for 3D->BeginDraw() which should be called from the application.
 iCacheManager getCacheManager()
          Get the cache manager that the engine is currently using.
 iCameraPositionList getCameraPositions()
          Get the list of camera positions.
 boolean getClearScreen()
          Get the value of the clear screen flag set with SetClearScreen().
 boolean getClearZBuf()
          Get the value of the clear Z-buffer flag set with SetClearZBuf().
 iCollectionList getCollections()
          Get the list of collections.
 iTextureHandle getContext()
          Return the current drawing context.
 iRenderLoop getCurrentDefaultRenderloop()
          For NR: Returns the current render loop.
 int getCurrentFrameNumber()
          Get the current framenumber.
 void getDefaultAmbientLight(csColor c)
          Return the default amount of ambient light.
 boolean getDefaultClearScreen()
          Get default clear screen flag.
 boolean getDefaultClearZBuf()
          Get default clear z-buffer flag.
 int[] getDefaultMaxLightmapSize()
          Retrieve default maximum lightmap size.
static java.lang.Class getInterfaceClass()
           
static java.lang.String getInterfaceName()
           
static int getInterfaceVersion()
           
 int getLightingCacheMode()
          Get the mode for the lighting cache.
 iLightIterator getLightIterator()
          Create an iterator to iterate over all static lights of the engine.
 iLightIterator getLightIterator(iRegion region)
          Create an iterator to iterate over all static lights of the engine.
 iMaterialList getMaterialList()
          Get the list of all materials.
 int getMaxLightmapAspectRatio()
          Get the maximum aspect ratio for lightmaps.
 int[] getMaxLightmapSize()
          Retrieve maximum lightmap size.
 iMeshList getMeshes()
          Get the list of meshes.
 iMeshFactoryList getMeshFactories()
          Get the list of mesh factories.
 java.lang.String getName()
          Return the name of the interface
 int getNearbyLights(iSector sector, csBox3 box, int flags, iLight[] lights, int max_num_lights)
          This routine returns all lights which might affect an object with some bounding box according to the following flags:
 int getNearbyLights(iSector sector, csVector3 pos, int flags, iLight[] lights, int max_num_lights)
          This routine returns all lights which might affect an object at some position according to the following flags:
 iMeshWrapperIterator getNearbyMeshes(iSector sector, csVector3 pos, float radius)
          This routine returns an iterator to iterate over all meshes that are within a radius of a given position.
 iMeshWrapperIterator getNearbyMeshes(iSector sector, csVector3 pos, float radius, boolean crossPortals)
          This routine returns an iterator to iterate over all meshes that are within a radius of a given position.
 iObjectIterator getNearbyObjects(iSector sector, csVector3 pos, float radius)
          This routine returns an iterator to iterate over all objects that are within a radius of a given position.
 iObjectIterator getNearbyObjects(iSector sector, csVector3 pos, float radius, boolean crossPortals)
          This routine returns an iterator to iterate over all objects that are within a radius of a given position.
 iSectorIterator getNearbySectors(iSector sector, csVector3 pos, float radius)
          This routine returns an iterator to iterate over all nearby sectors.
 long getObjectRenderPriority()
          Get the render priority for general objects (attached to 'object' name).
 long getPortalRenderPriority()
          Get the render priority for portal objects (attached to 'portal' name).
 iRegionList getRegions()
          Get the list of all regions.
 iRenderLoopManager getRenderLoopManager()
          For NR: Retrieve the render loop manager.
 long getRenderPriority(java.lang.String name)
          Get a render priority by name.
 boolean getRenderPriorityCamera(long priority)
          Get the render priority camera flag.
 boolean getRenderPriorityCamera(java.lang.String name)
          Get the render priority camera flag.
 int getRenderPriorityCount()
          Get the number of render priorities.
 java.lang.String getRenderPriorityName(long priority)
          Get the name of the render priority or 0 if none existant.
 int getRenderPrioritySorting(long priority)
          Get the render priority sorting flag.
 int getRenderPrioritySorting(java.lang.String name)
          Get the render priority sorting flag.
 iSectorList getSectors()
          Get the list of sectors.
 long getSkyRenderPriority()
          Get the render priority for sky objects (attached to 'sky' name).
 int getTextureFormat()
          Query the format to load textures (usually this depends on texture manager).
 iTextureList getTextureList()
          Get the list of all textures.
 iClipper2D getTopLevelClipper()
          Get the top-level clipper.
 iSharedVariableList getVariableList()
          Get the list of all shared variables.
 int getVersion()
          Return the version of the interface
 iMeshWrapperIterator getVisibleMeshes(iSector sector, csFrustum frustum)
          This routine returns an iterator to iterate over all meshes that are potentially visible as seen from a given position.
 iMeshWrapperIterator getVisibleMeshes(iSector sector, csVector3 pos)
          This routine returns an iterator to iterate over all meshes that are potentially visible as seen from a given position.
 iObjectIterator getVisibleObjects(iSector sector, csFrustum frustum)
          This routine returns an iterator to iterate over all objects that are potentially visible as seen from a given position.
 iObjectIterator getVisibleObjects(iSector sector, csVector3 pos)
          This routine returns an iterator to iterate over all objects that are potentially visible as seen from a given position.
 long getWallRenderPriority()
          Get the render priority for wall objects (attached to 'wall' name).
static void initSCF()
           
protected  boolean isNativePointerValidSafe()
           
 iMeshFactoryWrapper loadMeshFactory(java.lang.String name, java.lang.String loaderClassId, iDataBuffer input)
          Convenience function to load a mesh factory from a given loader plugin.
 iMeshWrapper loadMeshWrapper(java.lang.String name, java.lang.String loaderClassId, iDataBuffer input, iSector sector, csVector3 pos)
          Convenience function to load a mesh object from a given loader plugin.
 boolean prepare()
          Prepare the engine.
 boolean prepare(iProgressMeter meter)
          Prepare the engine.
 void prepareMeshes()
          Calls UpdateMove for all meshes to initialise bsp bounding boxes.
 void prepareTextures()
          Prepare the textures.
 iObject queryObject()
          Get the iObject for the engine.
 void registerRenderPriority(java.lang.String name, long priority)
          Register a new render priority.
 void registerRenderPriority(java.lang.String name, long priority, int rendsort)
          Register a new render priority.
 void registerRenderPriority(java.lang.String name, long priority, int rendsort, boolean do_camera)
          Register a new render priority.
 void removeLight(iLight light)
          Remove a light and update all lightmaps.
 boolean removeObject(iBase object)
          Convenience function to 'remove' a CS object from the engine.
 void resetWorldSpecificSettings()
          Reset a subset of flags/settings (which may differ from one world/map to another) to its defaults.
 void setAmbientLight(csColor color)
          Set the amount of ambient light.
 void setCacheManager(iCacheManager cache_mgr)
          Set the cache manager that the engine will use.
 void setClearScreen(boolean yesno)
          Require that the screen is cleared every frame.
 void setClearZBuf(boolean yesno)
          Require that the Z-buffer is cleared every frame.
 void setContext(iTextureHandle ctxt)
          Set the drawing context.
 boolean setCurrentDefaultRenderloop(iRenderLoop loop)
          Set the current render loop.
 void setLightingCacheMode(int mode)
          Set the mode for the lighting cache (combination of CS_ENGINE_CACHE_???).
 void setMaxLightmapSize(int w, int h)
          Set the maximum lightmap dimensions.
 void setRenderPriorityCamera(long priority, boolean do_camera)
          Set the render priority camera flag.
 void shineLights()
          Calculate all lighting information.
 void shineLights(iRegion region)
          Calculate all lighting information.
 void shineLights(iRegion region, iProgressMeter meter)
          Calculate all lighting information.
 void wantToDie(iMeshWrapper mesh)
          Sometimes a mesh wants to destruct itself (for example a particle system that has only limited lifetime).
 
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, isNativePointerValidSafe, 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

csEngine

public csEngine(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

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

initSCF

public static void initSCF()

createLight

public iLight createLight(java.lang.String name,
                          csVector3 pos,
                          float radius,
                          csColor color,
                          boolean pseudoDyn)
Description copied from interface: iEngine
Create a static/pseudo-dynamic light.

Specified by:
createLight in interface iEngine
Parameters:
name - the engine name for this light (may be 0)
pos - the position of this light in world coordinates
radius - the maximum distance at which this light will affect objects
color - the color of this light (also affects light intensity)
pseudoDyn - create a pseudo-dynamic light (an unmoving light which can efficiently change intensity or color)
Returns:

createSector

public iSector createSector(java.lang.String name)
Description copied from interface: iEngine
Create a empty sector with given name.

Specified by:
createSector in interface iEngine
Parameters:
name -
Returns:

createSectorWallsMesh

public iMeshWrapper createSectorWallsMesh(iSector sector,
                                          java.lang.String name)
Description copied from interface: iEngine
Convenience function to create the thing containing the convex outline of a sector.

Specified by:
createSectorWallsMesh in interface iEngine
Parameters:
sector -
name -
Returns:

getMaterialList

public iMaterialList getMaterialList()
Description copied from interface: iEngine
Get the list of all materials.

Specified by:
getMaterialList in interface iEngine
Returns:

prepare

public boolean prepare()
Description copied from interface: iEngine
Prepare the engine.

Specified by:
prepare in interface iEngine
Returns:

setLightingCacheMode

public void setLightingCacheMode(int mode)
Description copied from interface: iEngine
Set the mode for the lighting cache (combination of CS_ENGINE_CACHE_???).

Specified by:
setLightingCacheMode in interface iEngine
Parameters:
mode -

getInterfaceVersion

public static int getInterfaceVersion()

getInterfaceName

public static java.lang.String getInterfaceName()

getInterfaceClass

public static java.lang.Class getInterfaceClass()

getBeginDrawFlags

public int getBeginDrawFlags()
Description copied from interface: iEngine
Get the required flags for 3D->BeginDraw() which should be called from the application.

Specified by:
getBeginDrawFlags in interface iEngine
Returns:

isNativePointerValidSafe

protected boolean isNativePointerValidSafe()

clearRenderPriorities

public void clearRenderPriorities()
Description copied from interface: iEngine
Clear all render priorities.

Specified by:
clearRenderPriorities in interface iEngine
See Also:
iEngine.clearRenderPriorities()

createBaseMaterial

public iMaterial createBaseMaterial(iTextureWrapper txt,
                                    int num_layers,
                                    iTextureWrapper[] wrappers,
                                    csTextureLayer[] layers)
Description copied from interface: iEngine
Create a base material that can be used to give to the texture manager. This version also supports texture layers.

Specified by:
createBaseMaterial in interface iEngine
Parameters:
txt - the base texture (lowermost texture layer)
num_layers - the number of texture layers supplid in the next parameter
wrappers - an array of pointers to iTextureWrapper objects, supplying the texture to use for each texture layer
layers - an array of csTextureLayer structures cooresponding to each texture layer and describing how the layer is aligned and blended with the layers beneath it.
Returns:
See Also:
iEngine.createBaseMaterial(crystalspace.jbind.interfaces.iengine.texture.iTextureWrapper, int, crystalspace.jbind.interfaces.iengine.texture.iTextureWrapper[], crystalspace.jbind.impl.video.material.csTextureLayer[])

createBaseMaterial

public iMaterial createBaseMaterial(iTextureWrapper txt)
Description copied from interface: iEngine
Create a base material that can be used to give to the texture manager. Note: You will need to call iMaterialWrapper::Register() and iMaterialWrapper::GetMaterialHandler()->Prepare() on you new material if you load the material after iEngine::Prepare() has been called.

Specified by:
createBaseMaterial in interface iEngine
Parameters:
txt - The texture map this material will use.
Returns:
See Also:
iEngine.createBaseMaterial(crystalspace.jbind.interfaces.iengine.texture.iTextureWrapper)

createBlackTexture

public iTextureWrapper createBlackTexture(java.lang.String name,
                                          int w,
                                          int h,
                                          csColor iTransp,
                                          int iFlags)
Description copied from interface: iEngine
Create a black texture. This is mostly useful for procedural textures.

Specified by:
createBlackTexture in interface iEngine
Parameters:
name - The name to use for this texture in the engine
w - the texture width (must be a power of 2, eg 64, 128, 256, 512...)
h - the texture height (must be a power of 2, eg 64, 128, 256, 512...)
iTransp - pixels in the image with this key color will be considered transparent instead of being drawn
iFlags - @see createTexture()
Returns:
See Also:
iEngine.createBlackTexture(java.lang.String, int, int, crystalspace.jbind.impl.csutil.cscolor.csColor, int)

createCamera

public iCamera createCamera()
Description copied from interface: iEngine
Create a new camera.

Specified by:
createCamera in interface iEngine
Returns:
See Also:
iEngine.createCamera()

createFrustumView

public iFrustumView createFrustumView()
Description copied from interface: iEngine
Create a iFrustumView instance that you can give to iVisibilityCuller->CastShadows(). You can initialize that instance so that your own function is called for every object that is being visited.

Specified by:
createFrustumView in interface iEngine
Returns:
See Also:
iEngine.createFrustumView()

createLoaderContext

public iLoaderContext createLoaderContext()
Description copied from interface: iEngine
Create a loader context that you can give to loader plugins.

Specified by:
createLoaderContext in interface iEngine
Returns:
See Also:
iEngine.createLoaderContext()

createLoaderContext

public iLoaderContext createLoaderContext(iRegion region,
                                          boolean curRegOnly)
Description copied from interface: iEngine
Create a loader context that you can give to loader plugins. It will basically allow loader plugins to find materials.

Specified by:
createLoaderContext in interface iEngine
Parameters:
region - optional loader region
curRegOnly - if region is valid and and curRegOnly is true then only that region will be searched.
Returns:
See Also:
iEngine.createLoaderContext(crystalspace.jbind.interfaces.iengine.region.iRegion, boolean)

createLoaderContext

public iLoaderContext createLoaderContext(iRegion region)
Description copied from interface: iEngine
Create a loader context that you can give to loader plugins. It will basically allow loader plugins to find materials

Specified by:
createLoaderContext in interface iEngine
Parameters:
region - optional loader region
Returns:
See Also:
iEngine.createLoaderContext(crystalspace.jbind.interfaces.iengine.region.iRegion)

createMaterial

public iMaterialWrapper createMaterial(java.lang.String name,
                                       iTextureWrapper texture)
Description copied from interface: iEngine
Register a material to be loaded during Prepare().

Specified by:
createMaterial in interface iEngine
Parameters:
name - the engine name for this material
texture - texture to use for this material
Returns:
See Also:
iEngine.createMaterial(java.lang.String, crystalspace.jbind.interfaces.iengine.texture.iTextureWrapper)

createMeshFactory

public iMeshFactoryWrapper createMeshFactory(iMeshObjectFactory factory,
                                             java.lang.String name)
Description copied from interface: iEngine
Create a mesh factory wrapper for an existing mesh factory

Specified by:
createMeshFactory in interface iEngine
Parameters:
factory - the mesh factory to be wrapped, the engine doesn't "know" about a mesh factory until associated with a FactoryWrapper
name - the engine name for the factory wrapper
Returns:
See Also:
iEngine.createMeshFactory(crystalspace.jbind.interfaces.imesh.object.iMeshObjectFactory, java.lang.String)

createMeshFactory

public iMeshFactoryWrapper createMeshFactory(java.lang.String classId,
                                             java.lang.String name)
Description copied from interface: iEngine
Convenience function to create a mesh factory from a given type.

Specified by:
createMeshFactory in interface iEngine
Parameters:
classId - the SCF name of the plugin (like 'crystalspace.mesh.object.ball'). The type plugin will only be loaded if needed.
name - The factory will be registered with the engine under the given name. If there is already a factory with that name no new factory will be created but the found one is returned instead. If the name is 0 then no name will be set and no check will happen if the factory already exists.
Returns:
null on failure
See Also:
iEngine.createMeshFactory(java.lang.String, java.lang.String)

createMeshFactory

public iMeshFactoryWrapper createMeshFactory(java.lang.String name)
Description copied from interface: iEngine
Create an uninitialized mesh factory wrapper.

Specified by:
createMeshFactory in interface iEngine
Parameters:
name - the engine name for the factory wrapper
Returns:
See Also:
iEngine.createMeshFactory(java.lang.String)

createMeshWrapper

public iMeshWrapper createMeshWrapper(iMeshFactoryWrapper factory,
                                      java.lang.String name,
                                      iSector sector,
                                      csVector3 pos)
Description copied from interface: iEngine
Convenience function to create a mesh object for a given factory.

Specified by:
createMeshWrapper in interface iEngine
Parameters:
factory -
name -
sector -
pos -
Returns:
See Also:
iEngine.createMeshWrapper(crystalspace.jbind.interfaces.iengine.mesh.iMeshFactoryWrapper, java.lang.String, crystalspace.jbind.interfaces.iengine.sector.iSector, crystalspace.jbind.impl.csgeom.vector3.csVector3)

createMeshWrapper

public iMeshWrapper createMeshWrapper(iMeshFactoryWrapper factory,
                                      java.lang.String name,
                                      iSector sector)
Description copied from interface: iEngine
Convenience function to create a mesh object for a given factory.

Specified by:
createMeshWrapper in interface iEngine
Parameters:
factory -
name -
sector -
Returns:
See Also:
iEngine.createMeshWrapper(crystalspace.jbind.interfaces.iengine.mesh.iMeshFactoryWrapper, java.lang.String, crystalspace.jbind.interfaces.iengine.sector.iSector)

createMeshWrapper

public iMeshWrapper createMeshWrapper(iMeshFactoryWrapper factory,
                                      java.lang.String name)
Description copied from interface: iEngine
Convenience function to create a mesh object for a given factory.

Specified by:
createMeshWrapper in interface iEngine
Parameters:
factory -
name -
Returns:
See Also:
iEngine.createMeshWrapper(crystalspace.jbind.interfaces.iengine.mesh.iMeshFactoryWrapper, java.lang.String)

createMeshWrapper

public iMeshWrapper createMeshWrapper(iMeshObject meshobj,
                                      java.lang.String name,
                                      iSector sector,
                                      csVector3 pos)
Description copied from interface: iEngine
Create a mesh wrapper for an existing mesh object.

Specified by:
createMeshWrapper in interface iEngine
Parameters:
meshobj -
name -
sector -
pos -
Returns:
See Also:
iEngine.createMeshWrapper(crystalspace.jbind.interfaces.imesh.object.iMeshObject, java.lang.String, crystalspace.jbind.interfaces.iengine.sector.iSector, crystalspace.jbind.impl.csgeom.vector3.csVector3)

createMeshWrapper

public iMeshWrapper createMeshWrapper(iMeshObject meshobj,
                                      java.lang.String name,
                                      iSector sector)
Description copied from interface: iEngine
Create a mesh wrapper for an existing mesh object.

Specified by:
createMeshWrapper in interface iEngine
Parameters:
meshobj -
name -
sector -
Returns:
See Also:
iEngine.createMeshWrapper(crystalspace.jbind.interfaces.imesh.object.iMeshObject, java.lang.String, crystalspace.jbind.interfaces.iengine.sector.iSector)

createMeshWrapper

public iMeshWrapper createMeshWrapper(iMeshObject meshobj,
                                      java.lang.String name)
Description copied from interface: iEngine
Create a mesh wrapper for an existing mesh object.

Specified by:
createMeshWrapper in interface iEngine
Parameters:
meshobj -
name -
Returns:
See Also:
iEngine.createMeshWrapper(crystalspace.jbind.interfaces.imesh.object.iMeshObject, java.lang.String)

createMeshWrapper

public iMeshWrapper createMeshWrapper(java.lang.String classid,
                                      java.lang.String name,
                                      iSector sector,
                                      csVector3 pos)
Description copied from interface: iEngine
Create a mesh wrapper from a class id. This function will first make a factory from the plugin and then see if that factory itself implements iMeshObject too. This means this function is useful to create thing mesh objects (which are both factory and object at the same time). If that fails this function will call NewInstance() on the factory and return that object then.

Specified by:
createMeshWrapper in interface iEngine
Parameters:
classid - The SCF name of the plugin (like 'crystalspace.mesh.object.ball'). The type plugin will only be loaded if needed.
name - The engine name for the mesh wrapper; may be null. Different mesh objects can have the same name (in contrast with factory objects).
sector - the sector to initially place this mesh in If 'sector' is 0 then the mesh object will not be set to a position.
pos - the position in the sector
Returns:
The meshwrapper on success, or null on failure.
See Also:
iEngine.createMeshWrapper(java.lang.String, java.lang.String, crystalspace.jbind.interfaces.iengine.sector.iSector, crystalspace.jbind.impl.csgeom.vector3.csVector3)

createMeshWrapper

public iMeshWrapper createMeshWrapper(java.lang.String classid,
                                      java.lang.String name,
                                      iSector sector)
Description copied from interface: iEngine
Create a mesh wrapper from a class id. This function will first make a factory from the plugin and then see if that factory itself implements iMeshObject too. This means this function is useful to create thing mesh objects (which are both factory and object at the same time). If that fails this function will call NewInstance() on the factory and return that object then.

Specified by:
createMeshWrapper in interface iEngine
Parameters:
classid - The SCF name of the plugin (like 'crystalspace.mesh.object.ball'). The type plugin will only be loaded if needed.
name - The engine name for the mesh wrapper; may be null. Different mesh objects can have the same name (in contrast with factory objects).
sector - the sector to initially place this mesh in If 'sector' is 0 then the mesh object will not be set to a position.
Returns:
The meshwrapper on success, or null on failure.
See Also:
iEngine.createMeshWrapper(java.lang.String, java.lang.String, crystalspace.jbind.interfaces.iengine.sector.iSector)

createMeshWrapper

public iMeshWrapper createMeshWrapper(java.lang.String classid,
                                      java.lang.String name)
Description copied from interface: iEngine
Create a mesh wrapper from a class id. This function will first make a factory from the plugin and then see if that factory itself implements iMeshObject too. This means this function is useful to create thing mesh objects (which are both factory and object at the same time). If that fails this function will call NewInstance() on the factory and return that object then.

Specified by:
createMeshWrapper in interface iEngine
Parameters:
classid - The SCF name of the plugin (like 'crystalspace.mesh.object.ball'). The type plugin will only be loaded if needed.
name - The engine name for the mesh wrapper; may be null. Different mesh objects can have the same name (in contrast with factory objects).
Returns:
The meshwrapper on success, or null on failure.
See Also:
iEngine.createMeshWrapper(java.lang.String, java.lang.String)

createMeshWrapper

public iMeshWrapper createMeshWrapper(java.lang.String name)
Description copied from interface: iEngine
Create an uninitialized mesh wrapper

Specified by:
createMeshWrapper in interface iEngine
Parameters:
name -
Returns:
See Also:
iEngine.createMeshWrapper(java.lang.String)

createObjectWatcher

public iObjectWatcher createObjectWatcher()
Description copied from interface: iEngine
Create an object watcher instance that you can use to watch other objects.

Specified by:
createObjectWatcher in interface iEngine
Returns:
See Also:
iEngine.createObjectWatcher()

createPortal

public iMeshWrapper createPortal(java.lang.String name,
                                 iMeshWrapper parentMesh,
                                 iSector destSector,
                                 csVector3 vertices,
                                 int num_vertices,
                                 iPortal portal)
Description copied from interface: iEngine
Conveniance function to create a portal from one sector to another and make this portal a child mesh of another mesh.

Specified by:
createPortal in interface iEngine
Parameters:
name -
parentMesh -
destSector -
vertices -
num_vertices -
portal -
Returns:
See Also:
iEngine.createPortal(java.lang.String, crystalspace.jbind.interfaces.iengine.mesh.iMeshWrapper, crystalspace.jbind.interfaces.iengine.sector.iSector, crystalspace.jbind.impl.csgeom.vector3.csVector3, int, crystalspace.jbind.interfaces.iengine.portal.iPortal)

createPortal

public iMeshWrapper createPortal(java.lang.String name,
                                 iSector sourceSector,
                                 csVector3 pos,
                                 iSector destSector,
                                 csVector3 vertices,
                                 int num_vertices,
                                 iPortal portal)
Description copied from interface: iEngine
Conveniance function to create a portal from one sector to another.

Specified by:
createPortal in interface iEngine
Parameters:
name -
sourceSector -
pos -
destSector -
vertices -
num_vertices -
portal -
Returns:
See Also:
iEngine.createPortal(java.lang.String, crystalspace.jbind.interfaces.iengine.sector.iSector, crystalspace.jbind.impl.csgeom.vector3.csVector3, crystalspace.jbind.interfaces.iengine.sector.iSector, crystalspace.jbind.impl.csgeom.vector3.csVector3, int, crystalspace.jbind.interfaces.iengine.portal.iPortal)

createPortalContainer

public iMeshWrapper createPortalContainer(java.lang.String name,
                                          iSector sector,
                                          csVector3 pos)
Description copied from interface: iEngine
Create an empty portal container in some sector.

Specified by:
createPortalContainer in interface iEngine
Parameters:
name -
sector -
pos -
Returns:
See Also:
iEngine.createPortalContainer(java.lang.String, crystalspace.jbind.interfaces.iengine.sector.iSector, crystalspace.jbind.impl.csgeom.vector3.csVector3)

createPortalContainer

public iMeshWrapper createPortalContainer(java.lang.String name,
                                          iSector sector)
Description copied from interface: iEngine
Create an empty portal container in some sector.

Specified by:
createPortalContainer in interface iEngine
Parameters:
name -
sector -
Returns:
See Also:
iEngine.createPortalContainer(java.lang.String, crystalspace.jbind.interfaces.iengine.sector.iSector)

createPortalContainer

public iMeshWrapper createPortalContainer(java.lang.String name)
Description copied from interface: iEngine
Create an empty portal container in some sector.

Specified by:
createPortalContainer in interface iEngine
Parameters:
name -
Returns:
See Also:
iEngine.createPortalContainer(java.lang.String)

createRegion

public iRegion createRegion(java.lang.String name)
Description copied from interface: iEngine
Create a new region and add it to the region list.

Specified by:
createRegion in interface iEngine
Parameters:
name -
Returns:
See Also:
iEngine.createRegion(java.lang.String)

createTexture

public iTextureWrapper createTexture(java.lang.String name,
                                     java.lang.String fileName,
                                     csColor transp,
                                     int flags)
Description copied from interface: iEngine
Create a texture from a file.

Specified by:
createTexture in interface iEngine
Parameters:
name -
fileName -
transp -
flags -
Returns:
See Also:
iEngine.createTexture(java.lang.String, java.lang.String, crystalspace.jbind.impl.csutil.cscolor.csColor, int)

createThingMesh

public iMeshWrapper createThingMesh(iSector sector,
                                    java.lang.String name)
Description copied from interface: iEngine
Convenience function to create a thing mesh in a sector.

Specified by:
createThingMesh in interface iEngine
Parameters:
sector -
name -
Returns:
See Also:
iEngine.createThingMesh(crystalspace.jbind.interfaces.iengine.sector.iSector, java.lang.String)

deleteAll

public void deleteAll()
Description copied from interface: iEngine
Delete everything in the engine.

Specified by:
deleteAll in interface iEngine
See Also:
iEngine.deleteAll()

draw

public void draw(iCamera c,
                 iClipper2D clipper)
Description copied from interface: iEngine
Draw the 3D world given a camera and a clipper.

Specified by:
draw in interface iEngine
Parameters:
c -
clipper -
See Also:
iEngine.draw(crystalspace.jbind.interfaces.iengine.camera.iCamera, crystalspace.jbind.interfaces.igeom.clip2d.iClipper2D)

findCameraPosition

public iCameraPosition findCameraPosition(java.lang.String name,
                                          iRegion region)
Description copied from interface: iEngine
Find the given camera position.

Specified by:
findCameraPosition in interface iEngine
Parameters:
name -
region -
Returns:
See Also:
iEngine.findCameraPosition(java.lang.String, crystalspace.jbind.interfaces.iengine.region.iRegion)

findCameraPosition

public iCameraPosition findCameraPosition(java.lang.String name)
Description copied from interface: iEngine
Find the given camera position.

Specified by:
findCameraPosition in interface iEngine
Parameters:
name -
Returns:
See Also:
iEngine.findCameraPosition(java.lang.String)

findCollection

public iCollection findCollection(java.lang.String name,
                                  iRegion region)
Description copied from interface: iEngine
Find the given collection.

Specified by:
findCollection in interface iEngine
Parameters:
name -
region -
Returns:
See Also:
iEngine.findCollection(java.lang.String, crystalspace.jbind.interfaces.iengine.region.iRegion)

findCollection

public iCollection findCollection(java.lang.String name)
Description copied from interface: iEngine
Find the given collection.

Specified by:
findCollection in interface iEngine
Parameters:
name -
Returns:
See Also:
iEngine.findCollection(java.lang.String)

findLight

public iLight findLight(java.lang.String Name,
                        boolean RegionOnly)
Description copied from interface: iEngine
Find a static/pseudo-dynamic light by name.

Specified by:
findLight in interface iEngine
Parameters:
Name -
RegionOnly -
Returns:
See Also:
iEngine.findLight(java.lang.String, boolean)

findLight

public iLight findLight(java.lang.String Name)
Description copied from interface: iEngine
Find a static/pseudo-dynamic light by name.

Specified by:
findLight in interface iEngine
Parameters:
Name -
Returns:
See Also:
iEngine.findLight(java.lang.String)

findLightID

public iLight findLightID(java.lang.String light_id)
Description copied from interface: iEngine
Find a static/pseudo-dynamic light by id.

Specified by:
findLightID in interface iEngine
Parameters:
light_id -
Returns:
See Also:
iEngine.findLightID(java.lang.String)

findMaterial

public iMaterialWrapper findMaterial(java.lang.String name,
                                     iRegion region)
Description copied from interface: iEngine
Find the given material.

Specified by:
findMaterial in interface iEngine
Parameters:
name -
region -
Returns:
See Also:
iEngine.findMaterial(java.lang.String, crystalspace.jbind.interfaces.iengine.region.iRegion)

findMaterial

public iMaterialWrapper findMaterial(java.lang.String name)
Description copied from interface: iEngine
Find the given material.

Specified by:
findMaterial in interface iEngine
Parameters:
name -
Returns:
See Also:
iEngine.findMaterial(java.lang.String)

findMeshFactory

public iMeshFactoryWrapper findMeshFactory(java.lang.String name,
                                           iRegion region)
Description copied from interface: iEngine
Find the given mesh factory.

Specified by:
findMeshFactory in interface iEngine
Parameters:
name -
region -
Returns:
See Also:
iEngine.findMeshFactory(java.lang.String, crystalspace.jbind.interfaces.iengine.region.iRegion)

findMeshFactory

public iMeshFactoryWrapper findMeshFactory(java.lang.String name)
Description copied from interface: iEngine
Find the given mesh factory.

Specified by:
findMeshFactory in interface iEngine
Parameters:
name -
Returns:
See Also:
iEngine.findMeshFactory(java.lang.String)

findMeshObject

public iMeshWrapper findMeshObject(java.lang.String name,
                                   iRegion region)
Description copied from interface: iEngine
Find the given mesh object.

Specified by:
findMeshObject in interface iEngine
Parameters:
name -
region -
Returns:
See Also:
iEngine.findMeshObject(java.lang.String, crystalspace.jbind.interfaces.iengine.region.iRegion)

findMeshObject

public iMeshWrapper findMeshObject(java.lang.String name)
Description copied from interface: iEngine
Find the given mesh object.

Specified by:
findMeshObject in interface iEngine
Parameters:
name -
Returns:
See Also:
iEngine.findMeshObject(java.lang.String)

findSector

public iSector findSector(java.lang.String name,
                          iRegion region)
Description copied from interface: iEngine
Find the given sector.

Specified by:
findSector in interface iEngine
Parameters:
name -
region -
Returns:
See Also:
iEngine.findSector(java.lang.String, crystalspace.jbind.interfaces.iengine.region.iRegion)

findSector

public iSector findSector(java.lang.String name)
Description copied from interface: iEngine
Find the given sector.

Specified by:
findSector in interface iEngine
Parameters:
name -
Returns:
See Also:
iEngine.findSector(java.lang.String)

findTexture

public iTextureWrapper findTexture(java.lang.String name,
                                   iRegion region)
Description copied from interface: iEngine
Find the given texture.

Specified by:
findTexture in interface iEngine
Parameters:
name -
region -
Returns:
See Also:
iEngine.findTexture(java.lang.String, crystalspace.jbind.interfaces.iengine.region.iRegion)

findTexture

public iTextureWrapper findTexture(java.lang.String name)
Description copied from interface: iEngine
Find the given texture.

Specified by:
findTexture in interface iEngine
Parameters:
name -
Returns:
See Also:
iEngine.findTexture(java.lang.String)

forceRelight

public void forceRelight()
Description copied from interface: iEngine
Force a relight of all lighting.

Specified by:
forceRelight in interface iEngine
See Also:
iEngine.forceRelight()

forceRelight

public void forceRelight(iLight light,
                         iRegion region)
Description copied from interface: iEngine
Force a relight for the given light.

Specified by:
forceRelight in interface iEngine
Parameters:
light -
region -
See Also:
iEngine.forceRelight(crystalspace.jbind.interfaces.iengine.light.iLight, crystalspace.jbind.interfaces.iengine.region.iRegion)

forceRelight

public void forceRelight(iLight light)
Description copied from interface: iEngine
Force a relight for the given light.

Specified by:
forceRelight in interface iEngine
Parameters:
light -
See Also:
iEngine.forceRelight(crystalspace.jbind.interfaces.iengine.light.iLight)

forceRelight

public void forceRelight(iRegion region,
                         iProgressMeter meter)
Description copied from interface: iEngine
Force a relight of all lighting.

Specified by:
forceRelight in interface iEngine
Parameters:
region -
meter -
See Also:
iEngine.forceRelight(crystalspace.jbind.interfaces.iengine.region.iRegion, crystalspace.jbind.interfaces.ivaria.pmeter.iProgressMeter)

forceRelight

public void forceRelight(iRegion region)
Description copied from interface: iEngine
Force a relight of all lighting.

Specified by:
forceRelight in interface iEngine
Parameters:
region -
See Also:
iEngine.forceRelight(crystalspace.jbind.interfaces.iengine.region.iRegion)

getAlphaRenderPriority

public long getAlphaRenderPriority()
Description copied from interface: iEngine
Get the render priority for alpha objects (attached to 'alpha' name).

Specified by:
getAlphaRenderPriority in interface iEngine
Returns:
See Also:
iEngine.getAlphaRenderPriority()

getAmbientLight

public csColor getAmbientLight()
Description copied from interface: iEngine
Return the amount of ambient light.

Specified by:
getAmbientLight in interface iEngine
See Also:
iEngine.getAmbientLight()

getCacheManager

public iCacheManager getCacheManager()
Description copied from interface: iEngine
Get the cache manager that the engine is currently using.

Specified by:
getCacheManager in interface iEngine
Returns:
See Also:
iEngine.getCacheManager()

getCameraPositions

public iCameraPositionList getCameraPositions()
Description copied from interface: iEngine
Get the list of camera positions.

Specified by:
getCameraPositions in interface iEngine
Returns:
See Also:
iEngine.getCameraPositions()

getClearScreen

public boolean getClearScreen()
Description copied from interface: iEngine
Get the value of the clear screen flag set with SetClearScreen().

Specified by:
getClearScreen in interface iEngine
Returns:
See Also:
iEngine.getClearScreen()

getClearZBuf

public boolean getClearZBuf()
Description copied from interface: iEngine
Get the value of the clear Z-buffer flag set with SetClearZBuf().

Specified by:
getClearZBuf in interface iEngine
Returns:
See Also:
iEngine.getClearZBuf()

getCollections

public iCollectionList getCollections()
Description copied from interface: iEngine
Get the list of collections.

Specified by:
getCollections in interface iEngine
Returns:
See Also:
iEngine.getCollections()

getContext

public iTextureHandle getContext()
Description copied from interface: iEngine
Return the current drawing context.

Specified by:
getContext in interface iEngine
Returns:
See Also:
iEngine.getContext()

getCurrentDefaultRenderloop

public iRenderLoop getCurrentDefaultRenderloop()
Description copied from interface: iEngine
For NR: Returns the current render loop.

Specified by:
getCurrentDefaultRenderloop in interface iEngine
Returns:
See Also:
iEngine.getCurrentDefaultRenderloop()

getCurrentFrameNumber

public int getCurrentFrameNumber()
Description copied from interface: iEngine
Get the current framenumber.

Specified by:
getCurrentFrameNumber in interface iEngine
Returns:
See Also:
iEngine.getCurrentFrameNumber()

getDefaultAmbientLight

public void getDefaultAmbientLight(csColor c)
Description copied from interface: iEngine
Return the default amount of ambient light.

Specified by:
getDefaultAmbientLight in interface iEngine
Parameters:
c -
See Also:
iEngine.getDefaultAmbientLight(crystalspace.jbind.impl.csutil.cscolor.csColor)

getDefaultClearScreen

public boolean getDefaultClearScreen()
Description copied from interface: iEngine
Get default clear screen flag.

Specified by:
getDefaultClearScreen in interface iEngine
Returns:
See Also:
iEngine.getDefaultClearScreen()

getDefaultClearZBuf

public boolean getDefaultClearZBuf()
Description copied from interface: iEngine
Get default clear z-buffer flag.

Specified by:
getDefaultClearZBuf in interface iEngine
Returns:
See Also:
iEngine.getDefaultClearZBuf()

getDefaultMaxLightmapSize

public int[] getDefaultMaxLightmapSize()
Description copied from interface: iEngine
Retrieve default maximum lightmap size.

Specified by:
getDefaultMaxLightmapSize in interface iEngine
Returns:
See Also:
iEngine.getDefaultMaxLightmapSize()

getLightingCacheMode

public int getLightingCacheMode()
Description copied from interface: iEngine
Get the mode for the lighting cache.

Specified by:
getLightingCacheMode in interface iEngine
Returns:
See Also:
iEngine.getLightingCacheMode()

getLightIterator

public iLightIterator getLightIterator()
Description copied from interface: iEngine
Create an iterator to iterate over all static lights of the engine.

Specified by:
getLightIterator in interface iEngine
Returns:
See Also:
iEngine.getLightIterator()

getLightIterator

public iLightIterator getLightIterator(iRegion region)
Description copied from interface: iEngine
Create an iterator to iterate over all static lights of the engine.

Specified by:
getLightIterator in interface iEngine
Parameters:
region -
Returns:
See Also:
iEngine.getLightIterator(crystalspace.jbind.interfaces.iengine.region.iRegion)

getMaxLightmapAspectRatio

public int getMaxLightmapAspectRatio()
Description copied from interface: iEngine
Get the maximum aspect ratio for lightmaps.

Specified by:
getMaxLightmapAspectRatio in interface iEngine
Returns:
See Also:
iEngine.getMaxLightmapAspectRatio()

getMaxLightmapSize

public int[] getMaxLightmapSize()
Description copied from interface: iEngine
Retrieve maximum lightmap size.

Specified by:
getMaxLightmapSize in interface iEngine
Returns:
See Also:
iEngine.getMaxLightmapSize()

getMeshes

public iMeshList getMeshes()
Description copied from interface: iEngine
Get the list of meshes.

Specified by:
getMeshes in interface iEngine
Returns:
See Also:
iEngine.getMeshes()

getMeshFactories

public iMeshFactoryList getMeshFactories()
Description copied from interface: iEngine
Get the list of mesh factories.

Specified by:
getMeshFactories in interface iEngine
Returns:
See Also:
iEngine.getMeshFactories()

getNearbyLights

public int getNearbyLights(iSector sector,
                           csBox3 box,
                           int flags,
                           iLight[] lights,
                           int max_num_lights)
Description copied from interface: iEngine
This routine returns all lights which might affect an object with some bounding box according to the following flags:

Specified by:
getNearbyLights in interface iEngine
Parameters:
sector -
box -
flags -
lights -
max_num_lights -
Returns:
See Also:
iEngine.getNearbyLights(crystalspace.jbind.interfaces.iengine.sector.iSector, crystalspace.jbind.impl.csgeom.box.csBox3, int, crystalspace.jbind.interfaces.iengine.light.iLight[], int)

getNearbyLights

public int getNearbyLights(iSector sector,
                           csVector3 pos,
                           int flags,
                           iLight[] lights,
                           int max_num_lights)
Description copied from interface: iEngine
This routine returns all lights which might affect an object at some position according to the following flags:

Specified by:
getNearbyLights in interface iEngine
Parameters:
sector -
pos -
flags -
lights -
max_num_lights -
Returns:
See Also:
iEngine.getNearbyLights(crystalspace.jbind.interfaces.iengine.sector.iSector, crystalspace.jbind.impl.csgeom.vector3.csVector3, int, crystalspace.jbind.interfaces.iengine.light.iLight[], int)

getNearbyMeshes

public iMeshWrapperIterator getNearbyMeshes(iSector sector,
                                            csVector3 pos,
                                            float radius,
                                            boolean crossPortals)
Description copied from interface: iEngine
This routine returns an iterator to iterate over all meshes that are within a radius of a given position.

Specified by:
getNearbyMeshes in interface iEngine
Parameters:
sector -
pos -
radius -
crossPortals -
Returns:
See Also:
iEngine.getNearbyMeshes(crystalspace.jbind.interfaces.iengine.sector.iSector, crystalspace.jbind.impl.csgeom.vector3.csVector3, float, boolean)

getNearbyMeshes

public iMeshWrapperIterator getNearbyMeshes(iSector sector,
                                            csVector3 pos,
                                            float radius)
Description copied from interface: iEngine
This routine returns an iterator to iterate over all meshes that are within a radius of a given position.

Specified by:
getNearbyMeshes in interface iEngine
Parameters:
sector -
pos -
radius -
Returns:
See Also:
iEngine.getNearbyMeshes(crystalspace.jbind.interfaces.iengine.sector.iSector, crystalspace.jbind.impl.csgeom.vector3.csVector3, float)

getNearbyObjects

public iObjectIterator getNearbyObjects(iSector sector,
                                        csVector3 pos,
                                        float radius,
                                        boolean crossPortals)
Description copied from interface: iEngine
This routine returns an iterator to iterate over all objects that are within a radius of a given position.

Specified by:
getNearbyObjects in interface iEngine
Parameters:
sector -
pos -
radius -
crossPortals -
Returns:
See Also:
iEngine.getNearbyObjects(crystalspace.jbind.interfaces.iengine.sector.iSector, crystalspace.jbind.impl.csgeom.vector3.csVector3, float, boolean)

getNearbyObjects

public iObjectIterator getNearbyObjects(iSector sector,
                                        csVector3 pos,
                                        float radius)
Description copied from interface: iEngine
This routine returns an iterator to iterate over all objects that are within a radius of a given position.

Specified by:
getNearbyObjects in interface iEngine
Parameters:
sector -
pos -
radius -
Returns:
See Also:
iEngine.getNearbyObjects(crystalspace.jbind.interfaces.iengine.sector.iSector, crystalspace.jbind.impl.csgeom.vector3.csVector3, float)

getNearbySectors

public iSectorIterator getNearbySectors(iSector sector,
                                        csVector3 pos,
                                        float radius)
Description copied from interface: iEngine
This routine returns an iterator to iterate over all nearby sectors.

Specified by:
getNearbySectors in interface iEngine
Parameters:
sector -
pos -
radius -
Returns:
See Also:
iEngine.getNearbySectors(crystalspace.jbind.interfaces.iengine.sector.iSector, crystalspace.jbind.impl.csgeom.vector3.csVector3, float)

getObjectRenderPriority

public long getObjectRenderPriority()
Description copied from interface: iEngine
Get the render priority for general objects (attached to 'object' name).

Specified by:
getObjectRenderPriority in interface iEngine
Returns:
See Also:
iEngine.getObjectRenderPriority()

getPortalRenderPriority

public long getPortalRenderPriority()
Description copied from interface: iEngine
Get the render priority for portal objects (attached to 'portal' name).

Specified by:
getPortalRenderPriority in interface iEngine
Returns:
See Also:
iEngine.getPortalRenderPriority()

getRegions

public iRegionList getRegions()
Description copied from interface: iEngine
Get the list of all regions.

Specified by:
getRegions in interface iEngine
Returns:
See Also:
iEngine.getRegions()

getRenderLoopManager

public iRenderLoopManager getRenderLoopManager()
Description copied from interface: iEngine
For NR: Retrieve the render loop manager.

Specified by:
getRenderLoopManager in interface iEngine
Returns:
See Also:
iEngine.getRenderLoopManager()

getRenderPriority

public long getRenderPriority(java.lang.String name)
Description copied from interface: iEngine
Get a render priority by name.

Specified by:
getRenderPriority in interface iEngine
Parameters:
name -
Returns:
See Also:
iEngine.getRenderPriority(java.lang.String)

getRenderPriorityCamera

public boolean getRenderPriorityCamera(long priority)
Description copied from interface: iEngine
Get the render priority camera flag.

Specified by:
getRenderPriorityCamera in interface iEngine
Parameters:
priority -
Returns:
See Also:
iEngine.getRenderPriorityCamera(long)

getRenderPriorityCamera

public boolean getRenderPriorityCamera(java.lang.String name)
Description copied from interface: iEngine
Get the render priority camera flag.

Specified by:
getRenderPriorityCamera in interface iEngine
Parameters:
name -
Returns:
See Also:
iEngine.getRenderPriorityCamera(java.lang.String)

getRenderPriorityCount

public int getRenderPriorityCount()
Description copied from interface: iEngine
Get the number of render priorities.

Specified by:
getRenderPriorityCount in interface iEngine
Returns:
See Also:
iEngine.getRenderPriorityCount()

getRenderPriorityName

public java.lang.String getRenderPriorityName(long priority)
Description copied from interface: iEngine
Get the name of the render priority or 0 if none existant.

Specified by:
getRenderPriorityName in interface iEngine
Parameters:
priority -
Returns:
See Also:
iEngine.getRenderPriorityName(long)

getRenderPrioritySorting

public int getRenderPrioritySorting(long priority)
Description copied from interface: iEngine
Get the render priority sorting flag.

Specified by:
getRenderPrioritySorting in interface iEngine
Parameters:
priority -
Returns:
See Also:
iEngine.getRenderPrioritySorting(long)

getRenderPrioritySorting

public int getRenderPrioritySorting(java.lang.String name)
Description copied from interface: iEngine
Get the render priority sorting flag.

Specified by:
getRenderPrioritySorting in interface iEngine
Parameters:
name -
Returns:
See Also:
iEngine.getRenderPrioritySorting(java.lang.String)

getSectors

public iSectorList getSectors()
Description copied from interface: iEngine
Get the list of sectors.

Specified by:
getSectors in interface iEngine
Returns:
See Also:
iEngine.getSectors()

getSkyRenderPriority

public long getSkyRenderPriority()
Description copied from interface: iEngine
Get the render priority for sky objects (attached to 'sky' name).

Specified by:
getSkyRenderPriority in interface iEngine
Returns:
See Also:
iEngine.getSkyRenderPriority()

getTextureFormat

public int getTextureFormat()
Description copied from interface: iEngine
Query the format to load textures (usually this depends on texture manager).

Specified by:
getTextureFormat in interface iEngine
Returns:
See Also:
iEngine.getTextureFormat()

getTextureList

public iTextureList getTextureList()
Description copied from interface: iEngine
Get the list of all textures.

Specified by:
getTextureList in interface iEngine
Returns:
See Also:
iEngine.getTextureList()

getTopLevelClipper

public iClipper2D getTopLevelClipper()
Description copied from interface: iEngine
Get the top-level clipper.

Specified by:
getTopLevelClipper in interface iEngine
Returns:
See Also:
iEngine.getTopLevelClipper()

getVariableList

public iSharedVariableList getVariableList()
Description copied from interface: iEngine
Get the list of all shared variables.

Specified by:
getVariableList in interface iEngine
Returns:
See Also:
iEngine.getVariableList()

getVisibleMeshes

public iMeshWrapperIterator getVisibleMeshes(iSector sector,
                                             csFrustum frustum)
Description copied from interface: iEngine
This routine returns an iterator to iterate over all meshes that are potentially visible as seen from a given position.

Specified by:
getVisibleMeshes in interface iEngine
Parameters:
sector -
frustum -
Returns:
See Also:
iEngine.getVisibleMeshes(crystalspace.jbind.interfaces.iengine.sector.iSector, crystalspace.jbind.impl.csgeom.frustum.csFrustum)

getVisibleMeshes

public iMeshWrapperIterator getVisibleMeshes(iSector sector,
                                             csVector3 pos)
Description copied from interface: iEngine
This routine returns an iterator to iterate over all meshes that are potentially visible as seen from a given position.

Specified by:
getVisibleMeshes in interface iEngine
Parameters:
sector -
pos -
Returns:
See Also:
iEngine.getVisibleMeshes(crystalspace.jbind.interfaces.iengine.sector.iSector, crystalspace.jbind.impl.csgeom.vector3.csVector3)

getVisibleObjects

public iObjectIterator getVisibleObjects(iSector sector,
                                         csFrustum frustum)
Description copied from interface: iEngine
This routine returns an iterator to iterate over all objects that are potentially visible as seen from a given position.

Specified by:
getVisibleObjects in interface iEngine
Parameters:
sector -
frustum -
Returns:
See Also:
iEngine.getVisibleObjects(crystalspace.jbind.interfaces.iengine.sector.iSector, crystalspace.jbind.impl.csgeom.frustum.csFrustum)

getVisibleObjects

public iObjectIterator getVisibleObjects(iSector sector,
                                         csVector3 pos)
Description copied from interface: iEngine
This routine returns an iterator to iterate over all objects that are potentially visible as seen from a given position.

Specified by:
getVisibleObjects in interface iEngine
Parameters:
sector -
pos -
Returns:
See Also:
iEngine.getVisibleObjects(crystalspace.jbind.interfaces.iengine.sector.iSector, crystalspace.jbind.impl.csgeom.vector3.csVector3)

getWallRenderPriority

public long getWallRenderPriority()
Description copied from interface: iEngine
Get the render priority for wall objects (attached to 'wall' name).

Specified by:
getWallRenderPriority in interface iEngine
Returns:
See Also:
iEngine.getWallRenderPriority()

loadMeshFactory

public iMeshFactoryWrapper loadMeshFactory(java.lang.String name,
                                           java.lang.String loaderClassId,
                                           iDataBuffer input)
Description copied from interface: iEngine
Convenience function to load a mesh factory from a given loader plugin.

Specified by:
loadMeshFactory in interface iEngine
Parameters:
name -
loaderClassId -
input -
Returns:
See Also:
iEngine.loadMeshFactory(java.lang.String, java.lang.String, crystalspace.jbind.interfaces.iutil.databuff.iDataBuffer)

loadMeshWrapper

public iMeshWrapper loadMeshWrapper(java.lang.String name,
                                    java.lang.String loaderClassId,
                                    iDataBuffer input,
                                    iSector sector,
                                    csVector3 pos)
Description copied from interface: iEngine
Convenience function to load a mesh object from a given loader plugin.

Specified by:
loadMeshWrapper in interface iEngine
Parameters:
name -
loaderClassId -
input -
sector -
pos -
Returns:
See Also:
iEngine.loadMeshWrapper(java.lang.String, java.lang.String, crystalspace.jbind.interfaces.iutil.databuff.iDataBuffer, crystalspace.jbind.interfaces.iengine.sector.iSector, crystalspace.jbind.impl.csgeom.vector3.csVector3)

prepare

public boolean prepare(iProgressMeter meter)
Description copied from interface: iEngine
Prepare the engine.

Specified by:
prepare in interface iEngine
Parameters:
meter -
Returns:
See Also:
iEngine.prepare(crystalspace.jbind.interfaces.ivaria.pmeter.iProgressMeter)

prepareMeshes

public void prepareMeshes()
Description copied from interface: iEngine
Calls UpdateMove for all meshes to initialise bsp bounding boxes.

Specified by:
prepareMeshes in interface iEngine
See Also:
iEngine.prepareMeshes()

prepareTextures

public void prepareTextures()
Description copied from interface: iEngine
Prepare the textures.

Specified by:
prepareTextures in interface iEngine
See Also:
iEngine.prepareTextures()

queryObject

public iObject queryObject()
Description copied from interface: iEngine
Get the iObject for the engine.

Specified by:
queryObject in interface iEngine
See Also:
iEngine.queryObject()

registerRenderPriority

public void registerRenderPriority(java.lang.String name,
                                   long priority,
                                   int rendsort,
                                   boolean do_camera)
Description copied from interface: iEngine
Register a new render priority.

Specified by:
registerRenderPriority in interface iEngine
Parameters:
name -
priority -
rendsort -
do_camera -
See Also:
iEngine.registerRenderPriority(java.lang.String, long, int, boolean)

registerRenderPriority

public void registerRenderPriority(java.lang.String name,
                                   long priority,
                                   int rendsort)
Description copied from interface: iEngine
Register a new render priority.

Specified by:
registerRenderPriority in interface iEngine
Parameters:
name -
priority -
rendsort -
See Also:
iEngine.registerRenderPriority(java.lang.String, long, int)

registerRenderPriority

public void registerRenderPriority(java.lang.String name,
                                   long priority)
Description copied from interface: iEngine
Register a new render priority.

Specified by:
registerRenderPriority in interface iEngine
Parameters:
name -
priority -
See Also:
iEngine.registerRenderPriority(java.lang.String, long)

removeLight

public void removeLight(iLight light)
Description copied from interface: iEngine
Remove a light and update all lightmaps.

Specified by:
removeLight in interface iEngine
Parameters:
light -
See Also:
iEngine.removeLight(crystalspace.jbind.interfaces.iengine.light.iLight)

removeObject

public boolean removeObject(iBase object)
Description copied from interface: iEngine
Convenience function to 'remove' a CS object from the engine.

Specified by:
removeObject in interface iEngine
Parameters:
object -
Returns:
See Also:
iEngine.removeObject(crystalspace.jbind.interfaces.iutil.scf.iBase)

resetWorldSpecificSettings

public void resetWorldSpecificSettings()
Description copied from interface: iEngine
Reset a subset of flags/settings (which may differ from one world/map to another) to its defaults.

Specified by:
resetWorldSpecificSettings in interface iEngine
See Also:
iEngine.resetWorldSpecificSettings()

setAmbientLight

public void setAmbientLight(csColor color)
Description copied from interface: iEngine
Set the amount of ambient light.

Specified by:
setAmbientLight in interface iEngine
Parameters:
color -
See Also:
iEngine.setAmbientLight(crystalspace.jbind.impl.csutil.cscolor.csColor)

setCacheManager

public void setCacheManager(iCacheManager cache_mgr)
Description copied from interface: iEngine
Set the cache manager that the engine will use.

Specified by:
setCacheManager in interface iEngine
Parameters:
cache_mgr -
See Also:
iEngine.setCacheManager(crystalspace.jbind.interfaces.iutil.cache.iCacheManager)

setClearScreen

public void setClearScreen(boolean yesno)
Description copied from interface: iEngine
Require that the screen is cleared every frame.

Specified by:
setClearScreen in interface iEngine
Parameters:
yesno -
See Also:
iEngine.setClearScreen(boolean)

setClearZBuf

public void setClearZBuf(boolean yesno)
Description copied from interface: iEngine
Require that the Z-buffer is cleared every frame.

Specified by:
setClearZBuf in interface iEngine
Parameters:
yesno -
See Also:
iEngine.setClearZBuf(boolean)

setContext

public void setContext(iTextureHandle ctxt)
Description copied from interface: iEngine
Set the drawing context.

Specified by:
setContext in interface iEngine
Parameters:
ctxt -
See Also:
iEngine.setContext(crystalspace.jbind.interfaces.ivideo.texture.iTextureHandle)

setCurrentDefaultRenderloop

public boolean setCurrentDefaultRenderloop(iRenderLoop loop)
Description copied from interface: iEngine
Set the current render loop.

Specified by:
setCurrentDefaultRenderloop in interface iEngine
Parameters:
loop -
Returns:
See Also:
iEngine.setCurrentDefaultRenderloop(crystalspace.jbind.interfaces.iengine.renderloop.iRenderLoop)

setMaxLightmapSize

public void setMaxLightmapSize(int w,
                               int h)
Description copied from interface: iEngine
Set the maximum lightmap dimensions.

Specified by:
setMaxLightmapSize in interface iEngine
Parameters:
w -
h -
See Also:
iEngine.setMaxLightmapSize(int, int)

setRenderPriorityCamera

public void setRenderPriorityCamera(long priority,
                                    boolean do_camera)
Description copied from interface: iEngine
Set the render priority camera flag.

Specified by:
setRenderPriorityCamera in interface iEngine
Parameters:
priority -
do_camera -
See Also:
iEngine.setRenderPriorityCamera(long, boolean)

shineLights

public void shineLights()
Description copied from interface: iEngine
Calculate all lighting information.

Specified by:
shineLights in interface iEngine
See Also:
iEngine.shineLights()

shineLights

public void shineLights(iRegion region,
                        iProgressMeter meter)
Description copied from interface: iEngine
Calculate all lighting information.

Specified by:
shineLights in interface iEngine
Parameters:
region -
meter -
See Also:
iEngine.shineLights(crystalspace.jbind.interfaces.iengine.region.iRegion, crystalspace.jbind.interfaces.ivaria.pmeter.iProgressMeter)

shineLights

public void shineLights(iRegion region)
Description copied from interface: iEngine
Calculate all lighting information.

Specified by:
shineLights in interface iEngine
Parameters:
region -
See Also:
iEngine.shineLights(crystalspace.jbind.interfaces.iengine.region.iRegion)

wantToDie

public void wantToDie(iMeshWrapper mesh)
Description copied from interface: iEngine
Sometimes a mesh wants to destruct itself (for example a particle system that has only limited lifetime).

Specified by:
wantToDie in interface iEngine
Parameters:
mesh -
See Also:
iEngine.wantToDie(crystalspace.jbind.interfaces.iengine.mesh.iMeshWrapper)