All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.media.j3d.SceneGraphPath 

java.lang.Object
   |
   +----java.media.j3d.SceneGraphPath
public class SceneGraphPath
extends Object
A SceneGraphPath object represents a path from an object to a locale, via its link nodes.

Constructor Index

o SceneGraphPath()
Constructs a new SceneGraphPath object.
o SceneGraphPath(Locale, Link[], Node)
Constructs a new SceneGraphPath object.
o SceneGraphPath(Locale, Node)
Constructs a new SceneGraphPath object.

Method Index

o equals(SceneGraphPath)
Returns true if all of the data members of path testPath are equal to the corresponding data members in this SceneGraphPath.
o getLink(int)
Returns the link node associated with the specified index.
o getLocale()
Retrieves the path's Locale
o getObject()
Retrieves the path's object.
o hashCode()
Returns a hash number based on the data values in this object.
o linkCount()
Returns the number of link nodes in this path.
o set(SceneGraphPath)
Sets this path's values to that of the specified path
o setLink(int, Link)
Replaces the link node at with the specified index with newLink.
o setLinks(Link[])
Sets this path's link object to those specified object.
o setLocale(Locale)
Sets this path's locale to the specified locale.
o setObject(Node)
Sets this path's object to the specified object.

Constructors

o SceneGraphPath 
 public SceneGraphPath()
Constructs a new SceneGraphPath object.

o SceneGraphPath 
 public SceneGraphPath(Locale root,
                       Node object)
Constructs a new SceneGraphPath object.

Parameters:
root - the path's initial Locale object
object - the object in question
Throws: IllegalArgumentException
if object is other than a Group, Shape3D, or Morph node.
o SceneGraphPath 
 public SceneGraphPath(Locale root,
                       Link links[],
                       Node object)
Constructs a new SceneGraphPath object.

Parameters:
root - the path's initial Locale object
links - an array of link objects consisting of all link leaf nodes seprating the locale from the object in question (links[0] is the link leaf node closest to the locale, while links[links.length] is the link leaf nod closest to object)
object - the object in question.
Throws: IllegalArgumentException
if object is other than a Group, Shape3D, or Morph node.

Methods

o set 
 public final void set(SceneGraphPath newPath)
Sets this path's values to that of the specified path

Parameters:
newPath - the SceneGraphPath to copy
o setLocale 
 public final void setLocale(Locale newLocale)
Sets this path's locale to the specified locale.

Parameters:
newLocale - The new locale
o setObject 
 public final void setObject(Node object)
Sets this path's object to the specified object.

Parameters:
object - the new object
Throws: IllegalArgumentException
if object is other than a Group, Shape3D, or Morph node.
o setLinks 
 public final void setLinks(Link links[])
Sets this path's link object to those specified object.

Parameters:
Links - the new links
o setLink 
 public final void setLink(int index,
                           Link newLink)
Replaces the link node at with the specified index with newLink.

Parameters:
index - the index of the link to replace
newLink - the new link node
o getLocale 
 public final Locale getLocale()
Retrieves the path's Locale

Returns:
this path's Locale
o getObject 
 public final Node getObject()
Retrieves the path's object.

Returns:
the path's object
o linkCount 
 public final int linkCount()
Returns the number of link nodes in this path.

Returns:
a count of the number of link nodes in this path
o getLink 
 public final Link getLink(int index)
Returns the link node associated with the specified index.

Parameters:
index - the index specifying which link node to retrieve
Returns:
the specified link object.
o equals 
 public boolean equals(SceneGraphPath testPath)
Returns true if all of the data members of path testPath are equal to the corresponding data members in this SceneGraphPath.

Parameters:
testPath - the path we will compare this object's path against.
Returns:
true or false
o hashCode 
 public int hashCode()
Returns a hash number based on the data values in this object. Two different SceneGraphPath objects with identical data values (ie, returns true for trans.equals(SceneGraphPath) ) will return the same hash number. Two Paths with different data members may return the same hash value, although this is not likely.

Returns:
the integer hash value
Overrides:
hashCode in class Object 
All Packages  Class Hierarchy  This Package  Previous  Next  Index