|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.media.j3d.SceneGraphObject | +--javax.media.j3d.Node | +--javax.media.j3d.Leaf | +--javax.media.j3d.Fog
The Fog leaf node defines a set of fog parameters common to all types of fog. It also specifies a region of influence in which this fog node is active.
Field Summary | |
static int |
ALLOW_COLOR_READ
Specifies that this Fog node allows read access to its color information. |
static int |
ALLOW_COLOR_WRITE
Specifies that this Fog node allows write access to its color information. |
static int |
ALLOW_INFLUENCING_BOUNDS_READ
Specifies that this Fog node allows read access to its influencing bounds and bounds leaf information. |
static int |
ALLOW_INFLUENCING_BOUNDS_WRITE
Specifies that this Fog node allows write access to its influencing bounds and bounds leaf information. |
static int |
ALLOW_SCOPE_READ
Specifies that this Fog node allows read access to its scope information at runtime. |
static int |
ALLOW_SCOPE_WRITE
Specifies that this Fog node allows write access to its scope information at runtime. |
Fields inherited from class javax.media.j3d.Node |
ALLOW_AUTO_COMPUTE_BOUNDS_READ,
ALLOW_AUTO_COMPUTE_BOUNDS_WRITE,
ALLOW_BOUNDS_READ,
ALLOW_BOUNDS_WRITE,
ALLOW_COLLIDABLE_READ,
ALLOW_COLLIDABLE_WRITE,
ALLOW_LOCAL_TO_VWORLD_READ,
ALLOW_PICK,
ALLOW_PICKABLE_READ,
ALLOW_PICKABLE_WRITE,
ENABLE_COLLISION_REPORTING,
ENABLE_PICK_REPORTING |
Constructor Summary | |
Fog()
Constructs a Fog node with default parameters. |
|
Fog(Color3f color)
Constructs a Fog node with the specified fog color. |
|
Fog(float r,
float g,
float b)
Constructs a Fog node with the specified fog color. |
Method Summary | |
void |
addScope(Group scope)
Appends the specified scope to this node's list of scopes. |
java.util.Enumeration |
getAllScopes()
Returns an Enumeration object of all scopes. |
void |
getColor(Color3f color)
Retrieves the fog color. |
BoundingLeaf |
getInfluencingBoundingLeaf()
Retrieves the Fog node's influencing bounding leaf. |
Bounds |
getInfluencingBounds()
Retrieves the Fog node's influencing bounds. |
Group |
getScope(int index)
Retrieves this Fog's scope at the index specified. |
void |
insertScope(Group scope,
int index)
Inserts the scope specified by the group node at the specified index location. |
int |
numScopes()
Returns a count of this fogs' scopes. |
void |
removeScope(int index)
Removes the node's scope at the specified index location. |
void |
setColor(Color3f color)
Sets the fog color to the specified color. |
void |
setColor(float r,
float g,
float b)
Sets the fog color to the specified color. |
void |
setInfluencingBoundingLeaf(BoundingLeaf region)
Sets the Fog's influencing region to the specified bounding leaf. |
void |
setInfluencingBounds(Bounds region)
Sets the Fog's influencing region to the specified bounds. |
void |
setScope(Group scope,
int index)
Sets the Fog's hierarchical scope at the index specified By default, fogs are scoped only by their region of influence bounds. |
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 . |
Methods inherited from class javax.media.j3d.Node |
cloneNode,
cloneTree,
cloneTree,
cloneTree,
duplicateNode,
getBounds,
getBoundsAutoCompute,
getCollidable,
getLocalToVworld,
getLocalToVworld,
getParent,
getPickable,
setBounds,
setBoundsAutoCompute,
setCollidable,
setPickable |
Methods inherited from class javax.media.j3d.SceneGraphObject |
clearCapability,
duplicateSceneGraphObject,
getCapability,
getUserData,
isCompiled,
isLive,
setCapability,
setUserData |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
public static final int ALLOW_INFLUENCING_BOUNDS_READ
public static final int ALLOW_INFLUENCING_BOUNDS_WRITE
public static final int ALLOW_COLOR_READ
public static final int ALLOW_COLOR_WRITE
public static final int ALLOW_SCOPE_READ
public static final int ALLOW_SCOPE_WRITE
Constructor Detail |
public Fog()
public Fog(Color3f color)
color
- the fog colorpublic Fog(float r, float g, float b)
r
- the red component of the fog colorg
- the green component of the fog colorb
- the blue component of the fog colorMethod Detail |
public final void setColor(Color3f color)
color
- the new fog colorpublic final void setColor(float r, float g, float b)
r
- the red component of the fog colorg
- the green component of the fog colorb
- the blue component of the fog colorpublic final void getColor(Color3f color)
color
- the vector that will receive the current fog colorpublic final void setInfluencingBounds(Bounds region)
region
- the bounds that contains the Fog's new influencing region.public final Bounds getInfluencingBounds()
public final void setInfluencingBoundingLeaf(BoundingLeaf region)
region
- the bounding leaf node used to specify the Fog
node's new influencing region.public final BoundingLeaf getInfluencingBoundingLeaf()
public final void setScope(Group scope, int index)
scope
- the Group node that defines this Fog's scopeindex
- the index which group node to replace.public final Group getScope(int index)
index
- which scope to returnpublic final void insertScope(Group scope, int index)
scope
- the new scopeindex
- at which location to insertpublic final void removeScope(int index)
index
- which scope to removepublic final java.util.Enumeration getAllScopes()
public final void addScope(Group scope)
scope
- the scope to add to this node's list of scopespublic final int numScopes()
public void updateNodeReferences(NodeReferenceTable referenceTable)
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 getNewNodeReference
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.referenceTable
- a NodeReferenceTableObject that contains the
getNewNodeReference
method needed to search for
new object instances.NodeReferenceTable
,
Node.cloneTree()
,
DanglingReferenceException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |