crystalspace.jbind.impl.video.effects.efdef
Class csEffectDefinition

java.lang.Object
  crystalspace.jbind.impl.csNativeObject
      crystalspace.jbind.impl.csutil.scf.csBase
          crystalspace.jbind.impl.video.effects.efdef.csEffectDefinition

All Implemented Interfaces:

iBase, iEffectDefinition, iPointer

public class csEffectDefinition

extends csBase

implements iEffectDefinition

Author:

Quentin Anciaux

Field Summary

Fields inherited from class crystalspace.jbind.impl.csNativeObject

ImplFactory, nPointer

Constructor Summary

csEffectDefinition(iPointer nPointer)

Method Summary

iEffectTechnique	createTechnique() Create a new technique.
java.lang.String	getName() Retrieve name of effect.
iEffectTechnique	getTechnique(int technique) Retrieve a technique.
int	getTechniqueCount() Get number of techniques.
float	getVariableFloat(int variableID) Get variable value as float.
int	getVariableID(int string) Get/create variable.
int	getVariableID(int string, boolean create) Get/create variable.
char	getVariableType(int variableID) Get varaibletype.
csEffectVector4	getVariableVector4(int variableID) Get variable value as csEffectVector4.
int	getVersion() Return the version of the interface
protected boolean	isNativePointerValidSafe(long pointer)
void	setName(java.lang.String name) Set this Effect's name.
void	setVariableFloat(int variableID, float value) Set variable value as float.
void	setVariableVector4(int variableID, csEffectVector4 value) Set variable value as vector4.

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

csEffectDefinition

public csEffectDefinition(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: iEffectDefinition

Retrieve name of effect.

Specified by:

getName in interface iEffectDefinition

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)

createTechnique

public iEffectTechnique createTechnique()

Description copied from interface: iEffectDefinition

Create a new technique.

Specified by:

createTechnique in interface iEffectDefinition

Returns:

See Also:

iEffectDefinition.createTechnique()

getTechnique

public iEffectTechnique getTechnique(int technique)

Description copied from interface: iEffectDefinition

Retrieve a technique.

Specified by:

getTechnique in interface iEffectDefinition

Parameters:

technique -

Returns:

See Also:

iEffectDefinition.getTechnique(int)

getTechniqueCount

public int getTechniqueCount()

Description copied from interface: iEffectDefinition

Get number of techniques.

Specified by:

getTechniqueCount in interface iEffectDefinition

Returns:

See Also:

iEffectDefinition.getTechniqueCount()

getVariableFloat

public float getVariableFloat(int variableID)

Description copied from interface: iEffectDefinition

Get variable value as float.

Specified by:

getVariableFloat in interface iEffectDefinition

Parameters:

variableID -

Returns:

See Also:

iEffectDefinition.getVariableFloat(int)

getVariableID

public int getVariableID(int string)

Description copied from interface: iEffectDefinition

Get/create variable.

Specified by:

getVariableID in interface iEffectDefinition

Parameters:

string -

Returns:

See Also:

iEffectDefinition.getVariableID(int)

getVariableID

public int getVariableID(int string,
                         boolean create)

Description copied from interface: iEffectDefinition

Get/create variable.

Specified by:

getVariableID in interface iEffectDefinition

Parameters:

string -

create -

Returns:

See Also:

iEffectDefinition.getVariableID(int, boolean)

getVariableType

public char getVariableType(int variableID)

Description copied from interface: iEffectDefinition

Get varaibletype.

Specified by:

getVariableType in interface iEffectDefinition

Parameters:

variableID -

Returns:

See Also:

iEffectDefinition.getVariableType(int)

getVariableVector4

public csEffectVector4 getVariableVector4(int variableID)

Description copied from interface: iEffectDefinition

Get variable value as csEffectVector4.

Specified by:

getVariableVector4 in interface iEffectDefinition

Parameters:

variableID -

Returns:

See Also:

iEffectDefinition.getVariableVector4(int)

setName

public void setName(java.lang.String name)

Description copied from interface: iEffectDefinition

Set this Effect's name.

Specified by:

setName in interface iEffectDefinition

Parameters:

name -

See Also:

iEffectDefinition.setName(java.lang.String)

setVariableFloat

public void setVariableFloat(int variableID,
                             float value)

Description copied from interface: iEffectDefinition

Set variable value as float.

Specified by:

setVariableFloat in interface iEffectDefinition

Parameters:

variableID -

value -

See Also:

iEffectDefinition.setVariableFloat(int, float)

setVariableVector4

public void setVariableVector4(int variableID,
                               csEffectVector4 value)

Description copied from interface: iEffectDefinition

Set variable value as vector4.

Specified by:

setVariableVector4 in interface iEffectDefinition

Parameters:

variableID -

value -

See Also:

iEffectDefinition.setVariableVector4(int, crystalspace.jbind.impl.video.effects.efvector4.csEffectVector4)