org.jogamp.java3d.utils.shader

Class SimpleShaderAppearance

java.lang.Object

org.jogamp.java3d.SceneGraphObject

org.jogamp.java3d.NodeComponent

org.jogamp.java3d.Appearance

org.jogamp.java3d.ShaderAppearance

org.jogamp.java3d.utils.shader.SimpleShaderAppearance

public class SimpleShaderAppearance
extends ShaderAppearance

SimpleShaderAppearance is a mechanism to quickly build shaders compatible with Java3D 1.7.0 Jogl2es2Pipeline. It will use the set components to determine the shader to use, for example if you set a material then it will add the lighting uniforms values and do the calculations Similarly if you set a texture it will sample from it. Sharing SimpleShaderAppearances (such as appears to be done by Box) will almost certainly cause problems, however the shader programs that are identical are automatically shared internally. If you want to see examples of the shader source use getVertexShaderSource and getFragmentShaderSource after setting up a SimpleShaderAppearance as you would have done for a regular Appearance Some pipeline data such as FogData are not used by this class and must be manually setup if desired. To use the auto builder simply construct using SimpleShaderAppearance() To force a flat shader use SimpleShaderAppearance(false, false) To force a colored line shader use SimpleShaderAppearance(new Color4f(1,0,1,1,)) Note, this defaults to the values for desktop, on ES hardware you must call SimpleShaderAppearance.setVersionES300(); or SimpleShaderAppearance.setVersionES100();

Author:

phil

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	alphaTestMethod
static java.lang.String	alphaTestUniforms
static java.lang.String	glFrontMaterial
static java.lang.String	glLightSource

Fields inherited from class org.jogamp.java3d.ShaderAppearance

ALLOW_SHADER_ATTRIBUTE_SET_READ, ALLOW_SHADER_ATTRIBUTE_SET_WRITE, ALLOW_SHADER_PROGRAM_READ, ALLOW_SHADER_PROGRAM_WRITE

Fields inherited from class org.jogamp.java3d.Appearance

ALLOW_COLORING_ATTRIBUTES_READ, ALLOW_COLORING_ATTRIBUTES_WRITE, ALLOW_LINE_ATTRIBUTES_READ, ALLOW_LINE_ATTRIBUTES_WRITE, ALLOW_MATERIAL_READ, ALLOW_MATERIAL_WRITE, ALLOW_POINT_ATTRIBUTES_READ, ALLOW_POINT_ATTRIBUTES_WRITE, ALLOW_POLYGON_ATTRIBUTES_READ, ALLOW_POLYGON_ATTRIBUTES_WRITE, ALLOW_RENDERING_ATTRIBUTES_READ, ALLOW_RENDERING_ATTRIBUTES_WRITE, ALLOW_TEXGEN_READ, ALLOW_TEXGEN_WRITE, ALLOW_TEXTURE_ATTRIBUTES_READ, ALLOW_TEXTURE_ATTRIBUTES_WRITE, ALLOW_TEXTURE_READ, ALLOW_TEXTURE_UNIT_STATE_READ, ALLOW_TEXTURE_UNIT_STATE_WRITE, ALLOW_TEXTURE_WRITE, ALLOW_TRANSPARENCY_ATTRIBUTES_READ, ALLOW_TRANSPARENCY_ATTRIBUTES_WRITE

Constructor Summary

Constructors

Constructor and Description
SimpleShaderAppearance() This will define the shader code based on the attributes set
SimpleShaderAppearance(boolean lit, boolean hasTexture)
SimpleShaderAppearance(Color3f color) Lines with a single color no texture, ignores vertex attribute of color

Method Summary

Modifier and Type	Method and Description
NodeComponent	cloneNodeComponent() Must implement or clones turn out to be ShaderAppearance
java.lang.String	getFragmentShaderSource()
java.lang.String	getVertexShaderSource()
void	rebuildShaders()
void	setColoringAttributes(ColoringAttributes coloringAttributes) Sets the coloringAttributes object to the specified object.
void	setLineAttributes(LineAttributes lineAttributes) Sets the lineAttributes object to the specified object.
void	setMaterial(Material material) Sets the material object to the specified object.
void	setPointAttributes(PointAttributes pointAttributes) Sets the pointAttributes object to the specified object.
void	setPolygonAttributes(PolygonAttributes polygonAttributes) Sets the polygonAttributes object to the specified object.
void	setRenderingAttributes(RenderingAttributes renderingAttributes) Sets the renderingAttributes object to the specified object.
void	setTexCoordGeneration(TexCoordGeneration texCoordGeneration) Sets the texCoordGeneration object to the specified object.
void	setTexture(Texture texture) Sets the texture object to the specified object.
void	setTextureAttributes(TextureAttributes textureAttributes) Note if the texture transform is updated after the TextureAttributes are set then rebuild will need to be called on this Appearance
void	setTextureUnitState(int index, TextureUnitState state) Sets the texture unit state object at the specified index within the texture unit state array to the specified object.
void	setTextureUnitState(TextureUnitState[] stateArray) Sets the texture unit state array for this appearance object to the specified array.
void	setTransparencyAttributes(TransparencyAttributes transparencyAttributes) Sets the transparencyAttributes object to the specified object.
void	setUpdatableCapabilities()
static void	setVersion120()
static void	setVersionES100()
static void	setVersionES300()

Methods inherited from class org.jogamp.java3d.ShaderAppearance

duplicateNodeComponent, getShaderAttributeSet, getShaderProgram, setShaderAttributeSet, setShaderProgram

Methods inherited from class org.jogamp.java3d.Appearance

getColoringAttributes, getLineAttributes, getMaterial, getPointAttributes, getPolygonAttributes, getRenderingAttributes, getTexCoordGeneration, getTexture, getTextureAttributes, getTextureUnitCount, getTextureUnitState, getTextureUnitState, getTransparencyAttributes

Methods inherited from class org.jogamp.java3d.NodeComponent

cloneNodeComponent, duplicateNodeComponent, getDuplicateOnCloneTree, setDuplicateOnCloneTree

Methods inherited from class org.jogamp.java3d.SceneGraphObject

clearCapability, clearCapabilityIsFrequent, getCapability, getCapabilityIsFrequent, getName, getUserData, isCompiled, isLive, setCapability, setCapabilityIsFrequent, setName, setUserData, toString, updateNodeReferences

Methods inherited from class java.lang.Object

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

Field Detail

alphaTestUniforms

public static java.lang.String alphaTestUniforms

alphaTestMethod

public static java.lang.String alphaTestMethod

glFrontMaterial

public static java.lang.String glFrontMaterial

glLightSource

public static java.lang.String glLightSource

Constructor Detail

SimpleShaderAppearance

public SimpleShaderAppearance()

This will define the shader code based on the attributes set

SimpleShaderAppearance

public SimpleShaderAppearance(Color3f color)

Lines with a single color no texture, ignores vertex attribute of color

Parameters:

color -

SimpleShaderAppearance

public SimpleShaderAppearance(boolean lit,
                              boolean hasTexture)

Method Detail

setVersionES100

public static void setVersionES100()

setVersionES300

public static void setVersionES300()

setVersion120

public static void setVersion120()

getVertexShaderSource

public java.lang.String getVertexShaderSource()

getFragmentShaderSource

public java.lang.String getFragmentShaderSource()

setUpdatableCapabilities

public void setUpdatableCapabilities()

rebuildShaders

public void rebuildShaders()

setMaterial

public void setMaterial(Material material)

Description copied from class: Appearance

Sets the material object to the specified object. Setting it to null disables lighting.

Overrides:

setMaterial in class Appearance

Parameters:

material - object that specifies the desired material properties

setColoringAttributes

public void setColoringAttributes(ColoringAttributes coloringAttributes)

Description copied from class: Appearance

Sets the coloringAttributes object to the specified object. Setting it to null will result in default attribute usage.

Overrides:

setColoringAttributes in class Appearance

Parameters:

coloringAttributes - object that specifies the desired coloringAttributes parameters

setTransparencyAttributes

public void setTransparencyAttributes(TransparencyAttributes transparencyAttributes)

Description copied from class: Appearance

Sets the transparencyAttributes object to the specified object. Setting it to null will result in default attribute usage.

Overrides:

setTransparencyAttributes in class Appearance

Parameters:

transparencyAttributes - object that specifies the desired transparencyAttributes parameters

setRenderingAttributes

public void setRenderingAttributes(RenderingAttributes renderingAttributes)

Description copied from class: Appearance

Sets the renderingAttributes object to the specified object. Setting it to null will result in default attribute usage.

Overrides:

setRenderingAttributes in class Appearance

Parameters:

renderingAttributes - object that specifies the desired renderingAttributes parameters

setPolygonAttributes

public void setPolygonAttributes(PolygonAttributes polygonAttributes)

Description copied from class: Appearance

Sets the polygonAttributes object to the specified object. Setting it to null will result in default attribute usage.

Overrides:

setPolygonAttributes in class Appearance

Parameters:

polygonAttributes - object that specifies the desired polygonAttributes parameters

setLineAttributes

public void setLineAttributes(LineAttributes lineAttributes)

Description copied from class: Appearance

Sets the lineAttributes object to the specified object. Setting it to null will result in default attribute usage.

Overrides:

setLineAttributes in class Appearance

Parameters:

lineAttributes - object that specifies the desired lineAttributes parameters

setPointAttributes

public void setPointAttributes(PointAttributes pointAttributes)

Description copied from class: Appearance

Sets the pointAttributes object to the specified object. Setting it to null will result in default attribute usage.

Overrides:

setPointAttributes in class Appearance

Parameters:

pointAttributes - object that specifies the desired pointAttributes parameters

setTexture

public void setTexture(Texture texture)

Description copied from class: Appearance

Sets the texture object to the specified object. Setting it to null disables texture mapping.

Applications must not set individual texture component objects (texture, textureAttributes, or texCoordGeneration) and the texture unit state array in the same Appearance object. Doing so will result in an exception being thrown.

Overrides:

setTexture in class Appearance

Parameters:

texture - object that specifies the desired texture map and texture parameters

setTextureAttributes

public void setTextureAttributes(TextureAttributes textureAttributes)

Note if the texture transform is updated after the TextureAttributes are set then rebuild will need to be called on this Appearance

Overrides:

setTextureAttributes in class Appearance

Parameters:

textureAttributes - object that specifies the desired textureAttributes map and textureAttributes parameters

setTexCoordGeneration

public void setTexCoordGeneration(TexCoordGeneration texCoordGeneration)

Description copied from class: Appearance

Sets the texCoordGeneration object to the specified object. Setting it to null disables texture coordinate generation.

Applications must not set individual texture component objects (texture, textureAttributes, or texCoordGeneration) and the texture unit state array in the same Appearance object. Doing so will result in an exception being thrown.

Overrides:

setTexCoordGeneration in class Appearance

Parameters:

texCoordGeneration - object that specifies the texture coordinate generation parameters

setTextureUnitState

public void setTextureUnitState(TextureUnitState[] stateArray)

Description copied from class: Appearance

Sets the texture unit state array for this appearance object to the specified array. A shallow copy of the array of references to the TextureUnitState objects is made. If the specified array is null or if the length of the array is 0, multi-texture is disabled. Within the array, a null TextureUnitState element disables the corresponding texture unit.

Applications must not set individual texture component objects (texture, textureAttributes, or texCoordGeneration) and the texture unit state array in the same Appearance object. Doing so will result in an exception being thrown.

Overrides:

setTextureUnitState in class Appearance

Parameters:

stateArray - array of TextureUnitState objects that specify the desired texture state for each unit. The length of this array specifies the maximum number of texture units that will be used by this appearance object. The texture units are numbered from 0 through stateArray.length-1.

setTextureUnitState

public void setTextureUnitState(int index,
                                TextureUnitState state)

Description copied from class: Appearance

Sets the texture unit state object at the specified index within the texture unit state array to the specified object. If the specified object is null, the corresponding texture unit is disabled. The index must be within the range [0, stateArray.length-1].

Overrides:

setTextureUnitState in class Appearance

Parameters:

index - the array index of the object to be set

state - new texture unit state object

cloneNodeComponent

public NodeComponent cloneNodeComponent()

Must implement or clones turn out to be ShaderAppearance

Overrides:

cloneNodeComponent in class ShaderAppearance