/*
* Copyright (c) 2009-2012 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* * Neither the name of 'jMonkeyEngine' nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.jme3.shader;
import com.jme3.export.InputCapsule;
import com.jme3.export.JmeExporter;
import com.jme3.export.JmeImporter;
import com.jme3.export.OutputCapsule;
import com.jme3.export.Savable;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
/**
* 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 ouput mapping.
*
* This class is not intended to be used by JME users directly. It's the
* stucture for loading shader nodes from a J3md ùaterial definition file
*
* @author Nehon
*/
public class ShaderNode implements Savable {
private String name;
private ShaderNodeDefinition definition;
private String condition;
private List<VariableMapping> inputMapping = new ArrayList<VariableMapping>();
private List<VariableMapping> outputMapping = new ArrayList<VariableMapping>();
/**
* creates a ShaderNode
*
* @param name the name
* @param definition the ShaderNodeDefinition
* @param condition the conditionto activate this node
*/
public ShaderNode(String name, ShaderNodeDefinition definition, String condition) {
this.name = name;
this.definition = definition;
this.condition = condition;
}
/**
* creates a ShaderNode
*/
public ShaderNode() {
}
/**
*
* @return the name of the node
*/
public String getName() {
return name;
}
/**
* sets the name of th node
*
* @param name the name
*/
public void setName(String name) {
this.name = name;
}
/**
* returns the definition
*
* @return the ShaderNodeDefinition
*/
public ShaderNodeDefinition getDefinition() {
return definition;
}
/**
* sets the definition
*
* @param definition the ShaderNodeDefinition
*/
public void setDefinition(ShaderNodeDefinition definition) {
this.definition = definition;
}
/**
*
* @return the condition
*/
public String getCondition() {
return condition;
}
/**
* sets the ocndition
*
* @param condition the condition
*/
public void setCondition(String condition) {
this.condition = condition;
}
/**
* return a list of VariableMapping representing the input mappings of this
* node
*
* @return the input mappings
*/
public List<VariableMapping> getInputMapping() {
return inputMapping;
}
/**
* sets the input mappings
*
* @param inputMapping the input mappings
*/
public void setInputMapping(List<VariableMapping> inputMapping) {
this.inputMapping = inputMapping;
}
/**
* return a list of VariableMapping representing the output mappings of this
* node
*
* @return the output mappings
*/
public List<VariableMapping> getOutputMapping() {
return outputMapping;
}
/**
* sets the output mappings
*
* @param inputMapping the output mappings
*/
public void setOutputMapping(List<VariableMapping> outputMapping) {
this.outputMapping = outputMapping;
}
/**
* jme seralization
*
* @param ex the exporter
* @throws IOException
*/
@Override
public void write(JmeExporter ex) throws IOException {
OutputCapsule oc = (OutputCapsule) ex.getCapsule(this);
oc.write(name, "name", "");
oc.write(definition, "definition", null);
oc.write(condition, "condition", null);
oc.writeSavableArrayList((ArrayList) inputMapping, "inputMapping", new ArrayList<VariableMapping>());
oc.writeSavableArrayList((ArrayList) outputMapping, "outputMapping", new ArrayList<VariableMapping>());
}
/**
* jme seralization
*
* @param im the importer
* @throws IOException
*/
@Override
public void read(JmeImporter im) throws IOException {
InputCapsule ic = (InputCapsule) im.getCapsule(this);
name = ic.readString("name", "");
definition = (ShaderNodeDefinition) ic.readSavable("definition", null);
condition = ic.readString("condition", null);
inputMapping = (List<VariableMapping>) ic.readSavableArrayList("inputMapping", new ArrayList<VariableMapping>());
outputMapping = (List<VariableMapping>) ic.readSavableArrayList("outputMapping", new ArrayList<VariableMapping>());
}
/**
* convenience tostring
*
* @return a string
*/
@Override
public String toString() {
return "\nShaderNode{" + "\nname=" + name + ", \ndefinition=" + definition.getName() + ", \ncondition=" + condition + ", \ninputMapping=" + inputMapping + ", \noutputMapping=" + outputMapping + '}';
}
}