All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.media.j3d.Light

java.lang.Object
   |
   +----java.media.j3d.SceneGraphObject
           |
           +----java.media.j3d.Node
                   |
                   +----java.media.j3d.Leaf
                           |
                           +----java.media.j3d.Light

public abstract class Light

extends Leaf

ALLOW_COLOR_READ

Specifies that this Light allows read access to its color information at runtime.

ALLOW_COLOR_WRITE

Specifies that this Light allows write access to its color information at runtime.

ALLOW_INFLUENCING_BOUNDS_READ

Specifies that this Light allows read access to its influencing bounds and bounds leaf information.

ALLOW_INFLUENCING_BOUNDS_WRITE

Specifies that this Light allows write access to its influencing bounds and bounds leaf information.

ALLOW_STATE_READ

Specifies that this Light allows read access to its current state information at runtime.

ALLOW_STATE_WRITE

Specifies that this Light allows write access to its current state information at runtime.

Light()

Constructs and initializes a light using default parameters.

Light(boolean, Color3f)

Constructs and initializes a light using the specified parameters.

Light(Color3f)

Constructs and initializes a light using the specified parameters.

addScope(Group)

Appends the specified scope to this node's list of scopes.

getAllScopes()

Returns an Enumeration object of all scopes.

getColor(Color3f)

Gets this Light's current color and places it in the parameter specified.

getEnable()

Retrieves this Light's current state (on/off).

getInfluencingBoundingLeaf()

Retrieves the Light node's influencing bounding leaf.

getInfluencingBounds()

Retrieves the Light node's influencing bounds.

getScope(int)

Retrieves this Light's scope at the index specified.

insertScope(Group, int)

Inserts the scope specified by the group node at the specified index location.

numScopes()

Returns a count of this lights' scopes.

removeScope(int)

Removes the node's scope at the specified index location.

setColor(Color3f)

Sets the Light's current color.

setEnable(boolean)

Turns the light on or off.

setInfluencingBoundingLeaf(BoundingLeaf)

Sets the Light's influencing region to the specified bounding leaf.

setInfluencingBounds(Bounds)

Sets the Light's influencing region to the specified bounds.

setScope(Group, int)

Sets the Light's hierarchical scope at the index specified By default, lights are scoped only by their region of influence bounds.

 public static final int ALLOW_STATE_READ

Specifies that this Light allows read access to its current state information at runtime.

 public static final int ALLOW_STATE_WRITE

Specifies that this Light allows write access to its current state information at runtime.

 public static final int ALLOW_COLOR_READ

Specifies that this Light allows read access to its color information at runtime.

 public static final int ALLOW_COLOR_WRITE

Specifies that this Light allows write access to its color information at runtime.

 public static final int ALLOW_INFLUENCING_BOUNDS_READ

Specifies that this Light allows read access to its influencing bounds and bounds leaf information.

 public static final int ALLOW_INFLUENCING_BOUNDS_WRITE

Specifies that this Light allows write access to its influencing bounds and bounds leaf information.

 public Light()

Constructs and initializes a light using default parameters.

 public Light(Color3f color)

Constructs and initializes a light using the specified parameters.

Parameters:

color - the color of the light source

 public Light(boolean lightOn,
              Color3f color)

Constructs and initializes a light using the specified parameters.

Parameters:

lightOn - flag indicating whether this light is on or off

color - the color of the light source

 public final void setEnable(boolean state)

Turns the light on or off.

Parameters:

state - true or false to set light on or off

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final boolean getEnable()

Retrieves this Light's current state (on/off).

Returns:

this node's current state (on/off)

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final void setColor(Color3f color)

Sets the Light's current color.

Parameters:

color - the value of this node's new color

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final void getColor(Color3f color)

Gets this Light's current color and places it in the parameter specified.

Parameters:

color - the vector that will receive this node's color

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final void setScope(Group scope,
                            int index)

Sets the Light's hierarchical scope at the index specified By default, lights are scoped only by their region of influence bounds. This allows them to be further scoped * by a node in the hierarchy.

Parameters:

scope - the Group node that defines this Light's scope

index - the index which group node to replace.

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final Group getScope(int index)

Retrieves this Light's scope at the index specified.

Parameters:

index - which scope to return

Returns:

the Group node that defines this Light's scope

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final void insertScope(Group scope,
                               int index)

Inserts the scope specified by the group node at the specified index location.

Parameters:

scope - the new scope

index - at which location to insert

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final void removeScope(int index)

Removes the node's scope at the specified index location.

Parameters:

index - which scope to remove

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final Enumeration getAllScopes()

Returns an Enumeration object of all scopes.

Returns:

an Enumeration object of all the scopes

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final void addScope(Group scope)

Appends the specified scope to this node's list of scopes.

Parameters:

scope - the scope to add to this node's list of scopes

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final int numScopes()

Returns a count of this lights' scopes.

Returns:

the number of scopes for this light..

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final void setInfluencingBounds(Bounds region)

Sets the Light's influencing region to the specified bounds. This is used when the influencing bounding leaf is set to null.

Parameters:

region - the bounds that contains the Light's new influencing region.

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final Bounds getInfluencingBounds()

Retrieves the Light node's influencing bounds.

Returns:

this Light's influencing bounds information

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final void setInfluencingBoundingLeaf(BoundingLeaf region)

Sets the Light's influencing region to the specified bounding leaf. When set to a value other than null, this overrides the influencing bounds object.

Parameters:

region - the bounding leaf node used to specify the Light node's new influencing region.

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final BoundingLeaf getInfluencingBoundingLeaf()

Retrieves the Light node's influencing bounding leaf.

Returns:

this Light's influencing bounding leaf information

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

All Packages  Class Hierarchy  This Package  Previous  Next  Index