Package org.web3d.vrml.renderer.common.nodes.shape

Class BaseTwoSidedMaterial

java.lang.Object

org.web3d.vrml.renderer.common.nodes.AbstractNode

org.web3d.vrml.renderer.common.nodes.shape.BaseTwoSidedMaterial

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLAppearanceChildNodeType, VRMLMaterialNodeType, VRMLNodeType, VRMLSurfaceMaterialNodeType, VRMLVisualMaterialNodeType

Direct Known Subclasses:

OGLTwoSidedMaterial

public abstract class BaseTwoSidedMaterial
extends AbstractNode
implements VRMLMaterialNodeType

Common base implementation of a two-sided material extension node.

Version:

$Revision: 1.4 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_AMBIENT_INTENSITY	Field index for ambientIntensity
protected static final int	FIELD_BACK_AMBIENT_INTENSITY	Field index for backAmbientIntensity
protected static final int	FIELD_BACK_DIFFUSE_COLOR	Field index for backDiffuseColor
protected static final int	FIELD_BACK_EMISSIVE_COLOR	Field index for backEmissiveColor
protected static final int	FIELD_BACK_SHININESS	Field index for backShininess
protected static final int	FIELD_BACK_SPECULAR_COLOR	Field index for backSpecularColor
protected static final int	FIELD_BACK_TRANSPARENCY	Field index for backTransparency
protected static final int	FIELD_DIFFUSE_COLOR	Field index for diffuseColor
protected static final int	FIELD_EMISSIVE_COLOR	Field index for emissiveColor
protected static final int	FIELD_SEPARATE_BACK_COLOR	Field index for separateBackColor
protected static final int	FIELD_SHININESS	Field index for shininess
protected static final int	FIELD_SPECULAR_COLOR	Field index for specularColor
protected static final int	FIELD_TRANSPARENCY	Field index for transparency
protected boolean	ignoreDiffuse	Should we ignore the specified diffuseColor
protected static final int	NUM_FIELDS	Number of fields constant
protected float	vfAmbientIntensity	exposedField SFFloat ambientIntensity 0.2
protected float	vfBackAmbientIntensity	exposedField SFFloat backAmbientIntensity 0.2
protected float[]	vfBackDiffuseColor	exposedField SFColor backDiffuseColor 0.8 0.8 0.8
protected float[]	vfBackEmissiveColor	exposedField SFColor backEmissiveColor 0 0 0
protected float	vfBackShininess	exposedField SFFloat backShininess 0.2
protected float[]	vfBackSpecularColor	exposedField SFColor backSpecularColor 0 0 0
protected float	vfBackTransparency	exposedField SFFloat backTransparency 0
protected float[]	vfDiffuseColor	exposedField SFColor diffuseColor 0.8 0.8 0.8
protected float[]	vfEmissiveColor	exposedField SFColor emissiveColor 0 0 0
protected boolean	vfSeparateBackColor	exposedField SFBool separateBackColor FALSE
protected float	vfShininess	exposedField SFFloat shininess 0.2
protected float[]	vfSpecularColor	exposedField SFColor specularColor 0 0 0
protected float	vfTransparency	exposedField SFFloat transparency 0

Fields inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

errorReporter, FIELD_METADATA, fieldLocalData, hasChanged, inSetup, isDEF, isStatic, LAST_NODE_INDEX, layerIds, nodeName, pMetadata, refCounts, removedLayerIds, stateManager, STATIC_SCENE_GRAPH, vfMetadata, vrmlMajorVersion, vrmlMinorVersion

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseTwoSidedMaterial()	Construct a default instance of the material
protected	BaseTwoSidedMaterial(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
void	addMaterialColorListener(MaterialColorListener l)	Add a listener instance for the material color change notifications.
float	getAmbientIntensity()	Accessor method to get current value of field ambientIntensity, default value is 0.2
float[]	getDiffuseColor()	Accessor method to get current value of field diffuseColor, default value is 0.8 0.8 0.8.
float[]	getEmissiveColor()	Accessor method to get current value of field emissiveColor, default value is 0 0 0.
VRMLFieldDeclaration	getFieldDeclaration(int index)	Get the declaration of the field at the given index.
int	getFieldIndex(String fieldName)	Get the index of the given field name.
VRMLFieldData	getFieldValue(int index)	Get the value of a field.
int[]	getNodeFieldIndices()	Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode).
int	getNumFields()	Get the number of fields.
int	getPrimaryType()	Get the primary type of this node.
float	getShininess()	Accessor method to get current value of field shininess, default value is 0.2.
float[]	getSpecularColor()	Accessor method to get current value of field specularColor, default value is 0 0 0.
float	getTransparency()	Accessor method to get current value of field transparency, default value is 0
void	removeMaterialColorListener(MaterialColorListener l)	Remove a listener instance from this node.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setAmbientIntensity(float intensity)	Set a new value for ambientIntensity.
protected void	setBackAmbientIntensity(float intensity)	Set a new value for ambientIntensity.
protected void	setBackDiffuseColor(float[] color)	Set a new value for diffuseColor.
protected void	setBackEmissiveColor(float[] color)	Set a new value for emissiveColor.
protected void	setBackShininess(float shininess)	Set a new value for shininess.
protected void	setBackSpecularColor(float[] color)	Set a new value for the specularColor.
protected void	setBackTransparency(float trans)	Set a new value for the transparency.
void	setDiffuseColor(float[] color)	Set a new value for diffuseColor.
void	setEmissiveColor(float[] color)	Set a new value for emissiveColor.
void	setIgnoreDiffuse(boolean ignore)	Ignore the diffuseColor color term and use 1,1,1 for the diffuse color.
protected void	setSeparateBackColor(boolean state)	Set a new value for the separated back face colour state.
void	setShininess(float shininess)	Set a new value for shininess.
void	setSpecularColor(float[] color)	Set a new value for the specularColor.
void	setTransparency(float trans)	Set a new value for the transparency.
void	setValue(int index, boolean value)	Set the value of the field at the given index as a float.
void	setValue(int index, float value)	Set the value of the field at the given index as a float.
void	setValue(int index, float[] value, int numValid)	Set the value of the field at the given index as an array of floats.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

addNodeListener, allEventsComplete, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getSecondaryType, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setupFinished, setUserData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setVersion, throwInitOnlyWriteException, throwInputOnlyWriteException, throwInvalidNodeException, throwInvalidProtoException, throwOutputOnlyWriteException, updateRefCount, updateRefs

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.web3d.vrml.nodes.FrameStateListener

allEventsComplete

Methods inherited from interface org.web3d.vrml.lang.VRMLNode

getSecondaryType, getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

Methods inherited from interface org.web3d.vrml.nodes.VRMLNodeType

addNodeListener, clearRemovedLayerIds, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, hasFieldChanged, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setFrameStateManager, setMetadataObject, setupFinished, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Field Details

FIELD_AMBIENT_INTENSITY

protected static final int FIELD_AMBIENT_INTENSITY

Field index for ambientIntensity

See Also:

• Constant Field Values

FIELD_BACK_AMBIENT_INTENSITY

protected static final int FIELD_BACK_AMBIENT_INTENSITY

Field index for backAmbientIntensity

See Also:

• Constant Field Values

FIELD_DIFFUSE_COLOR

protected static final int FIELD_DIFFUSE_COLOR

Field index for diffuseColor

See Also:

• Constant Field Values

FIELD_BACK_DIFFUSE_COLOR

protected static final int FIELD_BACK_DIFFUSE_COLOR

Field index for backDiffuseColor

See Also:

• Constant Field Values

FIELD_EMISSIVE_COLOR

protected static final int FIELD_EMISSIVE_COLOR

Field index for emissiveColor

See Also:

• Constant Field Values

FIELD_BACK_EMISSIVE_COLOR

protected static final int FIELD_BACK_EMISSIVE_COLOR

Field index for backEmissiveColor

See Also:

• Constant Field Values

FIELD_SHININESS

protected static final int FIELD_SHININESS

Field index for shininess

See Also:

• Constant Field Values

FIELD_BACK_SHININESS

protected static final int FIELD_BACK_SHININESS

Field index for backShininess

See Also:

• Constant Field Values

FIELD_SPECULAR_COLOR

protected static final int FIELD_SPECULAR_COLOR

Field index for specularColor

See Also:

• Constant Field Values

FIELD_BACK_SPECULAR_COLOR

protected static final int FIELD_BACK_SPECULAR_COLOR

Field index for backSpecularColor

See Also:

• Constant Field Values

FIELD_TRANSPARENCY

protected static final int FIELD_TRANSPARENCY

Field index for transparency

See Also:

• Constant Field Values

FIELD_BACK_TRANSPARENCY

protected static final int FIELD_BACK_TRANSPARENCY

Field index for backTransparency

See Also:

• Constant Field Values

FIELD_SEPARATE_BACK_COLOR

protected static final int FIELD_SEPARATE_BACK_COLOR

Field index for separateBackColor

See Also:

• Constant Field Values

NUM_FIELDS

protected static final int NUM_FIELDS

Number of fields constant

See Also:

• Constant Field Values

vfAmbientIntensity

protected float vfAmbientIntensity

exposedField SFFloat ambientIntensity 0.2

vfBackAmbientIntensity

protected float vfBackAmbientIntensity

exposedField SFFloat backAmbientIntensity 0.2

vfDiffuseColor

protected float[] vfDiffuseColor

exposedField SFColor diffuseColor 0.8 0.8 0.8

vfBackDiffuseColor

protected float[] vfBackDiffuseColor

exposedField SFColor backDiffuseColor 0.8 0.8 0.8

vfEmissiveColor

protected float[] vfEmissiveColor

exposedField SFColor emissiveColor 0 0 0

vfBackEmissiveColor

protected float[] vfBackEmissiveColor

exposedField SFColor backEmissiveColor 0 0 0

vfShininess

protected float vfShininess

exposedField SFFloat shininess 0.2

vfBackShininess

protected float vfBackShininess

exposedField SFFloat backShininess 0.2

vfSpecularColor

protected float[] vfSpecularColor

exposedField SFColor specularColor 0 0 0

vfBackSpecularColor

protected float[] vfBackSpecularColor

exposedField SFColor backSpecularColor 0 0 0

vfTransparency

protected float vfTransparency

exposedField SFFloat transparency 0

vfBackTransparency

protected float vfBackTransparency

exposedField SFFloat backTransparency 0

vfSeparateBackColor

protected boolean vfSeparateBackColor

exposedField SFBool separateBackColor FALSE

ignoreDiffuse

protected boolean ignoreDiffuse

Should we ignore the specified diffuseColor

Constructor Details

BaseTwoSidedMaterial

protected BaseTwoSidedMaterial()

Construct a default instance of the material

BaseTwoSidedMaterial

protected BaseTwoSidedMaterial(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node. If the node is not the right type, an exception will be thrown.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not a Group node

Method Details

setAmbientIntensity

public void setAmbientIntensity(float intensity)
                         throws InvalidFieldValueException

Set a new value for ambientIntensity. How much ambient omnidirectional light is reflected from all light sources.

Specified by:

setAmbientIntensity in interface VRMLMaterialNodeType

Parameters:

intensity - The new intensity value

Throws:

InvalidFieldValueException

getAmbientIntensity

public float getAmbientIntensity()

Accessor method to get current value of field ambientIntensity, default value is 0.2

Specified by:

getAmbientIntensity in interface VRMLMaterialNodeType

Returns:

The current ambientIntensity

setDiffuseColor

public void setDiffuseColor(float[] color)
                     throws InvalidFieldValueException

Set a new value for diffuseColor. How much direct, angle-dependent light is reflected from all light sources.

Specified by:

setDiffuseColor in interface VRMLMaterialNodeType

Parameters:

color - The new value of diffuseColor

Throws:

InvalidFieldValueException

getDiffuseColor

public float[] getDiffuseColor()

Accessor method to get current value of field diffuseColor, default value is 0.8 0.8 0.8.

Specified by:

getDiffuseColor in interface VRMLMaterialNodeType

Returns:

The current value of diffuseColor

setEmissiveColor

public void setEmissiveColor(float[] color)
                      throws InvalidFieldValueException

Set a new value for emissiveColor. How much glowing light is emitted from this object.

Specified by:

setEmissiveColor in interface VRMLMaterialNodeType

Parameters:

color - The new value of EmissiveColor

Throws:

InvalidFieldValueException

getEmissiveColor

public float[] getEmissiveColor()

Accessor method to get current value of field emissiveColor, default value is 0 0 0.

Specified by:

getEmissiveColor in interface VRMLMaterialNodeType

Returns:

The current value of EmissiveColor

setShininess

public void setShininess(float shininess)
                  throws InvalidFieldValueException

Set a new value for shininess. Low values provide soft specular glows, high values provide sharper, smaller highlights.

Specified by:

setShininess in interface VRMLMaterialNodeType

Parameters:

shininess - The new value of Shininess

Throws:

InvalidFieldValueException

getShininess

public float getShininess()

Accessor method to get current value of field shininess, default value is 0.2.

Specified by:

getShininess in interface VRMLMaterialNodeType

Returns:

The current value of Shininess

setSpecularColor

public void setSpecularColor(float[] color)
                      throws InvalidFieldValueException

Set a new value for the specularColor. Specular highlights are brightness reflections (example: shiny spots on an apple).

Specified by:

setSpecularColor in interface VRMLMaterialNodeType

Parameters:

color - The new value of SpecularColor

Throws:

InvalidFieldValueException

getSpecularColor

public float[] getSpecularColor()

Accessor method to get current value of field specularColor, default value is 0 0 0.

Specified by:

getSpecularColor in interface VRMLMaterialNodeType

Returns:

The current value of SpecularColor

setTransparency

public void setTransparency(float trans)
                     throws InvalidFieldValueException

Set a new value for the transparency. How "clear" an object is: 1.0 is completely transparent, 0.0 is completely opaque .

Specified by:

setTransparency in interface VRMLMaterialNodeType

Parameters:

trans - The new value of Transparency

Throws:

InvalidFieldValueException

setIgnoreDiffuse

public void setIgnoreDiffuse(boolean ignore)

Ignore the diffuseColor color term and use 1,1,1 for the diffuse color.

Specified by:

setIgnoreDiffuse in interface VRMLMaterialNodeType

Parameters:

ignore - True to ignore the diffuse term

getTransparency

public float getTransparency()

Accessor method to get current value of field transparency, default value is 0

Specified by:

getTransparency in interface VRMLMaterialNodeType

Returns:

The current value of Transparency

addMaterialColorListener

public void addMaterialColorListener(MaterialColorListener l)

Add a listener instance for the material color change notifications. Adding the same instance more than once is ignored. Adding null values are ignored.

Specified by:

addMaterialColorListener in interface VRMLMaterialNodeType

Parameters:

l - The new instance to add

removeMaterialColorListener

public void removeMaterialColorListener(MaterialColorListener l)

Remove a listener instance from this node. If the listener is not currently registered, the request is silently ignored.

Specified by:

removeMaterialColorListener in interface VRMLMaterialNodeType

Parameters:

l - The new instance to remove

getNodeFieldIndices

public int[] getNodeFieldIndices()

Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode). Used for blind scene graph traversal without needing to spend time querying for all fields etc. If a node does not have any fields that contain nodes, this shall return null. The field list covers all field types, regardless of whether they are readable or not at the VRML-level.

Specified by:

getNodeFieldIndices in interface VRMLNode

Returns:

The list of field indices that correspond to SF/MFnode fields or null if none

getFieldIndex

public int getFieldIndex(String fieldName)

Get the index of the given field name. If the name does not exist for this node then return a value of -1.

Specified by:

getFieldIndex in interface VRMLNode

Parameters:

fieldName - The name of the field we want the index from

Returns:

The index of the field name or -1

getFieldDeclaration

public VRMLFieldDeclaration getFieldDeclaration(int index)

Get the declaration of the field at the given index. This allows for reverse lookup if needed. If the field does not exist, this will give a value of null.

Specified by:

getFieldDeclaration in interface VRMLNode

Parameters:

index - The index of the field to get information

Returns:

A representation of this field's information

getNumFields

public int getNumFields()

Get the number of fields.

Specified by:

getNumFields in interface VRMLNode

Returns:

The number of fields.

getPrimaryType

public int getPrimaryType()

Get the primary type of this node. Replaces the instanceof mechanism for use in switch statements.

Specified by:

getPrimaryType in interface VRMLNode

Returns:

The primary type

getFieldValue

public VRMLFieldData getFieldValue(int index)
                            throws InvalidFieldException

Get the value of a field. If the field is a primitive type, it will return a class representing the value. For arrays or nodes it will return the instance directly.

Specified by:

getFieldValue in interface VRMLNodeType

Overrides:

getFieldValue in class AbstractNode

Parameters:

index - The index of the field to change.

Returns:

The class representing the field value

Throws:

InvalidFieldException - The field index is not known

sendRoute

public void sendRoute(double time,
 int srcIndex,
 VRMLNodeType destNode,
 int destIndex)

Send a routed value from this node to the given destination node. The route should use the appropriate setValue() method of the destination node. It should not attempt to cast the node up to a higher level. Routing should also follow the standard rules for the loop breaking and other appropriate rules for the specification.

Specified by:

sendRoute in interface VRMLNodeType

Overrides:

sendRoute in class AbstractNode

Parameters:

time - The time that this route occurred (not necessarily epoch time. Should be treated as a relative value only)

srcIndex - The index of the field in this node that the value should be sent from

destNode - The node reference that we will be sending the value to

destIndex - The index of the field in the destination node that the value should be sent to.

setValue

public void setValue(int index,
 boolean value)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as a float. This would be used to set SFBool field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The new value to use for the node

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is not in range or not appropriate for this field

setValue

public void setValue(int index,
 float value)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as a float. This would be used to set SFFloat field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The new value to use for the node

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is not in range or not appropriate for this field

setValue

public void setValue(int index,
 float[] value,
 int numValid)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as an array of floats. This would be used to set SFColor field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The new value to use for the node

numValid - The number of valid values to copy from the array

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is not in range or not appropriate for this field

setBackAmbientIntensity

protected void setBackAmbientIntensity(float intensity)
                                throws InvalidFieldValueException

Set a new value for ambientIntensity. How much ambient omnidirectional light is reflected from all light sources.

Parameters:

intensity - The new intensity value

Throws:

InvalidFieldValueException

setBackDiffuseColor

protected void setBackDiffuseColor(float[] color)
                            throws InvalidFieldValueException

Set a new value for diffuseColor. How much direct, angle-dependent light is reflected from all light sources.

Parameters:

color - The new value of diffuseColor

Throws:

InvalidFieldValueException

setBackEmissiveColor

protected void setBackEmissiveColor(float[] color)
                             throws InvalidFieldValueException

Set a new value for emissiveColor. How much glowing light is emitted from this object.

Parameters:

color - The new value of EmissiveColor

Throws:

InvalidFieldValueException

setBackShininess

protected void setBackShininess(float shininess)
                         throws InvalidFieldValueException

Set a new value for shininess. Low values provide soft specular glows, high values provide sharper, smaller highlights.

Parameters:

shininess - The new value of Shininess

Throws:

InvalidFieldValueException

setBackSpecularColor

protected void setBackSpecularColor(float[] color)
                             throws InvalidFieldValueException

Set a new value for the specularColor. Specular highlights are brightness reflections (example: shiny spots on an apple).

Parameters:

color - The new value of SpecularColor

Throws:

InvalidFieldValueException

setBackTransparency

protected void setBackTransparency(float trans)
                            throws InvalidFieldValueException

Set a new value for the transparency. How "clear" an object is: 1.0 is completely transparent, 0.0 is completely opaque .

Parameters:

trans - The new value of Transparency

Throws:

InvalidFieldValueException

setSeparateBackColor

protected void setSeparateBackColor(boolean state)

Set a new value for the separated back face colour state.

Parameters:

state - true to use different front from back colours