org.web3d.vrml.nodes
Interface VRMLLightNodeType

All Superinterfaces:

FrameStateListener, VRMLChildNodeType, VRMLNode, VRMLNodeType

All Known Subinterfaces:

J3DLightNodeType, OGLLightNodeType

All Known Implementing Classes:

BaseLightNode, J3DLightNode

public interface VRMLLightNodeType

extends VRMLChildNodeType

An abstract representation of any form of light node.

Version:

$Revision: 1.5 $

Author:

Justin Couch

Method Summary

float	getAmbientIntensity() Accessor method to get current value of field ambientIntensity, default value is 0
float[]	getColor() Accessor method to get current value of field color, default value is 1 1 1
float	getIntensity() Accessor method to get current value of field Intensity, default value is 1
boolean	getOn() Accessor method to get current value of field On.
void	setAmbientIntensity(float newAmbientIntensity) Accessor method to get current value of field ambientIntensity
void	setColor(float[] newColor) Accessor method to get current value of field color
void	setIntensity(float newIntensity) Accessor method to get current value of field Intensity
void	setOn(boolean newOn) Accessor method to get current value of field On

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

addNodeListener, getFieldValue, getMetadataObject, getRefCount, hasFieldChanged, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, sendRoute, setDEF, setFrameStateManager, setMetadataObject, setupFinished, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

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

getFieldDeclaration, getFieldIndex, getNodeFieldIndices, getNumFields, getPrimaryType, getSecondaryType, getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

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

allEventsComplete

Method Detail

getAmbientIntensity

public float getAmbientIntensity()

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

Returns:

The current value of ambientIntensity

getColor

public float[] getColor()

Accessor method to get current value of field color, default value is 1 1 1

Returns:

The current value of color

getIntensity

public float getIntensity()

Accessor method to get current value of field Intensity, default value is 1

Returns:

the current value of Intensity

getOn

public boolean getOn()

Accessor method to get current value of field On. default value is true

Returns:

the current value of On

setAmbientIntensity

public void setAmbientIntensity(float newAmbientIntensity)
                         throws InvalidFieldValueException

Accessor method to get current value of field ambientIntensity

Parameters:

newAmbientIntensity - The new value

Throws:

InvalidFieldValueException

setColor

public void setColor(float[] newColor)
              throws InvalidFieldValueException

Accessor method to get current value of field color

Parameters:

newColor - The new value

Throws:

InvalidFieldValueException

setIntensity

public void setIntensity(float newIntensity)
                  throws InvalidFieldValueException

Accessor method to get current value of field Intensity

Parameters:

newIntensity - The new value

Throws:

InvalidFieldValueException

setOn

public void setOn(boolean newOn)

Accessor method to get current value of field On

Parameters:

newOn - The new value