|
| |
|
| java.lang.Object
 javax.media.j3d.SceneGraphObject
javax.media.j3d.Node
javax.media.j3d.Leaf
javax.media.j3d.Fog
All known Subclasses: javax.media.j3d.LinearFog, javax.media.j3d.ExponentialFog,
| Fog | | abstract public class Fog extends Leaf (Code) | | The Fog leaf node defines a set of fog parameters common to all
types of fog. These parameters include the fog color and a region
of influence in which this Fog node is active.
A Fog node also contains a list of Group nodes that specifies the
hierarchical scope of this Fog. If the scope list is empty, then
the Fog node has universe scope: all nodes within the region of
influence are affected by this Fog node. If the scope list is
non-empty, then only those Leaf nodes under the Group nodes in the
scope list are affected by this Fog node (subject to the
influencing bounds).
If the regions of influence of multiple Fog nodes overlap, the
Java 3D system will choose a single set of fog parameters for those
objects that lie in the intersection. This is done in an
implementation-dependent manner, but in general, the Fog node that
is "closest" to the object is chosen.
|
| Field Summary | |
| final public static int | ALLOW_COLOR_READ
Specifies that this Fog node allows read access to its color
information. | | final public static int | ALLOW_COLOR_WRITE
Specifies that this Fog node allows write access to its color
information. | | final public static int | ALLOW_INFLUENCING_BOUNDS_READ
Specifies that this Fog node allows read access to its
influencing bounds and bounds leaf information. | | final public static int | ALLOW_INFLUENCING_BOUNDS_WRITE
Specifies that this Fog node allows write access to its
influencing bounds and bounds leaf information. | | final public static int | ALLOW_SCOPE_READ
Specifies that this Fog node allows read access to its scope
information at runtime. | | final public static int | ALLOW_SCOPE_WRITE
Specifies that this Fog node allows write access to its scope
information at runtime. |
| Constructor Summary | |
| public | Fog()
Constructs a Fog node with default parameters. | | public | Fog(Color3f color)
Constructs a Fog node with the specified fog color. | | public | Fog(float r, float g, float b)
Constructs a Fog node with the specified fog color. |
| Method Summary | |
| public void | addScope(Group scope)
Appends the specified Group node to this Fog node's list of scopes.
By default, Fog nodes are scoped only by their influencing
bounds. | | void | duplicateAttributes(Node originalNode, boolean forceDuplicate)
Copies all Fog information from
originalNode into
the current node. | | public Enumeration | getAllScopes()
Returns an enumeration of this Fog node's list of scopes. | | public void | getColor(Color3f color)
Retrieves the fog color. | | public BoundingLeaf | getInfluencingBoundingLeaf()
Retrieves the Fog node's influencing bounding leaf. | | public Bounds | getInfluencingBounds()
Retrieves the Fog node's influencing bounds. | | public Group | getScope(int index)
Retrieves the Group node at the specified index from this Fog node's
list of scopes.
Parameters:
index - the index of the Group node to be returned. | | public int | indexOfScope(Group scope)
Retrieves the index of the specified Group node in this
Fog node's list of scopes.
Parameters:
scope - the Group node to be looked up. | | public void | insertScope(Group scope, int index)
Inserts the specified Group node into this Fog node's
list of scopes at the specified index.
By default, Fog nodes are scoped only by their influencing
bounds. | | public int | numScopes()
Returns the number of nodes in this Fog node's list of scopes. | | public void | removeAllScopes()
Removes all Group nodes from this Fog node's
list of scopes. | | public void | removeScope(int index)
Removes the node at the specified index from this Fog node's
list of scopes. | | public void | removeScope(Group scope)
Removes the specified Group node from this Fog
node's list of scopes. | | public void | setColor(Color3f color)
Sets the fog color to the specified color. | | public void | setColor(float r, float g, float b)
Sets the fog color to the specified color. | | public void | setInfluencingBoundingLeaf(BoundingLeaf region)
Sets the Fog's influencing region to the specified bounding leaf. | | public void | setInfluencingBounds(Bounds region)
Sets the Fog's influencing region to the specified bounds. | | public void | setScope(Group scope, int index)
Replaces the node at the specified index in this Fog node's
list of scopes with the specified Group node.
By default, Fog nodes are scoped only by their influencing
bounds. | | public void | updateNodeReferences(NodeReferenceTable referenceTable)
Callback used to allow a node to check if any nodes referenced
by that node have been duplicated via a call to cloneTree.
This method is called by cloneTree after all nodes in
the sub-graph have been duplicated. |
| ALLOW_COLOR_READ | | final public static int ALLOW_COLOR_READ(Code) | | Specifies that this Fog node allows read access to its color
information.
|
| ALLOW_COLOR_WRITE | | final public static int ALLOW_COLOR_WRITE(Code) | | Specifies that this Fog node allows write access to its color
information.
|
| ALLOW_INFLUENCING_BOUNDS_READ | | final public static int ALLOW_INFLUENCING_BOUNDS_READ(Code) | | Specifies that this Fog node allows read access to its
influencing bounds and bounds leaf information.
|
| ALLOW_INFLUENCING_BOUNDS_WRITE | | final public static int ALLOW_INFLUENCING_BOUNDS_WRITE(Code) | | Specifies that this Fog node allows write access to its
influencing bounds and bounds leaf information.
|
| ALLOW_SCOPE_READ | | final public static int ALLOW_SCOPE_READ(Code) | | Specifies that this Fog node allows read access to its scope
information at runtime.
|
| ALLOW_SCOPE_WRITE | | final public static int ALLOW_SCOPE_WRITE(Code) | | Specifies that this Fog node allows write access to its scope
information at runtime.
|
| Fog | | public Fog()(Code) | | Constructs a Fog node with default parameters. The default
values are as follows:
color : black (0,0,0)
scope : empty (universe scope)
influencing bounds : null
influencing bounding leaf : null
|
| Fog | | public Fog(Color3f color)(Code) | | Constructs a Fog node with the specified fog color.
Parameters:
color - the fog color |
| Fog | | public Fog(float r, float g, float b)(Code) | | Constructs a Fog node with the specified fog color.
Parameters:
r - the red component of the fog color
Parameters:
g - the green component of the fog color
Parameters:
b - the blue component of the fog color |
| addScope | | public void addScope(Group scope)(Code) | | Appends the specified Group node to this Fog node's list of scopes.
By default, Fog nodes are scoped only by their influencing
bounds. This allows them to be further scoped by a list of
nodes in the hierarchy.
Parameters:
scope - the Group node to be appended.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph
exception:
RestrictedAccessException - if the specified group nodeis part of a compiled scene graph |
| duplicateAttributes | | void duplicateAttributes(Node originalNode, boolean forceDuplicate)(Code) | | Copies all Fog information from
originalNode into
the current node. This method is called from the
cloneNode method which is, in turn, called by the
cloneTree method.
Parameters:
originalNode - the original node to duplicate.
Parameters:
forceDuplicate - when set to true, causes theduplicateOnCloneTree flag to be ignored. Whenfalse, the value of each node'sduplicateOnCloneTree variable determines whetherNodeComponent data is duplicated or copied.
exception:
RestrictedAccessException - if this object is part of a liveor compiled scenegraph.
See Also: Node.duplicateNode
See Also: Node.cloneTree
See Also: NodeComponent.setDuplicateOnCloneTree |
| getAllScopes | | public Enumeration getAllScopes()(Code) | | Returns an enumeration of this Fog node's list of scopes.
an Enumeration object containing all nodes in this Fog node'slist of scopes.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| getColor | | public void getColor(Color3f color)(Code) | | Retrieves the fog color.
Parameters:
color - the vector that will receive the current fog color
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| getInfluencingBoundingLeaf | | public BoundingLeaf getInfluencingBoundingLeaf()(Code) | | Retrieves the Fog node's influencing bounding leaf.
this Fog's influencing bounding leaf information
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| getInfluencingBounds | | public Bounds getInfluencingBounds()(Code) | | Retrieves the Fog node's influencing bounds.
this Fog's influencing bounds information
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| getScope | | public Group getScope(int index)(Code) | | Retrieves the Group node at the specified index from this Fog node's
list of scopes.
Parameters:
index - the index of the Group node to be returned. the Group node at the specified index.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| indexOfScope | | public int indexOfScope(Group scope)(Code) | | Retrieves the index of the specified Group node in this
Fog node's list of scopes.
Parameters:
scope - the Group node to be looked up. the index of the specified Group node;returns -1 if the object is not in the list.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph
since:
Java 3D 1.3 |
| insertScope | | public void insertScope(Group scope, int index)(Code) | | Inserts the specified Group node into this Fog node's
list of scopes at the specified index.
By default, Fog nodes are scoped only by their influencing
bounds. This allows them to be further scoped by a list of
nodes in the hierarchy.
Parameters:
scope - the Group node to be inserted at the specified index.
Parameters:
index - the index at which the Group node is inserted.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph
exception:
RestrictedAccessException - if the specified group nodeis part of a compiled scene graph |
| numScopes | | public int numScopes()(Code) | | Returns the number of nodes in this Fog node's list of scopes.
If this number is 0, then the list of scopes is empty and this
Fog node has universe scope: all nodes within the region of
influence are affected by this Fog node.
the number of nodes in this Fog node's list of scopes.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| removeAllScopes | | public void removeAllScopes()(Code) | | Removes all Group nodes from this Fog node's
list of scopes. The Fog node will then have
universe scope: all nodes within the region of influence will
be affected by this Fog node.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph
exception:
RestrictedAccessException - if any group node in thisnode's list of scopes is part of a compiled scene graph
since:
Java 3D 1.3 |
| removeScope | | public void removeScope(int index)(Code) | | Removes the node at the specified index from this Fog node's
list of scopes. If this operation causes the list of scopes to
become empty, then this Fog will have universe scope: all nodes
within the region of influence will be affected by this Fog node.
Parameters:
index - the index of the Group node to be removed.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph
exception:
RestrictedAccessException - if the group node at thespecified index is part of a compiled scene graph |
| removeScope | | public void removeScope(Group scope)(Code) | | Removes the specified Group node from this Fog
node's list of scopes. If the specified object is not in the
list, the list is not modified. If this operation causes the
list of scopes to become empty, then this Fog
will have universe scope: all nodes within the region of
influence will be affected by this Fog node.
Parameters:
scope - the Group node to be removed.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph
exception:
RestrictedAccessException - if the specified group nodeis part of a compiled scene graph
since:
Java 3D 1.3 |
| setColor | | public void setColor(Color3f color)(Code) | | Sets the fog color to the specified color.
Parameters:
color - the new fog color
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| setColor | | public void setColor(float r, float g, float b)(Code) | | Sets the fog color to the specified color.
Parameters:
r - the red component of the fog color
Parameters:
g - the green component of the fog color
Parameters:
b - the blue component of the fog color
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| setInfluencingBoundingLeaf | | public void setInfluencingBoundingLeaf(BoundingLeaf region)(Code) | | 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 Fognode's new influencing region.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| setInfluencingBounds | | public void setInfluencingBounds(Bounds region)(Code) | | 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.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| setScope | | public void setScope(Group scope, int index)(Code) | | Replaces the node at the specified index in this Fog node's
list of scopes with the specified Group node.
By default, Fog nodes are scoped only by their influencing
bounds. This allows them to be further scoped by a list of
nodes in the hierarchy.
Parameters:
scope - the Group node to be stored at the specified index.
Parameters:
index - the index of the Group node to be replaced.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph
exception:
RestrictedAccessException - if the specified group nodeis part of a compiled scene graph |
| updateNodeReferences | | public void updateNodeReferences(NodeReferenceTable referenceTable)(Code) | | Callback used to allow a node to check if any nodes referenced
by that node have been duplicated via a call to cloneTree.
This method is called by cloneTree after all nodes in
the sub-graph have been duplicated. The cloned Leaf node's method
will be called and the Leaf node can then look up any node references
by using the getNewObjectReference method found in the
NodeReferenceTable object. If a match is found, a
reference to the corresponding Node in the newly cloned sub-graph
is returned. If no corresponding reference is found, either a
DanglingReferenceException is thrown or a reference to the original
node is returned depending on the value of the
allowDanglingReferences parameter passed in the
cloneTree call.
NOTE: Applications should not call this method directly.
It should only be called by the cloneTree method.
Parameters:
referenceTable - a NodeReferenceTableObject that contains thegetNewObjectReference method needed to search fornew object instances.
See Also: NodeReferenceTable
See Also: Node.cloneTree
See Also: DanglingReferenceException |
|
|
|