DefaultUniverse (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.java3d.VirtualUniverse
- - org.scijava.java3d.utils.universe.SimpleUniverse
  - - ij3d.DefaultUniverse

All Implemented Interfaces:: BehaviorCallback

Direct Known Subclasses:: DefaultAnimatableUniverse

public abstract class DefaultUniverse
extends SimpleUniverse
implements BehaviorCallback

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DefaultUniverse.GlobalTransform
Stores the list of Transform3D that describe the view.

Nested Classes
Modifier and Type	Class and Description
`static class`	`DefaultUniverse.GlobalTransform` Stores the list of Transform3D that describe the view.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ANIMATE_TG` The index of the transform group in the viewing platform's MultiTransformGroup which is responsible for animation
`static int`	`ATTRIBUTE_COORD_SYSTEM` Constant used in showAttribute() specifying whether a global coordinate system should be displayed or not.
`static int`	`ATTRIBUTE_SCALEBAR` Constant used in showAttribute() specifying whether a scalebar should be displayed or not.
`protected Switch`	`attributesSwitch` Switch which holds the optionally displayable scalebar and coordinate system.
`protected BoundingSphere`	`bounds` The shared Bounds object which is needed for Java3D's scheduling mechanism.
`static int`	`CENTER_TG` The index of the transform group in the viewing platform's MultiTransformGroup which is responsible for centering
`protected ContentTransformer`	`contentTransformer` Reference to the ContentTransformer.
`protected WaitForNextFrameBehavior`	`frameBehavior` Reference to the WaitForNextFrameBehavior.
`protected Point3d`	`globalCenter` The global center point
`protected CoordinateSystem`	`globalCoord` Reference to the global coordinate system, which is optionally displayable.
`protected Point3d`	`globalMax` The global maximum point
`protected Point3d`	`globalMin` The global minimum point
`protected PointLight`	`light`
`protected InteractiveBehavior`	`mouseBehavior` Reference to the InteractiveBehavior.
`protected Picker`	`picker` Reference to the Picker.
`static int`	`ROTATION_TG` The index of the transform group in the viewing platform's MultiTransformGroup which is responsible for rotation
`protected Scalebar`	`scalebar` Reference to the optionally displayable scale bar.
`protected BranchGroup`	`scene` Reference to root BranchGroup.
`static int`	`TRANSLATE_TG` The index of the transform group in the viewing platform's MultiTransformGroup which is responsible for translation
`UIAdapter`	`ui` UIAdapter to handle calls to the ImageJ main window.
`protected boolean`	`useToFront` Flag indicating if the window of this universe should be brought to front when
`protected InteractiveViewPlatformTransformer`	`viewTransformer` Reference to the InteractiveViewPlatformTransformer.
`protected ImageWindow3D`	`win` A reference to the window in which this universe is shown.
`static int`	`ZOOM_TG` The index of the transform group in the viewing platform's MultiTransformGroup which is responsible for zooming

Fields inherited from class org.scijava.java3d.utils.universe.SimpleUniverse
locale, viewer

Fields inherited from interface ij3d.behaviors.BehaviorCallback
ROTATE, TRANSLATE

Constructor Summary

Constructors
Constructor and Description
`DefaultUniverse(int width, int height)` Constructor.
`DefaultUniverse(int width, int height, UIAdapter uia)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addInteractiveBehavior(InteractiveBehavior b)`
`void`	`addUniverseListener(UniverseListener l)` Register the specified UniverseListener
`void`	`cleanup()`
`void`	`close()` Close this universe and cleanup resources.
`abstract Iterator`	`contents()`
`void`	`fireCanvasResized()` Invokes the canvasResized() method of all registered UniverseListeners.
`void`	`fireContentAdded(Content c)` Invokes the contentAdded() method of all registered UniverseListeners.
`void`	`fireContentChanged(Content c)` Invokes the contentChanged() method of all registered UniverseListeners.
`void`	`fireContentRemoved(Content c)` Invokes the contentRemoved() method of all registered UniverseListeners.
`void`	`fireContentSelected(Content c)` Invokes the contentSelected() method of all registered UniverseListeners.
`void`	`fireTransformationFinished()` Invokes the transformationFinished() method of all registered UniverseListeners.
`void`	`fireTransformationStarted()` Invokes the transformationStarted() method of all registered UniverseListeners.
`void`	`fireTransformationUpdated()` Invokes the transformationUpdated() method of all registered UniverseListeners.
`void`	`fireUniverseClosed()` Invokes the univeresClosed() method of all registered UniverseListeners.
`TransformGroup`	`getAnimationTG()` Returns the TransformGroup of the viewing platform's MultiTransformGroup which is responsible for animation.
`TransformGroup`	`getCenterTG()` Returns the TransformGroup of the viewing platform's MultiTransformGroup which is responsible for centering the universe.
`ContentTransformer`	`getContentTransformer()` Returns a reference to the ContentTransformer which is used by this universe to handle mouse and keyboard input which aims to transform individual Contents.
`void`	`getGlobalTransform(DefaultUniverse.GlobalTransform transform)` Obtain a copy of all the Transform3D that describe the view such as zoom, pan, and rotation.
`PointLight`	`getLight()` Returns the point light source of this universe.
`Picker`	`getPicker()` Returns a reference to the Picker which is used by this universe to handle mouse input which aims to pick Contents and change landmark sets.
`TransformGroup`	`getRotationTG()` Returns the TransformGroup of the viewing platform's MultiTransformGroup which is responsible for rotation.
`Scalebar`	`getScalebar()` Returns a reference to the optionally displayable scale bar.
`BranchGroup`	`getScene()` Returns a reference to the root BranchGroup of this universe.
`abstract Content`	`getSelected()`
`Dimension`	`getSize()` Returns the dimensions of this universe.
`TransformGroup`	`getTranslateTG()` Returns the TransformGroup of the viewing platform's MultiTransformGroup which is responsible for translation.
`boolean`	`getUseToFront()` Returns the value of the useToFront flag.
`InteractiveViewPlatformTransformer`	`getViewPlatformTransformer()` Returns a reference to the InteractiveViewPlatformTransformer which is used by this universe to handle mouse and keyboard input which aims to transform the viewing platform.
`void`	`getVworldToCamera(Transform3D transform)` Copy the whole transformation, which transforms any point from the vworld coordinate system to the observer coordinate system.
`void`	`getVworldToCameraInverse(Transform3D transform)` Copy the inverse vworld to camera transformation, which transforms any point from the observer coordinate system to vworld coordinate system to the
`ImageWindow3D`	`getWindow()` Returns a reference to the window in which this universe is displayed.
`TransformGroup`	`getZoomTG()` Returns the TransformGroup of the viewing platform's MultiTransformGroup which is responsible for zooming.
`boolean`	`isAttributeVisible(int attribute)` Returns whether the specified attribute is visible or not.
`void`	`removeUniverseListener(UniverseListener l)` Remove the specified UniverseListener
`void`	`setGlobalTransform(DefaultUniverse.GlobalTransform transform)` Set the transforms for zoom, pan, and rotation.
`void`	`setInteractiveBehavior(InteractiveBehavior b)` Deprecated. This method should not be used any more from outside this class. Use addInteractiveBehavior() instead.
`void`	`setSize(int w, int h)` Set the dimensions of this universe.
`void`	`setUseToFront(boolean useToFront)` For some interactive applications, the use of toFront() in ImageWindow3D creates usability problems, so these methods allow one to supress this behaviour by calling setUseToFront(false).
`void`	`show()` Show this universe in a new window.
`void`	`showAttribute(int attribute, boolean flag)` Show or hide the specified attribute.
`ij.ImagePlus`	`takeSnapshot()` Returns a snapshot of the current viewer image.
`ij.ImagePlus`	`takeSnapshot(int w, int h)` Returns a snapshot of the given size.
`void`	`transformChanged(int type, Transform3D xf)` Implements the BehaviorCallback interface of the behavior objects used by this universe.
`void`	`waitForNextFrame()` Waits until the next frame is rendered.

Methods inherited from class org.scijava.java3d.utils.universe.SimpleUniverse
addBranchGraph, getCanvas, getCanvas, getLocale, getPreferredConfiguration, getViewer, getViewingPlatform

Methods inherited from class org.scijava.java3d.VirtualUniverse
addGraphStructureChangeListener, addRenderingErrorListener, addShaderErrorListener, getAllLocales, getJ3DThreadPriority, getProperties, numLocales, removeAllLocales, removeGraphStructureChangeListener, removeLocale, removeRenderingErrorListener, removeShaderErrorListener, setJ3DThreadPriority

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CENTER_TG
```
public static final int CENTER_TG
```
    The index of the transform group in the viewing platform's MultiTransformGroup which is responsible for centering
    
    See Also:
    
    Constant Field Values
  - ZOOM_TG
```
public static final int ZOOM_TG
```
    The index of the transform group in the viewing platform's MultiTransformGroup which is responsible for zooming
    
    See Also:
    
    Constant Field Values
  - TRANSLATE_TG
```
public static final int TRANSLATE_TG
```
    The index of the transform group in the viewing platform's MultiTransformGroup which is responsible for translation
    
    See Also:
    
    Constant Field Values
  - ANIMATE_TG
```
public static final int ANIMATE_TG
```
    The index of the transform group in the viewing platform's MultiTransformGroup which is responsible for animation
    
    See Also:
    
    Constant Field Values
  - ROTATION_TG
```
public static final int ROTATION_TG
```
    The index of the transform group in the viewing platform's MultiTransformGroup which is responsible for rotation
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_SCALEBAR
```
public static final int ATTRIBUTE_SCALEBAR
```
    Constant used in showAttribute() specifying whether a scalebar should be displayed or not.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_COORD_SYSTEM
```
public static final int ATTRIBUTE_COORD_SYSTEM
```
    Constant used in showAttribute() specifying whether a global coordinate system should be displayed or not.
    
    See Also:
    
    Constant Field Values
  - scene
```
protected BranchGroup scene
```
    Reference to root BranchGroup. This is the place to add global entries.
  - scalebar
```
protected Scalebar scalebar
```
    Reference to the optionally displayable scale bar.
  - globalCoord
```
protected CoordinateSystem globalCoord
```
    Reference to the global coordinate system, which is optionally displayable.
  - bounds
```
protected BoundingSphere bounds
```
    The shared Bounds object which is needed for Java3D's scheduling mechanism.
  - win
```
protected ImageWindow3D win
```
    A reference to the window in which this universe is shown.
  - globalMin
```
protected final Point3d globalMin
```
    The global minimum point
  - globalMax
```
protected final Point3d globalMax
```
    The global maximum point
  - globalCenter
```
protected final Point3d globalCenter
```
    The global center point
  - mouseBehavior
```
protected InteractiveBehavior mouseBehavior
```
    Reference to the InteractiveBehavior. This handles mouse and keyboard input.
  - contentTransformer
```
protected final ContentTransformer contentTransformer
```
    Reference to the ContentTransformer. This handles the mouse and keyboard input which addresses individual Contents and is used by the InteractiveBehavior.
  - picker
```
protected final Picker picker
```
    Reference to the Picker. This handles the picking of Contents and of landmark points of individual objects. The picker is also used by the InteractiveBehavior.
  - viewTransformer
```
protected final InteractiveViewPlatformTransformer viewTransformer
```
    Reference to the InteractiveViewPlatformTransformer. This handles mouse and keyboard input which transforms the whole view. It is used by the InteractiveBehavior.
  - frameBehavior
```
protected final WaitForNextFrameBehavior frameBehavior
```
    Reference to the WaitForNextFrameBehavior. This provides a way to wait until the next frame is rendered.
  - light
```
protected final PointLight light
```
  - ui
```
public final UIAdapter ui
```
    UIAdapter to handle calls to the ImageJ main window.
  - attributesSwitch
```
protected final Switch attributesSwitch
```
    Switch which holds the optionally displayable scalebar and coordinate system.
  - useToFront
```
protected boolean useToFront
```
    Flag indicating if the window of this universe should be brought to front when
- Constructor Detail
  - DefaultUniverse
```
public DefaultUniverse(int width,
                       int height)
```
    Constructor. Sets up the universe, adds the switch for the attributes (scalebar, coordinate syste), and initializes some light sources.
    
    Parameters:
    
    width -
    
    height -
  - DefaultUniverse
```
public DefaultUniverse(int width,
                       int height,
                       UIAdapter uia)
```
- Method Detail
  - getSelected
```
public abstract Content getSelected()
```
  - contents
```
public abstract Iterator contents()
```
  - setInteractiveBehavior
```
@Deprecated
public void setInteractiveBehavior(InteractiveBehavior b)
```
    Deprecated. This method should not be used any more from outside this class. Use addInteractiveBehavior() instead.
  - addInteractiveBehavior
```
public void addInteractiveBehavior(InteractiveBehavior b)
```
  - getVworldToCamera
```
public void getVworldToCamera(Transform3D transform)
```
    Copy the whole transformation, which transforms any point from the vworld coordinate system to the observer coordinate system.
  - getVworldToCameraInverse
```
public void getVworldToCameraInverse(Transform3D transform)
```
    Copy the inverse vworld to camera transformation, which transforms any point from the observer coordinate system to vworld coordinate system to the
  - getZoomTG
```
public TransformGroup getZoomTG()
```
    Returns the TransformGroup of the viewing platform's MultiTransformGroup which is responsible for zooming.
  - getCenterTG
```
public TransformGroup getCenterTG()
```
    Returns the TransformGroup of the viewing platform's MultiTransformGroup which is responsible for centering the universe.
  - getRotationTG
```
public TransformGroup getRotationTG()
```
    Returns the TransformGroup of the viewing platform's MultiTransformGroup which is responsible for rotation.
  - getTranslateTG
```
public TransformGroup getTranslateTG()
```
    Returns the TransformGroup of the viewing platform's MultiTransformGroup which is responsible for translation.
  - getAnimationTG
```
public TransformGroup getAnimationTG()
```
    Returns the TransformGroup of the viewing platform's MultiTransformGroup which is responsible for animation.
  - getGlobalTransform
```
public void getGlobalTransform(DefaultUniverse.GlobalTransform transform)
```
    Obtain a copy of all the Transform3D that describe the view such as zoom, pan, and rotation.
  - setGlobalTransform
```
public void setGlobalTransform(DefaultUniverse.GlobalTransform transform)
```
    Set the transforms for zoom, pan, and rotation.
  - getLight
```
public PointLight getLight()
```
    Returns the point light source of this universe.
  - getScalebar
```
public Scalebar getScalebar()
```
    Returns a reference to the optionally displayable scale bar.
  - getContentTransformer
```
public ContentTransformer getContentTransformer()
```
    Returns a reference to the ContentTransformer which is used by this universe to handle mouse and keyboard input which aims to transform individual Contents.
  - getPicker
```
public Picker getPicker()
```
    Returns a reference to the Picker which is used by this universe to handle mouse input which aims to pick Contents and change landmark sets.
  - getViewPlatformTransformer
```
public InteractiveViewPlatformTransformer getViewPlatformTransformer()
```
    Returns a reference to the InteractiveViewPlatformTransformer which is used by this universe to handle mouse and keyboard input which aims to transform the viewing platform.
  - showAttribute
```
public void showAttribute(int attribute,
                          boolean flag)
```
    Show or hide the specified attribute.
    
    Parameters:
    
    attribute, - one of ATTRIBUTE_SCALEBAR or ATTRIBUTE_COORD_SYSTEM
    
    flag, - indicating whether it should be displayed or hided.
  - isAttributeVisible
```
public boolean isAttributeVisible(int attribute)
```
    Returns whether the specified attribute is visible or not.
    
    Parameters:
    
    attribute, - one of ATTRIBUTE_SCALEBAR or ATTRIBUTE_COORD_SYSTEM.
  - getScene
```
public BranchGroup getScene()
```
    Returns a reference to the root BranchGroup of this universe.
  - transformChanged
```
public void transformChanged(int type,
                             Transform3D xf)
```
    Implements the BehaviorCallback interface of the behavior objects used by this universe. This method is invoked to inform about transformation changes. This method simply calls fireTransformationUpdated().
    
    Specified by:
    
    transformChanged in interface BehaviorCallback
  - waitForNextFrame
```
public void waitForNextFrame()
```
    Waits until the next frame is rendered.
  - setUseToFront
```
public void setUseToFront(boolean useToFront)
```
    For some interactive applications, the use of toFront() in ImageWindow3D creates usability problems, so these methods allow one to supress this behaviour by calling setUseToFront(false). This will only have an effect when off-screen 3D rendering is not available. You should be careful about using this - it will, for example, cause problems for scripted use of the viewer from macros if off-screen 3D rendering is not available.
  - getUseToFront
```
public boolean getUseToFront()
```
    Returns the value of the useToFront flag.
  - getSize
```
public Dimension getSize()
```
    Returns the dimensions of this universe.
  - setSize
```
public void setSize(int w,
                    int h)
```
    Set the dimensions of this universe.
    
    Parameters:
    
    w - the new width
    
    h - the new height
  - show
```
public void show()
```
    Show this universe in a new window.
  - close
```
public void close()
```
    Close this universe and cleanup resources.
  - cleanup
```
public void cleanup()
```
    Overrides:
    
    cleanup in class SimpleUniverse
  - getWindow
```
public ImageWindow3D getWindow()
```
    Returns a reference to the window in which this universe is displayed.
  - takeSnapshot
```
public ij.ImagePlus takeSnapshot()
```
    Returns a snapshot of the current viewer image.
  - takeSnapshot
```
public ij.ImagePlus takeSnapshot(int w,
                                 int h)
```
    Returns a snapshot of the given size.
  - addUniverseListener
```
public void addUniverseListener(UniverseListener l)
```
    Register the specified UniverseListener
  - removeUniverseListener
```
public void removeUniverseListener(UniverseListener l)
```
    Remove the specified UniverseListener
  - fireUniverseClosed
```
public void fireUniverseClosed()
```
    Invokes the univeresClosed() method of all registered UniverseListeners.
  - fireTransformationStarted
```
public void fireTransformationStarted()
```
    Invokes the transformationStarted() method of all registered UniverseListeners.
  - fireTransformationUpdated
```
public void fireTransformationUpdated()
```
    Invokes the transformationUpdated() method of all registered UniverseListeners.
  - fireTransformationFinished
```
public void fireTransformationFinished()
```
    Invokes the transformationFinished() method of all registered UniverseListeners.
  - fireContentAdded
```
public void fireContentAdded(Content c)
```
    Invokes the contentAdded() method of all registered UniverseListeners.
  - fireContentChanged
```
public void fireContentChanged(Content c)
```
    Invokes the contentChanged() method of all registered UniverseListeners.
  - fireContentRemoved
```
public void fireContentRemoved(Content c)
```
    Invokes the contentRemoved() method of all registered UniverseListeners.
  - fireContentSelected
```
public void fireContentSelected(Content c)
```
    Invokes the contentSelected() method of all registered UniverseListeners.
  - fireCanvasResized
```
public void fireCanvasResized()
```
    Invokes the canvasResized() method of all registered UniverseListeners.

Class DefaultUniverse

Nested Class Summary

Field Summary

Fields inherited from class org.scijava.java3d.utils.universe.SimpleUniverse

Fields inherited from interface ij3d.behaviors.BehaviorCallback

Constructor Summary

Method Summary

Methods inherited from class org.scijava.java3d.utils.universe.SimpleUniverse

Methods inherited from class org.scijava.java3d.VirtualUniverse

Methods inherited from class java.lang.Object

Field Detail

CENTER_TG

ZOOM_TG

TRANSLATE_TG

ANIMATE_TG

ROTATION_TG

ATTRIBUTE_SCALEBAR

ATTRIBUTE_COORD_SYSTEM

scene

scalebar

globalCoord

bounds

win

globalMin

globalMax

globalCenter

mouseBehavior

contentTransformer

picker

viewTransformer

frameBehavior

light

ui

attributesSwitch

useToFront

Constructor Detail

DefaultUniverse

DefaultUniverse

Method Detail

getSelected

contents

setInteractiveBehavior

addInteractiveBehavior

getVworldToCamera

getVworldToCameraInverse

getZoomTG

getCenterTG

getRotationTG

getTranslateTG

getAnimationTG

getGlobalTransform

setGlobalTransform

getLight

getScalebar

getContentTransformer

getPicker

getViewPlatformTransformer

showAttribute

isAttributeVisible

getScene

transformChanged

waitForNextFrame

setUseToFront

getUseToFront

getSize

setSize

show

close

cleanup

getWindow

takeSnapshot

takeSnapshot

addUniverseListener

removeUniverseListener

fireUniverseClosed

fireTransformationStarted

fireTransformationUpdated

fireTransformationFinished

fireContentAdded

fireContentChanged