sonification.dataimport.visbards_resourcetoolkit.model
Interface Universe

public interface Universe

Allows to configure the general 3d settings.

Field Summary

static int	GRID_HIGH
static int	GRID_LOW
static int	GRID_NONE

Method Summary

void	addListener(UniverseListener listener) Registers a listener.
void	attach(Glyph glyph) Attach a glyph to the universe.
java.awt.image.BufferedImage	captureImage() Returns a buffered immage with the current screen snapshot
java.awt.image.BufferedImage	captureImageMac()
void	detach(Glyph glyph) Detach a glyph to the universe.
void	detachRoot() Detach the root from the universe to allow change in windowing
Glyph	findGlyph(java.awt.event.MouseEvent e) Returns the glyph at approprite coordinate.
void	flush() Ensure the canvas is up to date
java.awt.Canvas	getAnimCanvas()
ArrowManager	getArrowManager() Returns the arrow manager for this universe
java.awt.Color	getBackgroundColor() Returns the background color of the universe.
boolean	getBowShockMesh() Returns true if the Bow Shock is being rendered as a mesh
boolean	getBowShockSurface() Returns true if bow shock surface is visible
java.awt.Canvas	getCanvas() Returns the specified canvas.
java.lang.String	getDefaultDataDir() Returns the default data directory
java.lang.String	getDefaultRemoteDataDir() Returns the local data directory for remote files
boolean	getDTIAutoModeSwitching() Returns if automatic mode switching is enabled for the DTI display
boolean	getEarthRotate() Returns true if the Earth rotates with a change in the time slider
java.awt.Canvas	getFSCanvas()
int	getGridDetail() Returns current grid detail.
double	getLeftEyePos() Returns the x coordinate of the left eye
boolean	getLowDetail() Returns the detail of the display.
boolean	getMagnetopauseMesh() Returns true if the Magnetopause is being rendered as a mesh
boolean	getMagnetopauseSurface() Returns true if magnetopause surface is visible
boolean	getMagPoleVisible() Returns true if the magnetic pole is currently displayed.
double[][]	getMainTrans()
double	getMaxScale() Returns maximum slider value of plane of display
double	getMaxSeparation() Returns maximum slider value of stereo separation
double	getMinScale() Returns minimum slider value of plane of display
double	getMinSeparation() Returns minimum slider value of stereo separation
double	getMouseRotFactor() Returns the mouse rotation factor.
double	getMouseTransFactor() Returns the mouse translation factor.
double	getMouseZoomFactor() Returns the mouse zoom factor.
double	getMouseZRotFactor() Returns the mouse rotation factor about the Z-axis.
int	getNumGridlines() Returns number of gridlines
UniverseOrientationState	getOrientation() Returns the orientation of the universe
double[][]	getOverallTrans() The following functions allow access to variables for save session functionality
float	getPauseAlpha() Returns magnetoPause alpha blending cooficient
java.awt.Color	getPauseColor() Returns magnetoPause surface color
float	getPausePSW() Returns magnetoPause psw
double[]	getPickedLocation(java.awt.event.MouseEvent e) Returns the location of the picked object
double	getRightEyePos() Returns the x coordinate of the right eye
boolean	getStereoEnabled() Returns if stereo is enabled
boolean	getStereoEnabledApp() Returns if it is a stereo-enabled application
float	getSurfAlpha() Returns Surf alpha blending cooficient
java.awt.Color	getSurfColor() Returns Surf color
float	getSurfPSW() Returns Surf psw
boolean	getTranslucentPlane() Returns true if translucent plane is currently displayed.
double	getViewScaleFactor() Returns the view scale factor / depth of stereoscopic display
boolean	isArrowAntialiasingEnabled()
boolean	isDirectionalLightingEnabled() Return whether directional lighting is turned on or off.
void	makeLive() Start rendering the universe.
void	reattachRoot() Re-attach root to the universe to restart canvas after windowing change
void	removeListener(UniverseListener listener) Unregisters a listener.
void	resetAnchor() Change the target to home view
void	resetViewOrientation() Reset orientation
void	resetViewTranslation() Reset the translation of the view.
void	restoreAnimView()
void	restoreFullScreenView()
void	restorePanelView() Restarts rendering of the specified view
void	rotateEarth(double refTime) Rotates the Earth according to the given time
void	setArrowAntialiasingEnabled(boolean enable) Turns arrow antialiasing on or off
void	setBackgroundColor(java.awt.Color col) Changes the background color.
void	setBowShockMesh(boolean shock) Toggles between mesh and shaded rendering of the bow shock
void	setBowShockSurface(boolean show) Changes toggles the display of the bow shock on off.
void	setCenterType(int type) Inform the Universe the type of the datasets that are loaded.
void	setDefaultDataDir(java.lang.String dir) Sets the default data directory
void	setDefaultRemoteDataDir(java.lang.String dir) Sets the local data directory for remote files
void	setDirectionalLightingEnabled(boolean value) Turns directional lighting on or off.
void	setDTIAutoModeSwitching(boolean en) Sets whether or not the DTI display should automatically change modes
void	setEarthRotate(boolean value) Enables rotation of the Earth with a change in time
void	setGridDetail(int detail) Changes the grid detail.
void	setLeftEyePos(double p) Changes the left eye position (X coordinate only)
void	setLowDetail(boolean ld) Changes the detail of the display.
void	setMagnetopauseMesh(boolean pause) Toggles between mesh and shaded rendering of the magnetopause
void	setMagnetoPauseSurface(boolean show) Changes toggles the display of the bow shock on off.
void	setMagPoleVisible(boolean visible) Changes toggles the display of the translucent plane on off.
void	setMaxScale(double s) Sets maximum slider value of plane of display
void	setMaxSeparation(double s) Sets maximum slider value of stereo separation
void	setMinScale(double s) Sets minimum slider value of plane of display
void	setMinSeparation(double s) Sets minimum slider value of stereo separation
void	setMouseRotFactor(double f) Changes the mouse rotation factor.
void	setMouseTransFactor(double f) Changes the mouse translation factor.
void	setMouseZoomFactor(double f) Changes the mouse zoom factor.
void	setMouseZRotFactor(double f) Changes the mouse rotation factor about the z-axis.
void	setNumGridlines(int numgrid) Changes the number of gridlines.
void	setOrientation(UniverseOrientationState s1, UniverseOrientationState s2, float phase) Sets the orientation state of the universe, between s1 and s2 according to phase (which ranges from 0 to 1).
void	setOrientationOnSplinePath(float phase) Set the orientation on given spline path according to phase (0-1)
void	setPauseAlpha(float alpha) Changes the magnetoPause alpha blending cooficient
void	setPauseColor(java.awt.Color col) Changes magnetoPause surface color
void	setPausePSW(float psw) Changes the magnetoPause psw
void	setRightEyePos(double p) Changes the right eye position (X coordinate only)
void	setSplinePath(UniverseOrientationState[] s, float[] knots) Set the orientation spline path consisting of given states and with given knots
void	setStereoEnabled(boolean en) Sets stereo enabled/disabled
void	setStereoEnabledApp(boolean en) Sets stereo enabled/disabled for application -- should only be used during startup when settings are read from file
void	setSurfAlpha(float alpha) Changes the Surf alpha blending cooficient
void	setSurfColor(java.awt.Color col) Changes Surf color
void	setSurfPSW(float psw) Changes the magnetoPause psw
void	setTransforms(double[][] overall, double[][] main)
void	setTranslucentPlane(boolean plane) Changes toggles the display of the translucent plane on off.
void	setViewScaleFactor(double f) Sets view scale
void	stopAnimView()
void	stopFullScreenView()
void	stopPanelView() Stops the specified view from being rendered
void	updateCameraPos() Updates the camera position vector

Field Detail

GRID_NONE

static final int GRID_NONE

See Also:

Constant Field Values

GRID_LOW

static final int GRID_LOW

See Also:

Constant Field Values

GRID_HIGH

static final int GRID_HIGH

See Also:

Constant Field Values

Method Detail

makeLive

void makeLive()

Start rendering the universe.

getCanvas

java.awt.Canvas getCanvas()

Returns the specified canvas.

getFSCanvas

java.awt.Canvas getFSCanvas()

getAnimCanvas

java.awt.Canvas getAnimCanvas()

stopPanelView

void stopPanelView()

Stops the specified view from being rendered

stopFullScreenView

void stopFullScreenView()

stopAnimView

void stopAnimView()

restorePanelView

void restorePanelView()

Restarts rendering of the specified view

restoreFullScreenView

void restoreFullScreenView()

restoreAnimView

void restoreAnimView()

flush

void flush()

Ensure the canvas is up to date

detachRoot

void detachRoot()

Detach the root from the universe to allow change in windowing

reattachRoot

void reattachRoot()

Re-attach root to the universe to restart canvas after windowing change

captureImage

java.awt.image.BufferedImage captureImage()

Returns a buffered immage with the current screen snapshot

getBackgroundColor

java.awt.Color getBackgroundColor()

Returns the background color of the universe.

getMouseTransFactor

double getMouseTransFactor()

Returns the mouse translation factor.

getMouseZoomFactor

double getMouseZoomFactor()

Returns the mouse zoom factor.

getMouseRotFactor

double getMouseRotFactor()

Returns the mouse rotation factor.

getMouseZRotFactor

double getMouseZRotFactor()

Returns the mouse rotation factor about the Z-axis.

getLowDetail

boolean getLowDetail()

Returns the detail of the display.

getGridDetail

int getGridDetail()

Returns current grid detail.

getEarthRotate

boolean getEarthRotate()

Returns true if the Earth rotates with a change in the time slider

getTranslucentPlane

boolean getTranslucentPlane()

Returns true if translucent plane is currently displayed.

getMagPoleVisible

boolean getMagPoleVisible()

Returns true if the magnetic pole is currently displayed.

getBowShockMesh

boolean getBowShockMesh()

Returns true if the Bow Shock is being rendered as a mesh

getMagnetopauseMesh

boolean getMagnetopauseMesh()

Returns true if the Magnetopause is being rendered as a mesh

getBowShockSurface

boolean getBowShockSurface()

Returns true if bow shock surface is visible

getMagnetopauseSurface

boolean getMagnetopauseSurface()

Returns true if magnetopause surface is visible

getNumGridlines

int getNumGridlines()

Returns number of gridlines

getLeftEyePos

double getLeftEyePos()

Returns the x coordinate of the left eye

getRightEyePos

double getRightEyePos()

Returns the x coordinate of the right eye

getViewScaleFactor

double getViewScaleFactor()

Returns the view scale factor / depth of stereoscopic display

getStereoEnabledApp

boolean getStereoEnabledApp()

Returns if it is a stereo-enabled application

getStereoEnabled

boolean getStereoEnabled()

Returns if stereo is enabled

getDTIAutoModeSwitching

boolean getDTIAutoModeSwitching()

Returns if automatic mode switching is enabled for the DTI display

getMinSeparation

double getMinSeparation()

Returns minimum slider value of stereo separation

getMinScale

double getMinScale()

Returns minimum slider value of plane of display

getMaxSeparation

double getMaxSeparation()

Returns maximum slider value of stereo separation

getMaxScale

double getMaxScale()

Returns maximum slider value of plane of display

updateCameraPos

void updateCameraPos()

Updates the camera position vector

setLeftEyePos

void setLeftEyePos(double p)

Changes the left eye position (X coordinate only)

setRightEyePos

void setRightEyePos(double p)

Changes the right eye position (X coordinate only)

setStereoEnabled

void setStereoEnabled(boolean en)

Sets stereo enabled/disabled

setStereoEnabledApp

void setStereoEnabledApp(boolean en)

Sets stereo enabled/disabled for application -- should only be used during startup when settings are read from file

setDTIAutoModeSwitching

void setDTIAutoModeSwitching(boolean en)

Sets whether or not the DTI display should automatically change modes

setViewScaleFactor

void setViewScaleFactor(double f)

Sets view scale

setMinSeparation

void setMinSeparation(double s)

Sets minimum slider value of stereo separation

setMinScale

void setMinScale(double s)

Sets minimum slider value of plane of display

setMaxSeparation

void setMaxSeparation(double s)

Sets maximum slider value of stereo separation

setMaxScale

void setMaxScale(double s)

Sets maximum slider value of plane of display

isDirectionalLightingEnabled

boolean isDirectionalLightingEnabled()

Return whether directional lighting is turned on or off.

Returns:

True if directional lighting is enabled; false otherwise.

setDirectionalLightingEnabled

void setDirectionalLightingEnabled(boolean value)

Turns directional lighting on or off.

Parameters:

value - A value of 'true' turns on directional lighting.

setArrowAntialiasingEnabled

void setArrowAntialiasingEnabled(boolean enable)

Turns arrow antialiasing on or off

Parameters:

value - A value of 'true' turns on antialiasing (making it smooth)

isArrowAntialiasingEnabled

boolean isArrowAntialiasingEnabled()

setBackgroundColor

void setBackgroundColor(java.awt.Color col)

Changes the background color.

setEarthRotate

void setEarthRotate(boolean value)

Enables rotation of the Earth with a change in time

setMouseTransFactor

void setMouseTransFactor(double f)

Changes the mouse translation factor.

setMouseZoomFactor

void setMouseZoomFactor(double f)

Changes the mouse zoom factor.

setMouseRotFactor

void setMouseRotFactor(double f)

Changes the mouse rotation factor.

setMouseZRotFactor

void setMouseZRotFactor(double f)

Changes the mouse rotation factor about the z-axis.

setLowDetail

void setLowDetail(boolean ld)

Changes the detail of the display.

setGridDetail

void setGridDetail(int detail)

Changes the grid detail.

setTranslucentPlane

void setTranslucentPlane(boolean plane)

Changes toggles the display of the translucent plane on off.

setMagPoleVisible

void setMagPoleVisible(boolean visible)

Changes toggles the display of the translucent plane on off.

setBowShockMesh

void setBowShockMesh(boolean shock)

Toggles between mesh and shaded rendering of the bow shock

setMagnetopauseMesh

void setMagnetopauseMesh(boolean pause)

Toggles between mesh and shaded rendering of the magnetopause

setMagnetoPauseSurface

void setMagnetoPauseSurface(boolean show)

Changes toggles the display of the bow shock on off.

setBowShockSurface

void setBowShockSurface(boolean show)

Changes toggles the display of the bow shock on off.

setPausePSW

void setPausePSW(float psw)

Changes the magnetoPause psw

getPausePSW

float getPausePSW()

Returns magnetoPause psw

setPauseAlpha

void setPauseAlpha(float alpha)

Changes the magnetoPause alpha blending cooficient

getPauseAlpha

float getPauseAlpha()

Returns magnetoPause alpha blending cooficient

setPauseColor

void setPauseColor(java.awt.Color col)

Changes magnetoPause surface color

getPauseColor

java.awt.Color getPauseColor()

Returns magnetoPause surface color

setSurfPSW

void setSurfPSW(float psw)

Changes the magnetoPause psw

getSurfPSW

float getSurfPSW()

Returns Surf psw

setSurfAlpha

void setSurfAlpha(float alpha)

Changes the Surf alpha blending cooficient

getSurfAlpha

float getSurfAlpha()

Returns Surf alpha blending cooficient

setSurfColor

void setSurfColor(java.awt.Color col)

Changes Surf color

getSurfColor

java.awt.Color getSurfColor()

Returns Surf color

setNumGridlines

void setNumGridlines(int numgrid)

Changes the number of gridlines.

getDefaultDataDir

java.lang.String getDefaultDataDir()

Returns the default data directory

setDefaultDataDir

void setDefaultDataDir(java.lang.String dir)

Sets the default data directory

getDefaultRemoteDataDir

java.lang.String getDefaultRemoteDataDir()

Returns the local data directory for remote files

setDefaultRemoteDataDir

void setDefaultRemoteDataDir(java.lang.String dir)

Sets the local data directory for remote files

attach

void attach(Glyph glyph)

Attach a glyph to the universe.

detach

void detach(Glyph glyph)

Detach a glyph to the universe.

findGlyph

Glyph findGlyph(java.awt.event.MouseEvent e)

Returns the glyph at approprite coordinate.

getPickedLocation

double[] getPickedLocation(java.awt.event.MouseEvent e)

Returns the location of the picked object

getArrowManager

ArrowManager getArrowManager()

Returns the arrow manager for this universe

addListener

void addListener(UniverseListener listener)

Registers a listener.

removeListener

void removeListener(UniverseListener listener)

Unregisters a listener.

resetViewTranslation

void resetViewTranslation()

Reset the translation of the view.

resetAnchor

void resetAnchor()

Change the target to home view

setOrientation

void setOrientation(UniverseOrientationState s1,
                    UniverseOrientationState s2,
                    float phase)

Sets the orientation state of the universe, between s1 and s2 according to phase (which ranges from 0 to 1). If phase is 0, the universe orientation is s1, if phase is 1 the universe orientation is s2

getOrientation

UniverseOrientationState getOrientation()

Returns the orientation of the universe

setSplinePath

void setSplinePath(UniverseOrientationState[] s,
                   float[] knots)

Set the orientation spline path consisting of given states and with given knots

setOrientationOnSplinePath

void setOrientationOnSplinePath(float phase)

Set the orientation on given spline path according to phase (0-1)

resetViewOrientation

void resetViewOrientation()

Reset orientation

setCenterType

void setCenterType(int type)

Inform the Universe the type of the datasets that are loaded. This will determine whether a sun or earth is displayed on the screen and whether the gridlines are going to be in astronomical units or earth radii.

rotateEarth

void rotateEarth(double refTime)

Rotates the Earth according to the given time

captureImageMac

java.awt.image.BufferedImage captureImageMac()

getOverallTrans

double[][] getOverallTrans()

The following functions allow access to variables for save session functionality

getMainTrans

double[][] getMainTrans()

setTransforms

void setTransforms(double[][] overall,
                   double[][] main)