public class Locale
extends java.lang.Object
A Locale object defines methods to set and get its highresolution coordinates, and methods to add, remove, and enumerate the branch graphs.
For more information, see the Introduction to the Java 3D API and Scene Graph Superstructure documents.
VirtualUniverse
,
HiResCoord
,
BranchGroup
Constructor and Description 

Locale(VirtualUniverse universe)
Constructs and initializes a new high resolution Locale object
located at (0, 0, 0).

Locale(VirtualUniverse universe,
HiResCoord hiRes)
Constructs and initializes a new high resolution Locale object
at the location specified by the HiResCoord argument.

Locale(VirtualUniverse universe,
int[] x,
int[] y,
int[] z)
Constructs and initializes a new high resolution Locale object
from the parameters provided.

Modifier and Type  Method and Description 

void 
addBranchGraph(BranchGroup branchGroup)
Add a new branch graph rooted at BranchGroup to
the list of branch graphs.

java.util.Iterator<BranchGroup> 
getAllBranchGraphs()
Gets an Iterator object of all branch graphs in this Locale.

void 
getHiRes(HiResCoord hiRes)
Returns this node's HiResCoord.

VirtualUniverse 
getVirtualUniverse()
Retrieves the virtual universe within which this Locale object
is contained.

int 
numBranchGraphs()
Get number of branch graphs in this Locale.

PickInfo[] 
pickAll(int mode,
int flags,
PickShape pickShape)
Returns an array unsorted references to all the PickInfo objects that are pickable
below this
Locale that intersect with PickShape. 
SceneGraphPath[] 
pickAll(PickShape pickShape)
Returns an array referencing all the items that are pickable below this
Locale that intersect with PickShape. 
PickInfo[] 
pickAllSorted(int mode,
int flags,
PickShape pickShape)
Returns a sorted array of PickInfo references to all the pickable
items that intersect with the pickShape.

SceneGraphPath[] 
pickAllSorted(PickShape pickShape)
Returns a sorted array of references to all the pickable items
that intersect with the pickShape.

PickInfo 
pickAny(int mode,
int flags,
PickShape pickShape)
Returns a PickInfo which references the pickable item below this
Locale which intersects with
pickShape . 
SceneGraphPath 
pickAny(PickShape pickShape)
Returns a reference to any item that is Pickable below this
Locale which intersects with
pickShape . 
PickInfo 
pickClosest(int mode,
int flags,
PickShape pickShape)
Returns a PickInfo which references the pickable item
which is closest to the origin of
pickShape . 
SceneGraphPath 
pickClosest(PickShape pickShape)
Returns a SceneGraphPath which references the pickable item
which is closest to the origin of
pickShape . 
void 
removeBranchGraph(BranchGroup branchGroup)
Removes a branch graph rooted at BranchGroup from
the list of branch graphs.

void 
replaceBranchGraph(BranchGroup oldGroup,
BranchGroup newGroup)
Replaces the branch graph rooted at oldGroup in the list of
branch graphs with the branch graph rooted at
newGroup.

void 
setHiRes(HiResCoord hiRes)
Sets the HiRes coordinate of this Locale
to the location specified by the HiRes argument.

void 
setHiRes(int[] x,
int[] y,
int[] z)
Sets the HiRes coordinate of this Locale to the location
specified by the parameters provided.

public Locale(VirtualUniverse universe)
universe
 the virtual universe that will contain this
Locale objectpublic Locale(VirtualUniverse universe, int[] x, int[] y, int[] z)
universe
 the virtual universe that will contain this
Locale objectx
 an eight element array specifying the x positiony
 an eight element array specifying the y positionz
 an eight element array specifying the z positionpublic Locale(VirtualUniverse universe, HiResCoord hiRes)
universe
 the virtual universe that will contain this
Locale objecthiRes
 the HiRes coordinate to use in creating this Localepublic VirtualUniverse getVirtualUniverse()
public void setHiRes(int[] x, int[] y, int[] z)
x
 an eight element array specifying the x positiony
 an eight element array specifying the y positionz
 an eight element array specifying the z positionpublic void setHiRes(HiResCoord hiRes)
hiRes
 the HiRes coordinate specifying this node's new locationpublic void getHiRes(HiResCoord hiRes)
hiRes
 a HiResCoord object that will receive the
HiRes coordinate of this Locale nodepublic void addBranchGraph(BranchGroup branchGroup)
branchGroup
 root of the branch graph to be addedjava.lang.IllegalStateException
 if this Locale has been
removed from its VirtualUniverse.MultipleParentException
 if the specified BranchGroup node
is already live.public void removeBranchGraph(BranchGroup branchGroup)
branchGroup
 root of the branch graph to be removedjava.lang.IllegalStateException
 if this Locale has been
removed from its VirtualUniverse.CapabilityNotSetException
 if the ALLOW_DETACH capability is
not set in the specified BranchGroup node.public void replaceBranchGraph(BranchGroup oldGroup, BranchGroup newGroup)
oldGroup
 root of the branch graph to be replaced.newGroup
 root of the branch graph that will replace the old
branch graph.java.lang.IllegalStateException
 if this Locale has been
removed from its VirtualUniverse.CapabilityNotSetException
 if the ALLOW_DETACH capability is
not set in the old BranchGroup node.MultipleParentException
 if the new BranchGroup node
is already live.public int numBranchGraphs()
public java.util.Iterator<BranchGroup> getAllBranchGraphs()
java.lang.IllegalStateException
 if this Locale has been
removed from its VirtualUniverse.public SceneGraphPath[] pickAll(PickShape pickShape)
Locale
that intersect with PickShape.
The resultant array is unordered.pickShape
 the description of this picking volume or area.java.lang.IllegalStateException
 if this Locale has been
removed from its VirtualUniverse.BranchGroup.pickAll(org.jogamp.java3d.PickShape)
public PickInfo[] pickAll(int mode, int flags, PickShape pickShape)
Locale
that intersect with PickShape.
The accuracy of the pick is set by the pick mode. The mode include :
PickInfo.PICK_BOUNDS and PickInfo.PICK_GEOMETRY. The amount of information returned
is specified via a masked variable, flags, indicating which components are
present in each returned PickInfo object.mode
 picking mode, one of PickInfo.PICK_BOUNDS
or PickInfo.PICK_GEOMETRY
.flags
 a mask indicating which components are present in each PickInfo object.
This is specified as one or more individual bits that are bitwise "OR"ed together to
describe the PickInfo data. The flags include :
PickInfo.SCENEGRAPHPATH
 request for computed SceneGraphPath.PickInfo.NODE
 request for computed intersected Node.PickInfo.LOCAL_TO_VWORLD
 request for computed local to virtual world transform.PickInfo.CLOSEST_INTERSECTION_POINT
 request for closest intersection point.PickInfo.CLOSEST_DISTANCE
 request for the distance of closest intersection.PickInfo.CLOSEST_GEOM_INFO
 request for only the closest intersection geometry information.PickInfo.ALL_GEOM_INFO
 request for all intersection geometry information.pickShape
 the description of this picking volume or area.java.lang.IllegalArgumentException
 if flags contains both CLOSEST_GEOM_INFO and
ALL_GEOM_INFO.java.lang.IllegalArgumentException
 if pickShape is a PickPoint and pick mode
is set to PICK_GEOMETRY.java.lang.IllegalArgumentException
 if pick mode is neither PICK_BOUNDS
nor PICK_GEOMETRY.java.lang.IllegalArgumentException
 if pick mode is PICK_BOUNDS
and flags includes any of CLOSEST_INTERSECTION_POINT, CLOSEST_DISTANCE,
CLOSEST_GEOM_INFO or ALL_GEOM_INFO.java.lang.IllegalArgumentException
 if pickShape is PickBounds
and flags includes any of CLOSEST_INTERSECTION_POINT, CLOSEST_DISTANCE,
CLOSEST_GEOM_INFO or ALL_GEOM_INFO.java.lang.IllegalStateException
 if this Locale has been
removed from its VirtualUniverse.CapabilityNotSetException
 if the mode is
PICK_GEOMETRY and the Geometry.ALLOW_INTERSECT capability bit
is not set in any Geometry objects referred to by any shape
node whose bounds intersects the PickShape.CapabilityNotSetException
 if flags contains any of
CLOSEST_INTERSECTION_POINT, CLOSEST_DISTANCE, CLOSEST_GEOM_INFO
or ALL_GEOM_INFO, and the capability bits that control reading of
coordinate data are not set in any GeometryArray object referred
to by any shape node that intersects the PickShape.
The capability bits that must be set to avoid this exception are as follows :
BranchGroup.pickAll(int,int,org.jogamp.java3d.PickShape)
,
PickInfo
public SceneGraphPath[] pickAllSorted(PickShape pickShape)
pickShape
 the description of this picking volume or area.java.lang.IllegalStateException
 if this Locale has been
removed from its VirtualUniverse.BranchGroup.pickAllSorted(org.jogamp.java3d.PickShape)
public PickInfo[] pickAllSorted(int mode, int flags, PickShape pickShape)
mode
 picking mode, one of PickInfo.PICK_BOUNDS
or PickInfo.PICK_GEOMETRY
.flags
 a mask indicating which components are present in each PickInfo object.
This is specified as one or more individual bits that are bitwise "OR"ed together to
describe the PickInfo data. The flags include :
PickInfo.SCENEGRAPHPATH
 request for computed SceneGraphPath.PickInfo.NODE
 request for computed intersected Node.PickInfo.LOCAL_TO_VWORLD
 request for computed local to virtual world transform.PickInfo.CLOSEST_INTERSECTION_POINT
 request for closest intersection point.PickInfo.CLOSEST_DISTANCE
 request for the distance of closest intersection.PickInfo.CLOSEST_GEOM_INFO
 request for only the closest intersection geometry information.PickInfo.ALL_GEOM_INFO
 request for all intersection geometry information.pickShape
 the description of this picking volume or area.java.lang.IllegalArgumentException
 if flags contains both CLOSEST_GEOM_INFO and
ALL_GEOM_INFO.java.lang.IllegalArgumentException
 if pickShape is a PickPoint and pick mode
is set to PICK_GEOMETRY.java.lang.IllegalArgumentException
 if pick mode is neither PICK_BOUNDS
nor PICK_GEOMETRY.java.lang.IllegalArgumentException
 if pick mode is PICK_BOUNDS
and flags includes any of CLOSEST_INTERSECTION_POINT, CLOSEST_DISTANCE,
CLOSEST_GEOM_INFO or ALL_GEOM_INFO.java.lang.IllegalArgumentException
 if pickShape is PickBounds
and flags includes any of CLOSEST_INTERSECTION_POINT, CLOSEST_DISTANCE,
CLOSEST_GEOM_INFO or ALL_GEOM_INFO.java.lang.IllegalStateException
 if this Locale has been
removed from its VirtualUniverse.CapabilityNotSetException
 if the mode is
PICK_GEOMETRY and the Geometry.ALLOW_INTERSECT capability bit
is not set in any Geometry objects referred to by any shape
node whose bounds intersects the PickShape.CapabilityNotSetException
 if flags contains any of
CLOSEST_INTERSECTION_POINT, CLOSEST_DISTANCE, CLOSEST_GEOM_INFO
or ALL_GEOM_INFO, and the capability bits that control reading of
coordinate data are not set in any GeometryArray object referred
to by any shape node that intersects the PickShape.
The capability bits that must be set to avoid this exception are as follows :
BranchGroup.pickAllSorted(int,int,org.jogamp.java3d.PickShape)
,
PickInfo
public SceneGraphPath pickClosest(PickShape pickShape)
pickShape
.
pickShape
 the description of this picking volume or area.java.lang.IllegalStateException
 if this Locale has been
removed from its VirtualUniverse.BranchGroup.pickClosest(org.jogamp.java3d.PickShape)
public PickInfo pickClosest(int mode, int flags, PickShape pickShape)
pickShape
.
The accuracy of the pick is set by the pick mode. The mode include :
PickInfo.PICK_BOUNDS and PickInfo.PICK_GEOMETRY. The amount of information returned
is specified via a masked variable, flags, indicating which components are
present in each returned PickInfo object.mode
 picking mode, one of PickInfo.PICK_BOUNDS
or PickInfo.PICK_GEOMETRY
.flags
 a mask indicating which components are present in each PickInfo object.
This is specified as one or more individual bits that are bitwise "OR"ed together to
describe the PickInfo data. The flags include :
PickInfo.SCENEGRAPHPATH
 request for computed SceneGraphPath.PickInfo.NODE
 request for computed intersected Node.PickInfo.LOCAL_TO_VWORLD
 request for computed local to virtual world transform.PickInfo.CLOSEST_INTERSECTION_POINT
 request for closest intersection point.PickInfo.CLOSEST_DISTANCE
 request for the distance of closest intersection.PickInfo.CLOSEST_GEOM_INFO
 request for only the closest intersection geometry information.PickInfo.ALL_GEOM_INFO
 request for all intersection geometry information.pickShape
 the description of this picking volume or area.java.lang.IllegalArgumentException
 if flags contains both CLOSEST_GEOM_INFO and
ALL_GEOM_INFO.java.lang.IllegalArgumentException
 if pickShape is a PickPoint and pick mode
is set to PICK_GEOMETRY.java.lang.IllegalArgumentException
 if pick mode is neither PICK_BOUNDS
nor PICK_GEOMETRY.java.lang.IllegalArgumentException
 if pick mode is PICK_BOUNDS
and flags includes any of CLOSEST_INTERSECTION_POINT, CLOSEST_DISTANCE,
CLOSEST_GEOM_INFO or ALL_GEOM_INFO.java.lang.IllegalArgumentException
 if pickShape is PickBounds
and flags includes any of CLOSEST_INTERSECTION_POINT, CLOSEST_DISTANCE,
CLOSEST_GEOM_INFO or ALL_GEOM_INFO.java.lang.IllegalStateException
 if this Locale has been
removed from its VirtualUniverse.CapabilityNotSetException
 if the mode is
PICK_GEOMETRY and the Geometry.ALLOW_INTERSECT capability bit
is not set in any Geometry objects referred to by any shape
node whose bounds intersects the PickShape.CapabilityNotSetException
 if flags contains any of
CLOSEST_INTERSECTION_POINT, CLOSEST_DISTANCE, CLOSEST_GEOM_INFO
or ALL_GEOM_INFO, and the capability bits that control reading of
coordinate data are not set in any GeometryArray object referred
to by any shape node that intersects the PickShape.
The capability bits that must be set to avoid this exception are as follows :
BranchGroup.pickClosest(int,int,org.jogamp.java3d.PickShape)
,
PickInfo
public SceneGraphPath pickAny(PickShape pickShape)
pickShape
.pickShape
 the description of this picking volume or area.java.lang.IllegalStateException
 if this Locale has been
removed from its VirtualUniverse.BranchGroup.pickAny(org.jogamp.java3d.PickShape)
public PickInfo pickAny(int mode, int flags, PickShape pickShape)
pickShape
.
The accuracy of the pick is set by the pick mode. The mode include :
PickInfo.PICK_BOUNDS and PickInfo.PICK_GEOMETRY. The amount of information returned
is specified via a masked variable, flags, indicating which components are
present in each returned PickInfo object.mode
 picking mode, one of PickInfo.PICK_BOUNDS
or PickInfo.PICK_GEOMETRY
.flags
 a mask indicating which components are present in each PickInfo object.
This is specified as one or more individual bits that are bitwise "OR"ed together to
describe the PickInfo data. The flags include :
PickInfo.SCENEGRAPHPATH
 request for computed SceneGraphPath.PickInfo.NODE
 request for computed intersected Node.PickInfo.LOCAL_TO_VWORLD
 request for computed local to virtual world transform.PickInfo.CLOSEST_INTERSECTION_POINT
 request for closest intersection point.PickInfo.CLOSEST_DISTANCE
 request for the distance of closest intersection.PickInfo.CLOSEST_GEOM_INFO
 request for only the closest intersection geometry information.PickInfo.ALL_GEOM_INFO
 request for all intersection geometry information.pickShape
 the description of this picking volume or area.java.lang.IllegalArgumentException
 if flags contains both CLOSEST_GEOM_INFO and
ALL_GEOM_INFO.java.lang.IllegalArgumentException
 if pickShape is a PickPoint and pick mode
is set to PICK_GEOMETRY.java.lang.IllegalArgumentException
 if pick mode is neither PICK_BOUNDS
nor PICK_GEOMETRY.java.lang.IllegalArgumentException
 if pick mode is PICK_BOUNDS
and flags includes any of CLOSEST_INTERSECTION_POINT, CLOSEST_DISTANCE,
CLOSEST_GEOM_INFO or ALL_GEOM_INFO.java.lang.IllegalArgumentException
 if pickShape is PickBounds
and flags includes any of CLOSEST_INTERSECTION_POINT, CLOSEST_DISTANCE,
CLOSEST_GEOM_INFO or ALL_GEOM_INFO.java.lang.IllegalStateException
 if this Locale has been
removed from its VirtualUniverse.CapabilityNotSetException
 if the mode is
PICK_GEOMETRY and the Geometry.ALLOW_INTERSECT capability bit
is not set in any Geometry objects referred to by any shape
node whose bounds intersects the PickShape.CapabilityNotSetException
 if flags contains any of
CLOSEST_INTERSECTION_POINT, CLOSEST_DISTANCE, CLOSEST_GEOM_INFO
or ALL_GEOM_INFO, and the capability bits that control reading of
coordinate data are not set in any GeometryArray object referred
to by any shape node that intersects the PickShape.
The capability bits that must be set to avoid this exception are as follows :
BranchGroup.pickAny(int,int,org.jogamp.java3d.PickShape)
,
PickInfo