All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.media.j3d.Fog

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

public abstract class Fog

extends Leaf

ALLOW_COLOR_READ

Specifies that this Fog node allows read access to its color information.

ALLOW_COLOR_WRITE

Specifies that this Fog node allows write access to its color information.

ALLOW_INFLUENCING_BOUNDS_READ

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

ALLOW_INFLUENCING_BOUNDS_WRITE

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

Fog()

Constructs a Fog node with default fog parameters.

Fog(Color3f)

Constructs a Fog node with the specified fog color.

Fog(float, float, float)

Constructs a Fog node with the specified fog color.

addScope(Group)

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

getAllScopes()

Returns an Enumeration object of all scopes.

getColor(Color3f)

Retrieves the fog color.

getInfluencingBoundingLeaf()

Retrieves the Fog node's influencing bounding leaf.

getInfluencingBounds()

Retrieves the Fog node's influencing bounds.

getScope(int)

Retrieves this Fog'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 fogs' scopes.

removeScope(int)

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

setColor(Color3f)

Sets the fog color to the specified color.

setColor(float, float, float)

Sets the fog color to the specified color.

setInfluencingBoundingLeaf(BoundingLeaf)

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

setInfluencingBounds(Bounds)

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

setScope(Group, int)

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

 public static final int ALLOW_INFLUENCING_BOUNDS_READ

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

 public static final int ALLOW_INFLUENCING_BOUNDS_WRITE

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

 public static final int ALLOW_COLOR_READ

Specifies that this Fog node allows read access to its color information.

 public static final int ALLOW_COLOR_WRITE

Specifies that this Fog node allows write access to its color information.

 public Fog()

Constructs a Fog node with default fog parameters.

 public Fog(Color3f color)

Constructs a Fog node with the specified fog color.

Parameters:

color - the fog color

 public Fog(float r,
            float g,
            float b)

Constructs a Fog node with the specified fog color.

Parameters:

r - the red component of the fog color

g - the green component of the fog color

b - the blue component of the fog color

 public final void setColor(Color3f color)

Sets the fog color to the specified color.

Parameters:

color - the new fog color

Throws: CapabilityNotSetException

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

 public final void setColor(float r,
                            float g,
                            float b)

Sets the fog color to the specified color.

Parameters:

r - the red component of the fog color

g - the green component of the fog color

b - the blue component of the fog 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)

Retrieves the fog color.

Parameters:

color - the vector that will receive the current fog color

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 Fog'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 Fog'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 Fog node's influencing bounds.

Returns:

this Fog'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 Fog'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 Fog 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 Fog node's influencing bounding leaf.

Returns:

this Fog's influencing bounding leaf information

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 Fog'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 Fog'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 Fog's scope at the index specified.

Parameters:

index - which scope to return

Returns:

the Group node that defines this Fog'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 fogs' scopes.

Returns:

the number of scopes for this fog.

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