com.jme3.shader

Class ShaderNode

java.lang.Object

com.jme3.shader.ShaderNode

All Implemented Interfaces:

Savable, java.lang.Cloneable

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

A ShaderNode is the unit brick part of a shader program. A shader can be describe with several shader nodes that are plugged together through inputs and outputs. A ShaderNode is based on a definition that has a shader code, inputs and output variables. This node can be activated based on a condition, and has input and output mapping. This class is not intended to be used by JME users directly. It's the structure for loading shader nodes from a J3md material definition file

Constructor Summary

Constructors

Constructor and Description
ShaderNode() Creates a shader node.
ShaderNode(java.lang.String name, ShaderNodeDefinition definition, java.lang.String condition) Creates a shader node.

Method Summary

Modifier and Type	Method and Description
ShaderNode	clone()
java.lang.String	getCondition() Gets the condition.
ShaderNodeDefinition	getDefinition() Returns the shader node definition.
java.util.List<VariableMapping>	getInputMapping() Returns a list of variable mapping representing the input mappings of this node.
java.lang.String	getName() Gets the name of the node.
java.util.List<VariableMapping>	getOutputMapping() Returns a list of variable mapping representing the output mappings of this node.
void	read(JmeImporter im) jme serialization
void	setCondition(java.lang.String condition) Sets the condition.
void	setDefinition(ShaderNodeDefinition definition) Sets the shader node definition.
void	setInputMapping(java.util.List<VariableMapping> inputMapping) Sets the input mappings.
void	setName(java.lang.String name) Sets the name of the node.
void	setOutputMapping(java.util.List<VariableMapping> outputMapping) Sets the output mappings.
java.lang.String	toString() convenience tostring
void	write(JmeExporter ex) jme serialization

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ShaderNode

public ShaderNode(java.lang.String name,
                  ShaderNodeDefinition definition,
                  java.lang.String condition)

Creates a shader node.

Parameters:

name - the name.

definition - the shader node definition.

condition - the condition to activate this node.

ShaderNode

public ShaderNode()

Creates a shader node.

Method Detail

getName

public java.lang.String getName()

Gets the name of the node.

Returns:

the name of the node

setName

public void setName(java.lang.String name)

Sets the name of the node.

Parameters:

name - the name of the node.

getDefinition

public ShaderNodeDefinition getDefinition()

Returns the shader node definition.

Returns:

the shader node definition.

setDefinition

public void setDefinition(ShaderNodeDefinition definition)

Sets the shader node definition.

Parameters:

definition - the shader node definition.

getCondition

public java.lang.String getCondition()

Gets the condition.

Returns:

the condition.

setCondition

public void setCondition(java.lang.String condition)

Sets the condition.

Parameters:

condition - the condition.

getInputMapping

public java.util.List<VariableMapping> getInputMapping()

Returns a list of variable mapping representing the input mappings of this node.

Returns:

the input mappings.

setInputMapping

public void setInputMapping(java.util.List<VariableMapping> inputMapping)

Sets the input mappings.

Parameters:

inputMapping - the input mappings.

getOutputMapping

public java.util.List<VariableMapping> getOutputMapping()

Returns a list of variable mapping representing the output mappings of this node.

Returns:

the output mappings.

setOutputMapping

public void setOutputMapping(java.util.List<VariableMapping> outputMapping)

Sets the output mappings.

Parameters:

outputMapping - the output mappings.

write

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

jme serialization

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

Specified by:

read in interface Savable

Parameters:

im - the importer

Throws:

java.io.IOException - from the importer

toString

public java.lang.String toString()

convenience tostring

Overrides:

toString in class java.lang.Object

Returns:

a string

clone

public ShaderNode clone()
                 throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException