crystalspace.jbind.impl.engine.renderloop
Class csRenderLoopManager

java.lang.Object
  crystalspace.jbind.impl.csNativeObject
      crystalspace.jbind.impl.csutil.scf.csBase
          crystalspace.jbind.impl.engine.renderloop.csRenderLoopManager

All Implemented Interfaces:

iBase, iPointer, iRenderLoopManager

public class csRenderLoopManager

extends csBase

implements iRenderLoopManager

Author:

Quentin Anciaux

Field Summary

Fields inherited from class crystalspace.jbind.impl.csNativeObject

ImplFactory, nPointer

Constructor Summary

csRenderLoopManager(iPointer nPointer)

Method Summary

iRenderLoop	create() Create a new render loop.
java.lang.String	getName() Return the name of the interface
java.lang.String	getName(iRenderLoop loop) Get the name asociated to the render loop.
int	getVersion() Return the version of the interface
protected boolean	isNativePointerValidSafe(long pointer)
boolean	register(java.lang.String name, iRenderLoop loop) Associate a name with a renderloop.
iRenderLoop	retrieve(java.lang.String name) Get the render loop associated with the name.
boolean	unregister(iRenderLoop loop) Remove an association between a name and a render loop.

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

csRenderLoopManager

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

create

public iRenderLoop create()

Description copied from interface: iRenderLoopManager

Create a new render loop. Remarks: This render loop is "unnamed". To name it, use Register().

Specified by:

create in interface iRenderLoopManager

Returns:

See Also:

iRenderLoopManager.create()

getName

public java.lang.String getName(iRenderLoop loop)

Description copied from interface: iRenderLoopManager

Get the name asociated to the render loop. Parameters: loop Render loop which associated name is to be retrieved. Returns: Name of the loop. 0 if the loop isn't registered.

Specified by:

getName in interface iRenderLoopManager

Parameters:

loop -

Returns:

See Also:

iRenderLoopManager.getName(crystalspace.jbind.interfaces.iengine.renderloop.iRenderLoop)

register

public boolean register(java.lang.String name,
                        iRenderLoop loop)

Description copied from interface: iRenderLoopManager

Associate a name with a renderloop. One name is associated with one render loop. If you try to register a loop with a name that is already used, Register() will fail. Parameters: name Name the render loop is registered with. loop The render loop. Returns: Whether the loop could be registered with the name. Fails if either the name is already used or the loop is already registered.

Specified by:

register in interface iRenderLoopManager

Parameters:

name -

loop -

Returns:

See Also:

iRenderLoopManager.register(java.lang.String, crystalspace.jbind.interfaces.iengine.renderloop.iRenderLoop)

retrieve

public iRenderLoop retrieve(java.lang.String name)

Description copied from interface: iRenderLoopManager

Get the render loop associated with the name. Parameters: name Name for which the renderloop is to be retrieved. Returns: The render loop associated with the name, or 0 when no loop is registered with that name.

Specified by:

retrieve in interface iRenderLoopManager

Parameters:

name -

Returns:

See Also:

iRenderLoopManager.retrieve(java.lang.String)

unregister

public boolean unregister(iRenderLoop loop)

Description copied from interface: iRenderLoopManager

Remove an association between a name and a render loop. Parameters: loop Render loop which associated name should be removed. Returns: Whether the association was successfully removed.

Specified by:

unregister in interface iRenderLoopManager

Parameters:

loop -

Returns:

See Also:

iRenderLoopManager.unregister(crystalspace.jbind.interfaces.iengine.renderloop.iRenderLoop)