TechniqueDef (jMonkeyEngine3)

java.lang.Object
- com.jme3.material.TechniqueDef

All Implemented Interfaces:: Savable, java.lang.Cloneable

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

Describes a technique definition.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TechniqueDef.LightMode` Describes light rendering mode.
`static class`	`TechniqueDef.LightSpace` Define in what space the light data should be sent to the shader.
`static class`	`TechniqueDef.ShadowMode`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_TECHNIQUE_NAME` The default technique name.
`static int`	`SAVABLE_VERSION` Version #1: Separate shader language for each shader source.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`TechniqueDef()` Serialization only.
	`TechniqueDef(java.lang.String name, int sortId)` Creates a new technique definition.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addShaderParamDefine(java.lang.String paramName, VarType paramType, java.lang.String defineName)` Adds a define linked to a material parameter.
`int`	`addShaderUnmappedDefine(java.lang.String defineName, VarType defineType)` Add an unmapped define which can only be set by define ID.
`boolean`	`addWorldParam(java.lang.String name)` Adds a new world parameter by the given name.
`TechniqueDef`	`clone()`
`DefineList`	`createDefineList()` Create a define list with the size matching the number of defines on this technique.
`VarType`	`getDefineIdType(int defineId)` Get the type of a particular define.
`java.lang.String[]`	`getDefineNames()` Get the names of all defines declared on this technique definition.
`VarType[]`	`getDefineTypes()` Get the types of all defines declared on this technique definition.
`RenderState`	`getForcedRenderState()`
`java.lang.String`	`getFragmentShaderLanguage()` Returns the language of the fragment shader used in this technique.
`java.lang.String`	`getFragmentShaderName()` Returns the name of the fragment shader used by the technique, or null if no fragment shader is specified.
`TechniqueDef.LightMode`	`getLightMode()` Returns the light mode.
`TechniqueDef.LightSpace`	`getLightSpace()` Returns the space in which the light data should be passed to the shader.
`TechniqueDefLogic`	`getLogic()`
`java.lang.String`	`getName()` Returns the name of this technique as specified in the J3MD file.
`RenderState`	`getRenderState()` Returns the render state that this technique is using
`java.util.EnumSet<Caps>`	`getRequiredCaps()` Gets the `renderer capabilities` that are required by this technique.
`Shader`	`getShader(AssetManager assetManager, java.util.EnumSet<Caps> rendererCaps, DefineList defines)`
`ShaderGenerationInfo`	`getShaderGenerationInfo()`
`java.util.List<ShaderNode>`	`getShaderNodes()`
`java.lang.String`	`getShaderParamDefine(java.lang.String paramName)` Returns the define name which the given material parameter influences.
`java.lang.Integer`	`getShaderParamDefineId(java.lang.String paramName)` Get the define ID for a given material parameter.
`java.lang.String`	`getShaderProgramLanguage(Shader.ShaderType shaderType)` Returns the language for each shader program
`java.util.EnumMap<Shader.ShaderType,java.lang.String>`	`getShaderProgramLanguages()` Returns the Enum containing the ShaderProgramLanguages;
`java.lang.String`	`getShaderProgramName(Shader.ShaderType shaderType)` Returns the name for each shader program
`java.util.EnumMap<Shader.ShaderType,java.lang.String>`	`getShaderProgramNames()` Returns the Enum containing the ShaderProgramNames;
`java.lang.String`	`getShaderPrologue()`
`TechniqueDef.ShadowMode`	`getShadowMode()` Returns the shadow mode.
`int`	`getSortId()`
`java.lang.String`	`getVertexShaderLanguage()` Returns the language of the vertex shader used in this technique.
`java.lang.String`	`getVertexShaderName()` Returns the name of the vertex shader used by the technique, or null if no vertex shader is specified.
`float`	`getWeight()` returns the weight of the technique def
`java.util.List<UniformBinding>`	`getWorldBindings()` Returns a list of world parameters that are used by this technique definition.
`boolean`	`isNoRender()` Returns true if this technique should not be used to render.
`boolean`	`isUsingShaderNodes()` Returns true if this technique uses Shader Nodes, false otherwise.
`void`	`read(JmeImporter im)`
`void`	`setForcedRenderState(RenderState forcedRenderState)`
`void`	`setLightMode(TechniqueDef.LightMode lightMode)` Set the light mode
`void`	`setLightSpace(TechniqueDef.LightSpace lightSpace)` Sets the space in which the light data should be passed to the shader.
`void`	`setLogic(TechniqueDefLogic logic)`
`void`	`setNoRender(boolean noRender)` Sets if this technique should not be used to render.
`void`	`setRenderState(RenderState renderState)` Sets the render state that this technique is using.
`void`	`setShaderFile(java.util.EnumMap<Shader.ShaderType,java.lang.String> shaderNames, java.util.EnumMap<Shader.ShaderType,java.lang.String> shaderLanguages)` Sets the shaders that this technique definition will use.
`void`	`setShaderFile(java.lang.String vertexShader, java.lang.String fragmentShader, java.lang.String vertLanguage, java.lang.String fragLanguage)` Sets the shaders that this technique definition will use.
`void`	`setShaderGenerationInfo(ShaderGenerationInfo shaderGenerationInfo)`
`void`	`setShaderNodes(java.util.List<ShaderNode> shaderNodes)`
`void`	`setShaderPrologue(java.lang.String shaderPrologue)` Set a string which is prepended to every shader used by this technique.
`void`	`setShadowMode(TechniqueDef.ShadowMode shadowMode)` Set the shadow mode.
`java.lang.String`	`toString()`
`void`	`write(JmeExporter ex)`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SAVABLE_VERSION
```
public static final int SAVABLE_VERSION
```
    Version #1: Separate shader language for each shader source.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TECHNIQUE_NAME
```
public static final java.lang.String DEFAULT_TECHNIQUE_NAME
```
    The default technique name. The technique with this name is selected if no specific technique is requested by the user. Currently set to "Default".
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TechniqueDef
```
public TechniqueDef(java.lang.String name,
                    int sortId)
```
    Creates a new technique definition.
    Used internally by the J3M/J3MD loader.
    
    Parameters:
    
    name - The name of the technique
  - TechniqueDef
```
protected TechniqueDef()
```
    Serialization only. Do not use.
- Method Detail
  - getSortId
```
public int getSortId()
```
    Returns:
    
    A unique sort ID. No other technique definition can have the same ID.
  - getName
```
public java.lang.String getName()
```
    Returns the name of this technique as specified in the J3MD file. Default techniques have the name DEFAULT_TECHNIQUE_NAME.
    
    Returns:
    
    the name of this technique
  - getLightMode
```
public TechniqueDef.LightMode getLightMode()
```
    Returns the light mode.
    
    Returns:
    
    the light mode.
    
    See Also:
    
    TechniqueDef.LightMode
  - setLightMode
```
public void setLightMode(TechniqueDef.LightMode lightMode)
```
    Set the light mode
    
    Parameters:
    
    lightMode - the light mode
    
    See Also:
    
    TechniqueDef.LightMode
  - setLogic
```
public void setLogic(TechniqueDefLogic logic)
```
  - getLogic
```
public TechniqueDefLogic getLogic()
```
  - getShadowMode
```
public TechniqueDef.ShadowMode getShadowMode()
```
    Returns the shadow mode.
    
    Returns:
    
    the shadow mode.
  - setShadowMode
```
public void setShadowMode(TechniqueDef.ShadowMode shadowMode)
```
    Set the shadow mode.
    
    Parameters:
    
    shadowMode - the shadow mode.
    
    See Also:
    
    TechniqueDef.ShadowMode
  - getRenderState
```
public RenderState getRenderState()
```
    Returns the render state that this technique is using
    
    Returns:
    
    the render state that this technique is using
    
    See Also:
    
    setRenderState(com.jme3.material.RenderState)
  - setRenderState
```
public void setRenderState(RenderState renderState)
```
    Sets the render state that this technique is using.
    
    Parameters:
    
    renderState - the render state that this technique is using.
    
    See Also:
    
    RenderState
  - setNoRender
```
public void setNoRender(boolean noRender)
```
    Sets if this technique should not be used to render.
    
    Parameters:
    
    noRender - not render or render ?
    
    See Also:
    
    isNoRender()
  - isNoRender
```
public boolean isNoRender()
```
    Returns true if this technique should not be used to render. (eg. to not render a material with default technique)
    
    Returns:
    
    true if this technique should not be rendered, false otherwise.
  - isUsingShaderNodes
```
public boolean isUsingShaderNodes()
```
    Returns true if this technique uses Shader Nodes, false otherwise.
    
    Returns:
    
    true if this technique uses Shader Nodes, false otherwise.
  - getRequiredCaps
```
public java.util.EnumSet<Caps> getRequiredCaps()
```
    Gets the renderer capabilities that are required by this technique.
    
    Returns:
    
    the required renderer capabilities
  - setShaderFile
```
public void setShaderFile(java.lang.String vertexShader,
                          java.lang.String fragmentShader,
                          java.lang.String vertLanguage,
                          java.lang.String fragLanguage)
```
    Sets the shaders that this technique definition will use.
    
    Parameters:
    
    vertexShader - The name of the vertex shader
    
    fragmentShader - The name of the fragment shader
    
    vertLanguage - The vertex shader language
    
    fragLanguage - The fragment shader language
  - setShaderPrologue
```
public void setShaderPrologue(java.lang.String shaderPrologue)
```
    Set a string which is prepended to every shader used by this technique. Typically this is used for preset defines.
    
    Parameters:
    
    shaderPrologue - The prologue to append before the technique's shaders.
  - getShaderPrologue
```
public java.lang.String getShaderPrologue()
```
    Returns:
    
    the shader prologue which is prepended to every shader.
  - getShaderParamDefine
```
public java.lang.String getShaderParamDefine(java.lang.String paramName)
```
    Returns the define name which the given material parameter influences.
    
    Parameters:
    
    paramName - The parameter name to look up
    
    Returns:
    
    The define name
    
    See Also:
    
    addShaderParamDefine(java.lang.String, com.jme3.shader.VarType, java.lang.String)
  - getShaderParamDefineId
```
public java.lang.Integer getShaderParamDefineId(java.lang.String paramName)
```
    Get the define ID for a given material parameter.
    
    Parameters:
    
    paramName - The parameter name to look up
    
    Returns:
    
    The define ID, or null if not found.
  - getDefineIdType
```
public VarType getDefineIdType(int defineId)
```
    Get the type of a particular define.
    
    Parameters:
    
    defineId - The define ID to lookup.
    
    Returns:
    
    The type of the define, or null if not found.
  - addShaderParamDefine
```
public void addShaderParamDefine(java.lang.String paramName,
                                 VarType paramType,
                                 java.lang.String defineName)
```
    Adds a define linked to a material parameter.
    Any time the material parameter on the parent material is altered, the appropriate define on the technique will be modified as well. When set, the material parameter will be mapped to an integer define, typically 1 if it is set, unless it is an integer or a float, in which case it will converted into an integer.
    
    Parameters:
    
    paramName - The name of the material parameter to link to.
    
    paramType - The type of the material parameter to link to.
    
    defineName - The name of the define parameter, e.g. USE_LIGHTING
  - addShaderUnmappedDefine
```
public int addShaderUnmappedDefine(java.lang.String defineName,
                                   VarType defineType)
```
    Add an unmapped define which can only be set by define ID. Unmapped defines are used by technique renderers to configure the shader internally before rendering.
    
    Parameters:
    
    defineName - The define name to create
    
    Returns:
    
    The define ID of the created define
  - getDefineNames
```
public java.lang.String[] getDefineNames()
```
    Get the names of all defines declared on this technique definition. The defines are returned in order of declaration.
    
    Returns:
    
    the names of all defines declared.
  - getDefineTypes
```
public VarType[] getDefineTypes()
```
    Get the types of all defines declared on this technique definition. The types are returned in order of declaration.
    
    Returns:
    
    the types of all defines declared.
  - createDefineList
```
public DefineList createDefineList()
```
    Create a define list with the size matching the number of defines on this technique.
    
    Returns:
    
    a define list with the size matching the number of defines on this technique.
  - getShader
```
public Shader getShader(AssetManager assetManager,
                        java.util.EnumSet<Caps> rendererCaps,
                        DefineList defines)
```
  - setShaderFile
```
public void setShaderFile(java.util.EnumMap<Shader.ShaderType,java.lang.String> shaderNames,
                          java.util.EnumMap<Shader.ShaderType,java.lang.String> shaderLanguages)
```
    Sets the shaders that this technique definition will use.
    
    Parameters:
    
    shaderNames - EnumMap containing all shader names for this stage
    
    shaderLanguages - EnumMap containing all shader languages for this stage
  - getFragmentShaderName
```
public java.lang.String getFragmentShaderName()
```
    Returns the name of the fragment shader used by the technique, or null if no fragment shader is specified.
    
    Returns:
    
    the name of the fragment shader to be used.
  - getVertexShaderName
```
public java.lang.String getVertexShaderName()
```
    Returns the name of the vertex shader used by the technique, or null if no vertex shader is specified.
    
    Returns:
    
    the name of the vertex shader to be used.
  - getFragmentShaderLanguage
```
public java.lang.String getFragmentShaderLanguage()
```
    Returns the language of the fragment shader used in this technique.
  - getVertexShaderLanguage
```
public java.lang.String getVertexShaderLanguage()
```
    Returns the language of the vertex shader used in this technique.
  - getShaderProgramLanguage
```
public java.lang.String getShaderProgramLanguage(Shader.ShaderType shaderType)
```
    Returns the language for each shader program
    
    Parameters:
    
    shaderType -
  - getShaderProgramName
```
public java.lang.String getShaderProgramName(Shader.ShaderType shaderType)
```
    Returns the name for each shader program
    
    Parameters:
    
    shaderType -
  - getWeight
```
public float getWeight()
```
    returns the weight of the technique def
    
    Returns:
    
    the weight
  - addWorldParam
```
public boolean addWorldParam(java.lang.String name)
```
    Adds a new world parameter by the given name.
    
    Parameters:
    
    name - The world parameter to add.
    
    Returns:
    
    True if the world parameter name was found and added to the list of world parameters, false otherwise.
  - getForcedRenderState
```
public RenderState getForcedRenderState()
```
  - setForcedRenderState
```
public void setForcedRenderState(RenderState forcedRenderState)
```
  - getWorldBindings
```
public java.util.List<UniformBinding> getWorldBindings()
```
    Returns a list of world parameters that are used by this technique definition.
    
    Returns:
    
    The list of world parameters
  - write
```
public void write(JmeExporter ex)
           throws java.io.IOException
```
    Specified by:
    
    write in interface Savable
    
    Throws:
    
    java.io.IOException
  - read
```
public void read(JmeImporter im)
          throws java.io.IOException
```
    Specified by:
    
    read in interface Savable
    
    Throws:
    
    java.io.IOException
  - getShaderNodes
```
public java.util.List<ShaderNode> getShaderNodes()
```
  - setShaderNodes
```
public void setShaderNodes(java.util.List<ShaderNode> shaderNodes)
```
  - getShaderProgramNames
```
public java.util.EnumMap<Shader.ShaderType,java.lang.String> getShaderProgramNames()
```
    Returns the Enum containing the ShaderProgramNames;
    
    Returns:
    
    the pre-existing EnumMap
  - getShaderProgramLanguages
```
public java.util.EnumMap<Shader.ShaderType,java.lang.String> getShaderProgramLanguages()
```
    Returns the Enum containing the ShaderProgramLanguages;
    
    Returns:
    
    the pre-existing EnumMap
  - getShaderGenerationInfo
```
public ShaderGenerationInfo getShaderGenerationInfo()
```
  - setShaderGenerationInfo
```
public void setShaderGenerationInfo(ShaderGenerationInfo shaderGenerationInfo)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getLightSpace
```
public TechniqueDef.LightSpace getLightSpace()
```
    Returns the space in which the light data should be passed to the shader.
    
    Returns:
    
    the light space
  - setLightSpace
```
public void setLightSpace(TechniqueDef.LightSpace lightSpace)
```
    Sets the space in which the light data should be passed to the shader.
    
    Parameters:
    
    lightSpace - the light space
  - clone
```
public TechniqueDef clone()
                   throws java.lang.CloneNotSupportedException
```
    Overrides:
    
    clone in class java.lang.Object
    
    Throws:
    
    java.lang.CloneNotSupportedException

Class TechniqueDef

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SAVABLE_VERSION

DEFAULT_TECHNIQUE_NAME

Constructor Detail

TechniqueDef

TechniqueDef

Method Detail

getSortId

getName

getLightMode

setLightMode

setLogic

getLogic

getShadowMode

setShadowMode

getRenderState

setRenderState

setNoRender

isNoRender

isUsingShaderNodes

getRequiredCaps

setShaderFile

setShaderPrologue

getShaderPrologue

getShaderParamDefine

getShaderParamDefineId

getDefineIdType

addShaderParamDefine

addShaderUnmappedDefine

getDefineNames

getDefineTypes

createDefineList

getShader

setShaderFile

getFragmentShaderName

getVertexShaderName

getFragmentShaderLanguage

getVertexShaderLanguage

getShaderProgramLanguage

getShaderProgramName

getWeight

addWorldParam

getForcedRenderState

setForcedRenderState

getWorldBindings

write

read

getShaderNodes

setShaderNodes

getShaderProgramNames

getShaderProgramLanguages

getShaderGenerationInfo

setShaderGenerationInfo

toString

getLightSpace

setLightSpace

clone