org.openimaj.vis

Class Visualisation3D<D>

java.lang.Object

org.openimaj.vis.Visualisation3D<D>

Type Parameters:

D - Data type

All Implemented Interfaces:

EventListener, javax.media.opengl.GLEventListener, AnimatedVisualisationProvider, Visualisation<D>, VisualisationImageProvider

Direct Known Subclasses:

BarVisualisation3D, HeightMap3D, XYZVisualisation3D

public abstract class Visualisation3D<D>
extends Object
implements javax.media.opengl.GLEventListener, Visualisation<D>, AnimatedVisualisationProvider

Version:

$Author$, $Revision$, $Date$

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Created:

11 Jul 2013

Field Summary

Fields

Modifier and Type	Field and Description
protected CameraPositionProvider	cameraPosition Object that provide the camera position over time
protected D	data The data!
protected javax.media.opengl.glu.gl2.GLUgl2	glu The GLU library we'll use
protected com.jogamp.opengl.util.gl2.GLUT	glut The GLUT library we'll use
protected JOGLWindow	window The JOGL Window (NEWT)

Constructor Summary

Constructors

Constructor and Description
Visualisation3D(int width, int height)

Method Summary

Modifier and Type	Method and Description
void	addAnimatedVisualisationListener(AnimatedVisualisationListener avl) Add a visualisation listener to be informed of animation events.
void	display(javax.media.opengl.GLAutoDrawable drawable)
void	dispose(javax.media.opengl.GLAutoDrawable drawable)
protected void	finalize() Closes the window and cleans up
MBFImage	getVisualisationImage() Return the static visualisation image.
void	init(javax.media.opengl.GLAutoDrawable drawable)
boolean	isEnableLights()
void	removeAnimatedVisualisationListener(AnimatedVisualisationListener avl) Remove a given listener from being informed of animation events.
protected abstract void	renderVis(javax.media.opengl.GLAutoDrawable drawable) Render the visualisation into the drawable
void	reshape(javax.media.opengl.GLAutoDrawable drawable, int arg1, int arg2, int arg3, int arg4)
void	setData(D data) Set the data to display in the visualisation.
void	setEnableLights(boolean enableLights)
void	setRequiredSize(Dimension d) Set the required size of the visualisation image.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openimaj.vis.VisualisationImageProvider

updateVis

Field Detail

glu

protected final javax.media.opengl.glu.gl2.GLUgl2 glu

The GLU library we'll use

glut

protected final com.jogamp.opengl.util.gl2.GLUT glut

The GLUT library we'll use

window

protected JOGLWindow window

The JOGL Window (NEWT)

cameraPosition

protected CameraPositionProvider cameraPosition

Object that provide the camera position over time

data

protected D data

The data!

Constructor Detail

Visualisation3D

public Visualisation3D(int width,
                       int height)

Parameters:

width -

height -

Method Detail

renderVis

protected abstract void renderVis(javax.media.opengl.GLAutoDrawable drawable)

Render the visualisation into the drawable

Parameters:

drawable - The drawable

finalize

protected void finalize()
                 throws Throwable

Closes the window and cleans up

Overrides:

finalize in class Object

Throws:

Throwable

See Also:

Object.finalize()

addAnimatedVisualisationListener

public void addAnimatedVisualisationListener(AnimatedVisualisationListener avl)

Description copied from interface: AnimatedVisualisationProvider

Add a visualisation listener to be informed of animation events.

Specified by:

addAnimatedVisualisationListener in interface AnimatedVisualisationProvider

Parameters:

avl - The listener to add

removeAnimatedVisualisationListener

public void removeAnimatedVisualisationListener(AnimatedVisualisationListener avl)

Description copied from interface: AnimatedVisualisationProvider

Remove a given listener from being informed of animation events.

Specified by:

removeAnimatedVisualisationListener in interface AnimatedVisualisationProvider

Parameters:

avl - The listener to remove

init

public void init(javax.media.opengl.GLAutoDrawable drawable)

Specified by:

init in interface javax.media.opengl.GLEventListener

display

public void display(javax.media.opengl.GLAutoDrawable drawable)

Specified by:

display in interface javax.media.opengl.GLEventListener

See Also:

GLEventListener.display(javax.media.opengl.GLAutoDrawable)

dispose

public void dispose(javax.media.opengl.GLAutoDrawable drawable)

Specified by:

dispose in interface javax.media.opengl.GLEventListener

See Also:

GLEventListener.dispose(javax.media.opengl.GLAutoDrawable)

reshape

public void reshape(javax.media.opengl.GLAutoDrawable drawable,
                    int arg1,
                    int arg2,
                    int arg3,
                    int arg4)

Specified by:

reshape in interface javax.media.opengl.GLEventListener

See Also:

GLEventListener.reshape(javax.media.opengl.GLAutoDrawable, int, int, int, int)

getVisualisationImage

public MBFImage getVisualisationImage()

Return the static visualisation image.

Specified by:

getVisualisationImage in interface VisualisationImageProvider

Returns:

The visualisation image.

See Also:

VisualisationImageProvider.getVisualisationImage()

setRequiredSize

public void setRequiredSize(Dimension d)

Description copied from interface: VisualisationImageProvider

Set the required size of the visualisation image.

Specified by:

setRequiredSize in interface VisualisationImageProvider

Parameters:

d - The dimensions

setData

public void setData(D data)

Set the data to display in the visualisation.

Specified by:

setData in interface Visualisation<D>

Parameters:

data - The data to display

See Also:

Visualisation.setData(java.lang.Object)

isEnableLights

public boolean isEnableLights()

Returns:

the enableLights

setEnableLights

public void setEnableLights(boolean enableLights)

Parameters:

enableLights - the enableLights to set