org.openimaj.vis.general

Class JOGLWindow

java.lang.Object

org.openimaj.vis.general.JOGLWindow

public class JOGLWindow
extends Object

A wrapper around a NEWT window that allows you to get a canvas on which to draw.

Version:

$Author$, $Revision$, $Date$

Author:

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

Created:

4 Jul 2013

Constructor Summary

Constructors

Constructor and Description
JOGLWindow() Constructor that does not initialise the GL window.
JOGLWindow(int width, int height) Create a JOGL Window with the given size and the default properties.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the window and cleans up.
javax.media.opengl.GLAutoDrawable	getDrawableSurface() Get the drawable surface for 3D operations.
boolean	isAlwaysOnTop()
boolean	isFullscreen()
boolean	isMouseConfined()
boolean	isMouseVisible()
boolean	isUndecorated()
static void	main(String[] args) Simple test that opens a window, waits 2 seconds, then closes it.
void	setAlwaysOnTop(boolean alwaysOnTop)
void	setFullscreen(boolean fullscreen)
void	setMouseConfined(boolean mouseConfined)
void	setMouseVisible(boolean mouseVisible)
void	setUndecorated(boolean undecorated)
void	showWindow(int width, int height) Force an initialisation of the window.

Methods inherited from class java.lang.Object

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

Constructor Detail

JOGLWindow

public JOGLWindow(int width,
                  int height)

Create a JOGL Window with the given size and the default properties.

Parameters:

width - The width in pixels

height - The height in pixels

JOGLWindow

public JOGLWindow()

Constructor that does not initialise the GL window. This allows you to alter the window properties prior to calling showWindow().

Method Detail

showWindow

public void showWindow(int width,
                       int height)

Force an initialisation of the window. Only call this if you used the no arguments constructor.

Parameters:

width - The width

height - The height

close

public void close()

Closes the window and cleans up.

getDrawableSurface

public javax.media.opengl.GLAutoDrawable getDrawableSurface()

Get the drawable surface for 3D operations.

Returns:

the drawable surface

isUndecorated

public boolean isUndecorated()

Returns:

the undecorated

setUndecorated

public void setUndecorated(boolean undecorated)

Parameters:

undecorated - the undecorated to set

isAlwaysOnTop

public boolean isAlwaysOnTop()

Returns:

the alwaysOnTop

setAlwaysOnTop

public void setAlwaysOnTop(boolean alwaysOnTop)

Parameters:

alwaysOnTop - the alwaysOnTop to set

isFullscreen

public boolean isFullscreen()

Returns:

the fullscreen

setFullscreen

public void setFullscreen(boolean fullscreen)

Parameters:

fullscreen - the fullscreen to set

isMouseVisible

public boolean isMouseVisible()

Returns:

the mouseVisible

setMouseVisible

public void setMouseVisible(boolean mouseVisible)

Parameters:

mouseVisible - the mouseVisible to set

isMouseConfined

public boolean isMouseConfined()

Returns:

the mouseConfined

setMouseConfined

public void setMouseConfined(boolean mouseConfined)

Parameters:

mouseConfined - the mouseConfined to set

main

public static void main(String[] args)
                 throws InterruptedException

Simple test that opens a window, waits 2 seconds, then closes it.

Parameters:

args - Command-line args (not used)

Throws:

InterruptedException