|
| |
|
| java.lang.Object
 javax.media.j3d.VirtualUniverse
All known Subclasses: com.sun.j3d.utils.universe.SimpleUniverse,
| VirtualUniverse | | public class VirtualUniverse extends Object (Code) | | A VirtualUniverse object is the top-level container for all scene
graphs. A virtual universe consists of a set of Locale objects,
each of which has a high-resolution position within the virtual
universe. An application or applet may have more than one
VirtualUniverse objects, but many applications will need only one.
Virtual universes are separate entities in that no node object may
exist in more than one virtual universe at any one time. Likewise,
the objects in one virtual universe are not visible in, nor do they
interact with objects in, any other virtual universe.
A VirtualUniverse object defines methods to enumerate its Locale
objects and to remove them from the virtual universe.
For more information, see the
Introduction to the Java 3D API and
Scene Graph Superstructure
documents.
See Also: Locale |
| Constructor Summary | |
| public | VirtualUniverse()
Constructs a new VirtualUniverse. |
| activeViewCount | | int activeViewCount(Code) | | |
| enableComponent | | boolean enableComponent(Code) | | |
| enableFocus | | boolean enableFocus(Code) | | |
| enableKey | | boolean enableKey(Code) | | |
| enableMouse | | boolean enableMouse(Code) | | |
| enableMouseMotion | | boolean enableMouseMotion(Code) | | |
| enableMouseWheel | | boolean enableMouseWheel(Code) | | |
| inBehavior | | boolean inBehavior(Code) | | |
| isSceneGraphLock | | boolean isSceneGraphLock(Code) | | |
| nodeIdCount | | long nodeIdCount(Code) | | |
| renderingEnvironmentStructureRefCount | | int renderingEnvironmentStructureRefCount(Code) | | |
| updateObjectsLen | | int updateObjectsLen(Code) | | |
| viewIdCount | | int viewIdCount(Code) | | |
| vpChanged | | boolean vpChanged(Code) | | |
| VirtualUniverse | | public VirtualUniverse()(Code) | | Constructs a new VirtualUniverse.
|
| addGraphStructureChangeListener | | public void addGraphStructureChangeListener(GraphStructureChangeListener listener)(Code) | | Adds the specified GraphStructureChangeListener to the set of listeners
that will be notified when the graph structure is changed on a live
scene graph. If the specifed listener is null no action is taken and no
exception is thrown.
Parameters:
listener - the listener to add to the set.
since:
Java 3D 1.4 |
| addLocale | | void addLocale(Locale locale)(Code) | | Adds a locale at the end of list of locales
Parameters:
locale - the locale to be added |
| addRenderingErrorListener | | public static void addRenderingErrorListener(RenderingErrorListener listener)(Code) | | Adds the specified RenderingErrorListener to the set of listeners
that will be notified when a rendering error is detected.
If the specifed listener is null no action is taken and no exception
is thrown.
If a rendering error occurs, the listeners will be called
asynchronously from a separate notification thread. If the set
of listeners is empty, a default listener is notified. The
default listener prints the error information to System.err and
then calls System.exit().
Parameters:
listener - the listener to add to the set.
since:
Java 3D 1.5 |
| addShaderErrorListener | | public void addShaderErrorListener(ShaderErrorListener listener)(Code) | | Adds the specified ShaderErrorListener to the set of listeners
that will be notified when a programmable shader error is
detected on a live scene graph. If the specifed listener is
null no action is taken and no exception is thrown.
If a shader error occurs, the listeners will be called
asynchronously from a separate notification thread. The Java 3D
renderer and behavior scheduler will continue to run as if the
error had not occurred, except that shading will be disabled
for the objects in error. If applications desire to detach or
modify the scene graph as a result of the error, they should
use a behavior post if they want that change to be
synchronous with the renderer.
Parameters:
listener - the listener to add to the set.
since:
Java 3D 1.4 |
| addViewIdToFreeList | | void addViewIdToFreeList(Integer viewId)(Code) | | This returns a viewId to the freelist
|
| checkForEnableEvents | | void checkForEnableEvents()(Code) | | |
| disableFocusEvents | | void disableFocusEvents()(Code) | | |
| disableKeyEvents | | void disableKeyEvents()(Code) | | |
| disableMouseEvents | | void disableMouseEvents()(Code) | | |
| disableMouseMotionEvents | | void disableMouseMotionEvents()(Code) | | |
| disableMouseWheelEvents | | void disableMouseWheelEvents()(Code) | | |
| enableComponentEvents | | void enableComponentEvents()(Code) | | |
| enableFocusEvents | | void enableFocusEvents()(Code) | | |
| enableKeyEvents | | void enableKeyEvents()(Code) | | |
| enableMouseEvents | | void enableMouseEvents()(Code) | | |
| enableMouseMotionEvents | | void enableMouseMotionEvents()(Code) | | |
| enableMouseWheelEvents | | void enableMouseWheelEvents()(Code) | | |
| getAllLocales | | public Enumeration getAllLocales()(Code) | | Returns the enumeration object of all locales in this virtual universe.
the enumeration object |
| getCurrentView | | final View getCurrentView()(Code) | | Returns the "current" view (the last view activated for this virtual
universe.
last activated view |
| getJ3DThreadPriority | | public static int getJ3DThreadPriority()(Code) | | Retrieves that priority of Java 3D's threads.
the current priority of Java 3D's threads
since:
Java 3D 1.2 |
| getNodeId | | String getNodeId()(Code) | | This returns the next available nodeId as a string.
|
| getProperties | | final public static Map getProperties()(Code) | | Returns a read-only Map object containing key-value pairs that
define various global properties for Java 3D. All of the keys
are String objects. The values are key-specific, but most will
be String objects.
The set of global Java 3D properties always includes values for
the following keys:
| Key (String) |
Value Type |
j3d.version |
String |
j3d.vendor |
String |
j3d.specification.version |
String |
j3d.specification.vendor |
String |
j3d.pipeline |
String |
j3d.renderer |
String |
The descriptions of the values returned for each key are as follows:
-
j3d.version
A String that defines the Java 3D implementation version.
The portion of the implementation version string before the first
space must adhere to one of the the following three formats
(anything after the first space is an optional free-form addendum
to the version):
where:
x is the major version number
y is the minor version number
z is the sub-minor version number
p is the patch revision number
ssss is a string, identifying a non-release build
(e.g., beta1, build47, rc1, etc.). It may only
contain letters, numbers, periods, dashes, or
underscores.
-
j3d.vendor
String that specifies the Java 3D implementation vendor.
-
j3d.specification.version
A String that defines the Java 3D specification version.
This string must be of the following form:
where:
x is the major version number
y is the minor version number
No other characters are allowed in the specification version string.
-
j3d.specification.vendor
String that specifies the Java 3D specification vendor.
-
j3d.pipeline
String that specifies the Java 3D rendering pipeline. This could
be one of: "NATIVE_OGL", "NATIVE_D3D", or "JOGL". Others could be
added in the future.
-
j3d.renderer
String that specifies the underlying rendering library. This could
be one of: "OpenGL" or "DirectX". Others could be added in the future.
the global Java 3D properties
since:
Java 3D 1.3 |
| getRootThreadGroup | | static ThreadGroup getRootThreadGroup()(Code) | | Method to return the root thread group. This must be called from
within a doPrivileged block.
|
| getViewId | | Integer getViewId()(Code) | | This returns the next available viewId
|
| getViewPlatformList | | synchronized Object[] getViewPlatformList()(Code) | | |
| initMCStructure | | void initMCStructure()(Code) | | |
| isEmpty | | boolean isEmpty()(Code) | | return true if all Locales under it don't have branchGroup
attach to it.
|
| loadLibraries | | static void loadLibraries()(Code) | | Initialize the native interface and anything else that needs
to be initialized.
|
| notifyRenderingErrorListeners | | static void notifyRenderingErrorListeners(RenderingError error)(Code) | | Notifies all listeners of a rendering error. If no listeners exist,
a default listener is notified.
|
| notifyShaderErrorListeners | | void notifyShaderErrorListeners(ShaderError error)(Code) | | Notifies all listeners of a shader error. If no listeners exist, a default
listener is notified.
|
| notifyStructureChangeListeners | | void notifyStructureChangeListeners(boolean add, Object parent, BranchGroup child)(Code) | | Processes all live BranchGroup add and removes and notifies
any registered listeners. Used for add and remove
|
| notifyStructureChangeListeners | | void notifyStructureChangeListeners(Object oldParent, Object newParent, BranchGroup child)(Code) | | Processes all live BranchGroup moves and notifies
any registered listeners. Used for moveTo
|
| numLocales | | public int numLocales()(Code) | | Returns the number of locales.
the count of locales |
| removeAllLocales | | public void removeAllLocales()(Code) | | Removes all Locales and their associates branch graphs from
this universe. All branch graphs within each Locale are
detached, regardless of whether their ALLOW_DETACH capability
bits are set. Each Locale is then marked as being dead: no
branch graphs may subsequently be attached. This method
should be called by applications and applets to allow
Java 3D to cleanup its resources.
since:
Java 3D 1.2 |
| removeGraphStructureChangeListener | | public void removeGraphStructureChangeListener(GraphStructureChangeListener listener)(Code) | | Removes the specified GraphStructureChangeListener from the set of listeners. This
method performs no function, nor does it throw an exception if the specified listener
is not currently in the set or is null.
Parameters:
listener - the listener to remove from the set.
since:
Java 3D 1.4 |
| removeLocale | | public void removeLocale(Locale locale)(Code) | | Removes a Locale and its associates branch graphs from this
universe. All branch graphs within the specified Locale are
detached, regardless of whether their ALLOW_DETACH capability
bits are set. The Locale is then marked as being dead: no
branch graphs may subsequently be attached.
Parameters:
locale - the Locale to be removed.
exception:
IllegalArgumentException - if the specified Locale is notattached to this VirtualUniverse.
since:
Java 3D 1.2 |
| removeRenderingErrorListener | | public static void removeRenderingErrorListener(RenderingErrorListener listener)(Code) | | Removes the specified RenderingErrorListener from the set of
listeners. This method performs no function, nor does it throw
an exception if the specified listener is not currently in the
set or is null.
Parameters:
listener - the listener to remove from the set.
since:
Java 3D 1.5 |
| removeShaderErrorListener | | public void removeShaderErrorListener(ShaderErrorListener listener)(Code) | | Removes the specified ShaderErrorListener from the set of
listeners. This method performs no function, nor does it throw
an exception if the specified listener is not currently in the
set or is null.
Parameters:
listener - the listener to remove from the set.
since:
Java 3D 1.4 |
| resetWaitMCFlag | | void resetWaitMCFlag()(Code) | | |
| setCurrentView | | final void setCurrentView(View view)(Code) | | Sets the "current" view (during view activation) for this virtual
universe.
Parameters:
last - activated view |
| setJ3DThreadPriority | | public static void setJ3DThreadPriority(int priority)(Code) | | Sets the priority of all Java 3D threads to the specified
value. The default value is the priority of the thread that
started Java 3D.
Parameters:
priority - the new thread priority
exception:
IllegalArgumentException - if the priority is not inthe range MIN_PRIORITY to MAX_PRIORITY
exception:
SecurityException - if the priority is greater thanthat of the calling thread
since:
Java 3D 1.2 |
| waitForMC | | void waitForMC()(Code) | | |
|
|
|