com.jme3.shader

Class ShaderNodeVariable

java.lang.Object

com.jme3.shader.ShaderNodeVariable

All Implemented Interfaces:

Savable, java.lang.Cloneable

public class ShaderNodeVariable
extends java.lang.Object
implements Savable, java.lang.Cloneable

A shader node variable

Constructor Summary

Constructors

Constructor and Description
ShaderNodeVariable(java.lang.String type, java.lang.String name) creates a ShaderNodeVariable
ShaderNodeVariable(java.lang.String type, java.lang.String nameSpace, java.lang.String name) creates a ShaderNodeVariable
ShaderNodeVariable(java.lang.String type, java.lang.String nameSpace, java.lang.String name, java.lang.String multiplicity) creates a ShaderNodeVariable
ShaderNodeVariable(java.lang.String type, java.lang.String nameSpace, java.lang.String name, java.lang.String multiplicity, java.lang.String prefix) creates a ShaderNodeVariable

Method Summary

Modifier and Type	Method and Description
ShaderNodeVariable	clone()
boolean	equals(java.lang.Object obj)
java.lang.String	getCondition()
java.lang.String	getDefaultValue() Gets the default value of this variable.
java.lang.String	getMultiplicity()
java.lang.String	getName() returns the name
java.lang.String	getNameSpace()
java.lang.String	getPrefix()
java.lang.String	getType()
int	hashCode()
boolean	isShaderOutput()
void	read(JmeImporter im) jme serialization (not used)
void	setCondition(java.lang.String condition) sets the condition
void	setDefaultValue(java.lang.String defaultValue) Sets the default value of this variable.
void	setMultiplicity(java.lang.String multiplicity) sets the number of elements of this variable making it an array this value can be a number of can be a define
void	setName(java.lang.String name) sets the name
void	setNameSpace(java.lang.String nameSpace) sets the nameSpace (can be the name of the shaderNode or Global,Attr,MatParam,WorldParam)
void	setPrefix(java.lang.String prefix) Sets the variable prefix (m_ or g_)
void	setShaderOutput(boolean shaderOutput) sets to true if this variable is a shader output
void	setType(java.lang.String type) sets the glsl type
java.lang.String	toString()
void	write(JmeExporter ex) jme serialization (not used)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ShaderNodeVariable

public ShaderNodeVariable(java.lang.String type,
                          java.lang.String name)

creates a ShaderNodeVariable

Parameters:

type - the glsl type of the variable

name - the name of the variable

ShaderNodeVariable

public ShaderNodeVariable(java.lang.String type,
                          java.lang.String nameSpace,
                          java.lang.String name,
                          java.lang.String multiplicity)

creates a ShaderNodeVariable

Parameters:

type - the glsl type of the variable

nameSpace - the nameSpace (can be the name of the shaderNode or Global,Attr,MatParam,WorldParam)

name - the name of the variable

multiplicity - the number of element if this variable is an array. Can be an Int of a declared material parameter

ShaderNodeVariable

public ShaderNodeVariable(java.lang.String type,
                          java.lang.String nameSpace,
                          java.lang.String name,
                          java.lang.String multiplicity,
                          java.lang.String prefix)

creates a ShaderNodeVariable

Parameters:

type - the glsl type of the variable

nameSpace - the nameSpace (can be the name of the shaderNode or Global,Attr,MatParam,WorldParam)

name - the name of the variable

multiplicity - the number of element if this variable is an array. Can be an Int of a declared material parameter

prefix - the variable prefix to append at generation times. This is mostly to add the g_ and m_ for uniforms

ShaderNodeVariable

public ShaderNodeVariable(java.lang.String type,
                          java.lang.String nameSpace,
                          java.lang.String name)

creates a ShaderNodeVariable

Parameters:

type - the glsl type of the variable

nameSpace - the nameSpace (can be the name of the shaderNode or Global,Attr,MatParam,WorldParam)

name - the name of the variable

Method Detail

getName

public java.lang.String getName()

returns the name

Returns:

the name

setName

public void setName(java.lang.String name)

sets the name

Parameters:

name - the name

getType

public java.lang.String getType()

Returns:

the glsl type

setType

public void setType(java.lang.String type)

sets the glsl type

Parameters:

type - the type

getNameSpace

public java.lang.String getNameSpace()

Returns:

the name space (can be the name of the shaderNode or Global,Attr,MatParam,WorldParam)

getPrefix

public java.lang.String getPrefix()

Returns:

the variable prefix

setPrefix

public void setPrefix(java.lang.String prefix)

Sets the variable prefix (m_ or g_)

Parameters:

prefix - the desired prefix

setNameSpace

public void setNameSpace(java.lang.String nameSpace)

sets the nameSpace (can be the name of the shaderNode or Global,Attr,MatParam,WorldParam)

Parameters:

nameSpace - the desired nameSpace

getDefaultValue

public java.lang.String getDefaultValue()

Gets the default value of this variable.

Returns:

the default value of this variable.

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

Sets the default value of this variable.

Parameters:

defaultValue - the default value of this variable.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

write

public void write(JmeExporter ex)
           throws java.io.IOException

jme serialization (not used)

Specified by:

write in interface Savable

Parameters:

ex - the exporter

Throws:

java.io.IOException - from the exporter

read

public void read(JmeImporter im)
          throws java.io.IOException

jme serialization (not used)

Specified by:

read in interface Savable

Parameters:

im - the importer

Throws:

java.io.IOException - from the importer

getCondition

public java.lang.String getCondition()

Returns:

the condition for this variable to be declared

setCondition

public void setCondition(java.lang.String condition)

sets the condition

Parameters:

condition - the condition

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isShaderOutput

public boolean isShaderOutput()

Returns:

true if this variable is a shader output

setShaderOutput

public void setShaderOutput(boolean shaderOutput)

sets to true if this variable is a shader output

Parameters:

shaderOutput - true if this variable is a shader output

getMultiplicity

public java.lang.String getMultiplicity()

Returns:

the number of elements if this variable is an array

setMultiplicity

public void setMultiplicity(java.lang.String multiplicity)

sets the number of elements of this variable making it an array this value can be a number of can be a define

Parameters:

multiplicity - the desired expression

clone

public ShaderNodeVariable clone()
                         throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException