Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	AnimatorBase.AnimatorImpl
protected static interface	AnimatorBase.Condition
public static class	AnimatorBase.UncaughtAnimatorException

Field Summary

Modifier and Type	Field and Description
protected Thread	animThread
private static final Class<?>	awtAnimatorImplClazz
protected String	baseName
protected static final boolean	DEBUG
protected ArrayList<GLAutoDrawable>	drawables
protected boolean	drawablesEmpty
protected boolean	exclusiveContext
protected FPSCounterImpl	fpsCounter
protected boolean	ignoreExceptions
protected AnimatorBase.AnimatorImpl	impl
public static final int	MODE_EXPECT_AWT_RENDERING_THREAD If present in `modeBits` field and `AWT is available`, implementation is aware of the AWT EDT, otherwise not.
protected int	modeBits
protected static final long	POLLP_WAIT_FOR_FINISH_LIFECYCLE_ACTION
protected boolean	printExceptions
private static int	seqInstanceNumber
protected static final long	TO_WAIT_FOR_FINISH_LIFECYCLE_ACTION A 1s timeout while waiting for a native action response, limiting `finishLifecycleAction(Condition, long)`
protected GLAnimatorControl.UncaughtExceptionHandler	uncaughtExceptionHandler
protected Thread	userExclusiveContextThread
private final AnimatorBase.Condition	waitForNotAnimatingIfEmptyCondition

Constructor Summary

Access	Constructor and Description
public	AnimatorBase() Creates a new, empty Animator instance while expecting an AWT rendering thread if AWT is available.

Method Summary

Modifier and Type	Method and Description
public final synchronized void	add(final GLAutoDrawable the drawable to be added drawable) Implements com.jogamp.opengl.GLAnimatorControl.add. Adds a drawable to this animator's list of rendering drawables.
protected final void	display() Called every frame to cause redrawing of all of the GLAutoDrawables this Animator manages.
protected final synchronized boolean	Returns: `true` if `waitCondition.eval()` returned `false` or if `non-blocking`. Otherwise returns `false`. finishLifecycleAction(final AnimatorBase.Condition method will wait until TO is reached or `waitCondition.eval()` returns `false`. waitCondition, long if `0`, method will wait until TO is reached or being notified. if > `0`, method will wait for the given `pollPeriod` in milliseconds. pollPeriod)
protected final void	flushGLRunnables() Should be called in case of an uncaught exception from within the animator thread to flush all animator.
protected abstract String	getBaseName(String prefix)
public final synchronized Thread	getExclusiveContextThread() Returns the exclusive context thread if `isExclusiveContextEnabled()` and `isStarted()`, otherwise `null`.
public final long	getFPSStartTime() Implements com.jogamp.opengl.FPSCounter.getFPSStartTime. Returns the time of the first display call in milliseconds after enabling this feature via `setUpdateFPSFrames(int, PrintStream)`.
public final float	getLastFPS() Implements com.jogamp.opengl.FPSCounter.getLastFPS.
public final long	getLastFPSPeriod() Implements com.jogamp.opengl.FPSCounter.getLastFPSPeriod.
public final long	getLastFPSUpdateTime() Implements com.jogamp.opengl.FPSCounter.getLastFPSUpdateTime. Returns the time of the last update interval in milliseconds, if this feature is enabled via `setUpdateFPSFrames(int, PrintStream)`.
public synchronized int	getModeBits()
public final synchronized Thread	getThread() Implements com.jogamp.opengl.GLAnimatorControl.getThread.
protected static String	getThreadName()
public final float	getTotalFPS() Implements com.jogamp.opengl.FPSCounter.getTotalFPS.
public final long	getTotalFPSDuration() Implements com.jogamp.opengl.FPSCounter.getTotalFPSDuration.
public final int	getTotalFPSFrames() Implements com.jogamp.opengl.FPSCounter.getTotalFPSFrames.
public final GLAnimatorControl.UncaughtExceptionHandler	getUncaughtExceptionHandler() Implements com.jogamp.opengl.GLAnimatorControl.getUncaughtExceptionHandler. Returns the `UncaughtExceptionHandler` invoked when this `animator` abruptly `stops` due to an uncaught exception from one of its `GLAutoDrawable`s.
public final int	getUpdateFPSFrames() Implements com.jogamp.opengl.FPSCounter.getUpdateFPSFrames.
protected final synchronized boolean	Returns: `true` if handled, otherwise `false`. In case of `false`, caller needs to propagate the exception. handleUncaughtException(final AnimatorBase.UncaughtAnimatorException ue) Should be called in case of an uncaught exception from within the animator thread, throws given exception if no handler has been installed.
protected final synchronized void	initImpl(final boolean force) Initializes implementation details post setup, invoked at `add(GLAutoDrawable)`, `start()`, ..
public final synchronized boolean	isExclusiveContextEnabled() Returns `true`, if the exclusive context thread is enabled, otherwise `false`.
public synchronized boolean	isStarted() Implements com.jogamp.opengl.GLAnimatorControl.isStarted. Indicates whether this animator has been `started`.
public final synchronized void	remove(final GLAutoDrawable the drawable to be removed drawable) Implements com.jogamp.opengl.GLAnimatorControl.remove. Removes a drawable from the animator's list of rendering drawables.
public final void	resetFPSCounter() Implements com.jogamp.opengl.FPSCounter.resetFPSCounter. Reset all performance counter (startTime, currentTime, frame number)
protected final synchronized void	setDrawablesExclCtxState(final boolean enable) Should be called at `start()` and `stop()` from within the animator thread.
public final synchronized Thread	Returns: previous value setExclusiveContext(final Thread t) Dedicate all `GLAutoDrawable`'s context to the given exclusive context thread.
public final boolean	Returns: previous value setExclusiveContext(final boolean enable) Dedicate all `GLAutoDrawable`'s context to this animator thread.
public final void	setIgnoreExceptions(final boolean ignoreExceptions) Sets a flag causing this Animator to ignore exceptions produced while redrawing the drawables.
public final synchronized void	setModeBits(final boolean enable, final int bitValues) Enables or disables the given `bitValues` in this Animators `modeBits`.
public final void	setPrintExceptions(final boolean printExceptions) Sets a flag indicating that when exceptions are being ignored by this Animator (see `setIgnoreExceptions`), to print the exceptions' stack traces for diagnostic information.
public final void	setUncaughtExceptionHandler(final GLAnimatorControl.UncaughtExceptionHandler the `UncaughtExceptionHandler` to use as this `animator`'s uncaught exception handler. Pass `null` to unset the handler. handler) Implements com.jogamp.opengl.GLAnimatorControl.setUncaughtExceptionHandler. Set the handler invoked when this `animator` abruptly `stops` due to an uncaught exception from one of its `GLAutoDrawable`s.
public final void	setUpdateFPSFrames(final int Update interval in frames. At every rendered frames interval the currentTime and fps values are updated. If the frames interval is <= 0, no update will be issued, ie the FPSCounter feature is turned off. You may choose `DEFAULT_FRAMES_PER_INTERVAL`. frames, final PrintStream optional print stream where the fps values gets printed if not null at every frames interval out) Implements com.jogamp.opengl.FPSCounter.setUpdateFPSFrames.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private static final boolean	useAWTAnimatorImpl(final int modeBits)
protected final boolean	validateDrawablesExclCtxState(final Thread expected)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

animThread	back to summary
protected Thread animThread

awtAnimatorImplClazz	back to summary
private static final Class<?> awtAnimatorImplClazz

baseName	back to summary
protected String baseName

DEBUG	back to summary
protected static final boolean DEBUG

drawables	back to summary
protected ArrayList<GLAutoDrawable> drawables

drawablesEmpty	back to summary
protected boolean drawablesEmpty

exclusiveContext	back to summary
protected boolean exclusiveContext

fpsCounter	back to summary
protected FPSCounterImpl fpsCounter

ignoreExceptions	back to summary
protected boolean ignoreExceptions

impl	back to summary
protected AnimatorBase.AnimatorImpl impl

MODE_EXPECT_AWT_RENDERING_THREAD back to summary

MODE_EXPECT_AWT_RENDERING_THREAD	back to summary
public static final int MODE_EXPECT_AWT_RENDERING_THREAD If present in `modeBits` field and `AWT is available`, implementation is aware of the AWT EDT, otherwise not. This is the default. See Also `setModeBits(boolean, int)`

public static final int MODE_EXPECT_AWT_RENDERING_THREAD

If present in modeBits field and AWT is available, implementation is aware of the AWT EDT, otherwise not.

This is the default.

See Also: setModeBits(boolean, int)

modeBits	back to summary
protected int modeBits

POLLP_WAIT_FOR_FINISH_LIFECYCLE_ACTION	back to summary
protected static final long POLLP_WAIT_FOR_FINISH_LIFECYCLE_ACTION

printExceptions	back to summary
protected boolean printExceptions

seqInstanceNumber	back to summary
private static int seqInstanceNumber

TO_WAIT_FOR_FINISH_LIFECYCLE_ACTION	back to summary
protected static final long TO_WAIT_FOR_FINISH_LIFECYCLE_ACTION A 1s timeout while waiting for a native action response, limiting `finishLifecycleAction(Condition, long)`

uncaughtExceptionHandler	back to summary
protected GLAnimatorControl.UncaughtExceptionHandler uncaughtExceptionHandler

userExclusiveContextThread	back to summary
protected Thread userExclusiveContextThread

waitForNotAnimatingIfEmptyCondition	back to summary
private final AnimatorBase.Condition waitForNotAnimatingIfEmptyCondition

Constructor Detail

AnimatorBase back to summary

AnimatorBase	back to summary
public AnimatorBase() Creates a new, empty Animator instance while expecting an AWT rendering thread if AWT is available. See Also `GLProfile#isAWTAvailable()`

public AnimatorBase()

Creates a new, empty Animator instance while expecting an AWT rendering thread if AWT is available.

See Also: GLProfile#isAWTAvailable()

Method Detail

add back to summary

add	back to summary
public final synchronized void add(final GLAutoDrawable drawable) Implements com.jogamp.opengl.GLAnimatorControl.add. Doc from com.jogamp.opengl.GLAnimatorControl.add. Adds a drawable to this animator's list of rendering drawables. This allows the animator thread to become `animating`, in case the first drawable is added and the animator `is started`. Parameters drawable:GLAutoDrawable the drawable to be added Annotations @Override

public final synchronized void add(final GLAutoDrawable drawable)

Implements com.jogamp.opengl.GLAnimatorControl.add.

Doc from com.jogamp.opengl.GLAnimatorControl.add.

Adds a drawable to this animator's list of rendering drawables.

This allows the animator thread to become animating, in case the first drawable is added and the animator is started.

Parameters

drawable:GLAutoDrawable: the drawable to be added

Annotations

@Override

display	back to summary
protected final void display() throws UncaughtAnimatorException Called every frame to cause redrawing of all of the GLAutoDrawables this Animator manages. Subclasses should call this to get the most optimized painting behavior for the set of components this Animator manages, in particular when multiple lightweight widgets are continually being redrawn.

finishLifecycleAction back to summary

finishLifecycleAction	back to summary
protected final synchronized boolean finishLifecycleAction(final AnimatorBase.Condition waitCondition, long pollPeriod) Parameters waitCondition:AnimatorBase.Condition method will wait until TO is reached or `waitCondition.eval()` returns `false`. pollPeriod:long if `0`, method will wait until TO is reached or being notified. if > `0`, method will wait for the given `pollPeriod` in milliseconds. Returns:boolean `true` if `waitCondition.eval()` returned `false` or if `non-blocking`. Otherwise returns `false`.

protected final synchronized boolean finishLifecycleAction(final AnimatorBase.Condition waitCondition, long pollPeriod)

Parameters

waitCondition:AnimatorBase.Condition: method will wait until TO is reached or waitCondition.eval() returns false.
pollPeriod:long: if 0, method will wait until TO is reached or being notified. if > 0, method will wait for the given pollPeriod in milliseconds.

Returns:boolean

true if waitCondition.eval() returned false or if non-blocking. Otherwise returns false.

flushGLRunnables	back to summary
protected final void flushGLRunnables() Should be called in case of an uncaught exception from within the animator thread to flush all animator. The animator instance shall not be locked when calling this method!

flushGLRunnables

back to summary

protected final void flushGLRunnables()

Should be called in case of an uncaught exception from within the animator thread to flush all animator.

The animator instance shall not be locked when calling this method!

getBaseName	back to summary
protected abstract String getBaseName(String prefix)

getExclusiveContextThread back to summary

getExclusiveContextThread	back to summary
public final synchronized Thread getExclusiveContextThread() Returns the exclusive context thread if `isExclusiveContextEnabled()` and `isStarted()`, otherwise `null`. If exclusive context is enabled via `setExclusiveContext(boolean)` the `animator thread` is returned if above conditions are met. If exclusive context is enabled via `setExclusiveContext(Thread)` the user passed thread is returned if above conditions are met. See Also `setExclusiveContext(boolean)`, `setExclusiveContext(Thread)`

public final synchronized Thread getExclusiveContextThread()

Returns the exclusive context thread if isExclusiveContextEnabled() and isStarted(), otherwise null.

If exclusive context is enabled via setExclusiveContext(boolean) the animator thread is returned if above conditions are met.

If exclusive context is enabled via setExclusiveContext(Thread) the user passed thread is returned if above conditions are met.

See Also: setExclusiveContext(boolean), setExclusiveContext(Thread)

getFPSStartTime back to summary

getFPSStartTime	back to summary
public final long getFPSStartTime() Implements com.jogamp.opengl.FPSCounter.getFPSStartTime. Doc from com.jogamp.opengl.FPSCounter.getFPSStartTime. Returns the time of the first display call in milliseconds after enabling this feature via `setUpdateFPSFrames(int, PrintStream)`. This value is reset via `resetFPSCounter()`. Annotations @Override

public final long getFPSStartTime()

Implements com.jogamp.opengl.FPSCounter.getFPSStartTime.

Doc from com.jogamp.opengl.FPSCounter.getFPSStartTime.

Returns the time of the first display call in milliseconds after enabling this feature via setUpdateFPSFrames(int, PrintStream).
This value is reset via resetFPSCounter().

Annotations

@Override

getLastFPS back to summary

getLastFPS	back to summary
public final float getLastFPS() Implements com.jogamp.opengl.FPSCounter.getLastFPS. Returns:float Doc from com.jogamp.opengl.FPSCounter.getLastFPS. Last update interval's frames per seconds, `getUpdateFPSFrames()` / `getLastFPSPeriod()` Annotations @Override

public final float getLastFPS()

Implements com.jogamp.opengl.FPSCounter.getLastFPS.

Returns:float

Doc from com.jogamp.opengl.FPSCounter.getLastFPS.

Last update interval's frames per seconds, getUpdateFPSFrames() / getLastFPSPeriod()

Annotations

@Override

getLastFPSPeriod	back to summary
public final long getLastFPSPeriod() Implements com.jogamp.opengl.FPSCounter.getLastFPSPeriod. Returns:long Doc from com.jogamp.opengl.FPSCounter.getLastFPSPeriod. Duration of the last update interval in milliseconds. Annotations @Override

getLastFPSPeriod

back to summary

public final long getLastFPSPeriod()

Implements com.jogamp.opengl.FPSCounter.getLastFPSPeriod.

Returns:long

Doc from com.jogamp.opengl.FPSCounter.getLastFPSPeriod.

Duration of the last update interval in milliseconds.

Annotations

@Override

getLastFPSUpdateTime back to summary

getLastFPSUpdateTime	back to summary
public final long getLastFPSUpdateTime() Implements com.jogamp.opengl.FPSCounter.getLastFPSUpdateTime. Doc from com.jogamp.opengl.FPSCounter.getLastFPSUpdateTime. Returns the time of the last update interval in milliseconds, if this feature is enabled via `setUpdateFPSFrames(int, PrintStream)`. This value is reset via `resetFPSCounter()`. Annotations @Override

public final long getLastFPSUpdateTime()

Implements com.jogamp.opengl.FPSCounter.getLastFPSUpdateTime.

Doc from com.jogamp.opengl.FPSCounter.getLastFPSUpdateTime.

Returns the time of the last update interval in milliseconds, if this feature is enabled via setUpdateFPSFrames(int, PrintStream).
This value is reset via resetFPSCounter().

Annotations

@Override

getModeBits	back to summary
public synchronized int getModeBits()

getThread	back to summary
public final synchronized Thread getThread() Implements com.jogamp.opengl.GLAnimatorControl.getThread. Returns:Thread Doc from com.jogamp.opengl.GLAnimatorControl.getThread. The animation thread if running, otherwise null. Annotations @Override

getThread

back to summary

public final synchronized Thread getThread()

Implements com.jogamp.opengl.GLAnimatorControl.getThread.

Returns:Thread

Doc from com.jogamp.opengl.GLAnimatorControl.getThread.

The animation thread if running, otherwise null.

Annotations

@Override

getThreadName	back to summary
protected static String getThreadName()

getTotalFPS back to summary

getTotalFPS	back to summary
public final float getTotalFPS() Implements com.jogamp.opengl.FPSCounter.getTotalFPS. Returns:float Doc from com.jogamp.opengl.FPSCounter.getTotalFPS. Total frames per seconds, `getTotalFPSFrames()` / `getTotalFPSDuration()` Annotations @Override

public final float getTotalFPS()

Implements com.jogamp.opengl.FPSCounter.getTotalFPS.

Returns:float

Doc from com.jogamp.opengl.FPSCounter.getTotalFPS.

Total frames per seconds, getTotalFPSFrames() / getTotalFPSDuration()

Annotations

@Override

getTotalFPSDuration back to summary

getTotalFPSDuration	back to summary
public final long getTotalFPSDuration() Implements com.jogamp.opengl.FPSCounter.getTotalFPSDuration. Returns:long Doc from com.jogamp.opengl.FPSCounter.getTotalFPSDuration. Total duration in milliseconds, `getLastFPSUpdateTime()` - `getFPSStartTime()` Annotations @Override

public final long getTotalFPSDuration()

Implements com.jogamp.opengl.FPSCounter.getTotalFPSDuration.

Returns:long

Doc from com.jogamp.opengl.FPSCounter.getTotalFPSDuration.

Total duration in milliseconds, getLastFPSUpdateTime() - getFPSStartTime()

Annotations

@Override

getTotalFPSFrames back to summary

getTotalFPSFrames	back to summary
public final int getTotalFPSFrames() Implements com.jogamp.opengl.FPSCounter.getTotalFPSFrames. Returns:int Doc from com.jogamp.opengl.FPSCounter.getTotalFPSFrames. Number of frame rendered since `getFPSStartTime()` up to `getLastFPSUpdateTime()` Annotations @Override

public final int getTotalFPSFrames()

Implements com.jogamp.opengl.FPSCounter.getTotalFPSFrames.

Returns:int

Doc from com.jogamp.opengl.FPSCounter.getTotalFPSFrames.

Number of frame rendered since getFPSStartTime() up to getLastFPSUpdateTime()

Annotations

@Override

getUncaughtExceptionHandler back to summary

getUncaughtExceptionHandler	back to summary
public final GLAnimatorControl.UncaughtExceptionHandler getUncaughtExceptionHandler() Implements com.jogamp.opengl.GLAnimatorControl.getUncaughtExceptionHandler. Doc from com.jogamp.opengl.GLAnimatorControl.getUncaughtExceptionHandler. Returns the `UncaughtExceptionHandler` invoked when this `animator` abruptly `stops` due to an uncaught exception from one of its `GLAutoDrawable`s. Default is `null`. Annotations @Override

public final GLAnimatorControl.UncaughtExceptionHandler getUncaughtExceptionHandler()

Implements com.jogamp.opengl.GLAnimatorControl.getUncaughtExceptionHandler.

Doc from com.jogamp.opengl.GLAnimatorControl.getUncaughtExceptionHandler.

Returns the UncaughtExceptionHandler invoked when this animator abruptly stops due to an uncaught exception from one of its GLAutoDrawables.

Default is null.

Annotations

@Override

getUpdateFPSFrames	back to summary
public final int getUpdateFPSFrames() Implements com.jogamp.opengl.FPSCounter.getUpdateFPSFrames. Returns:int Doc from com.jogamp.opengl.FPSCounter.getUpdateFPSFrames. update interval in frames Annotations @Override

getUpdateFPSFrames

back to summary

public final int getUpdateFPSFrames()

Implements com.jogamp.opengl.FPSCounter.getUpdateFPSFrames.

Returns:int

Doc from com.jogamp.opengl.FPSCounter.getUpdateFPSFrames.

update interval in frames

Annotations

@Override

handleUncaughtException back to summary

handleUncaughtException	back to summary
protected final synchronized boolean handleUncaughtException(final AnimatorBase.UncaughtAnimatorException ue) Should be called in case of an uncaught exception from within the animator thread, throws given exception if no handler has been installed. Returns:boolean `true` if handled, otherwise `false`. In case of `false`, caller needs to propagate the exception.

protected final synchronized boolean handleUncaughtException(final AnimatorBase.UncaughtAnimatorException ue)

Should be called in case of an uncaught exception from within the animator thread, throws given exception if no handler has been installed.

Returns:boolean: true if handled, otherwise false. In case of false, caller needs to propagate the exception.

initImpl back to summary

initImpl	back to summary
protected final synchronized void initImpl(final boolean force) Initializes implementation details post setup, invoked at `add(GLAutoDrawable)`, `start()`, .. Operation is a NOP if `force` is `false` and this instance is already initialized. Exceptions GLException: if Animator is `isStarted()`

protected final synchronized void initImpl(final boolean force)

Initializes implementation details post setup, invoked at add(GLAutoDrawable), start(), ..

Operation is a NOP if force is false and this instance is already initialized.

Exceptions

GLException:: if Animator is isStarted()

isExclusiveContextEnabled back to summary

isExclusiveContextEnabled	back to summary
public final synchronized boolean isExclusiveContextEnabled() Returns `true`, if the exclusive context thread is enabled, otherwise `false`. See Also `setExclusiveContext(boolean)`, `setExclusiveContext(Thread)`

public final synchronized boolean isExclusiveContextEnabled()

Returns true, if the exclusive context thread is enabled, otherwise false.

See Also: setExclusiveContext(boolean), setExclusiveContext(Thread)

isStarted back to summary

isStarted	back to summary
public synchronized boolean isStarted() Implements com.jogamp.opengl.GLAnimatorControl.isStarted. Doc from com.jogamp.opengl.GLAnimatorControl.isStarted. Indicates whether this animator has been `started`. Annotations @Override

public synchronized boolean isStarted()

Implements com.jogamp.opengl.GLAnimatorControl.isStarted.

Doc from com.jogamp.opengl.GLAnimatorControl.isStarted.

Indicates whether this animator has been started.

Annotations

@Override

remove back to summary

remove	back to summary
public final synchronized void remove(final GLAutoDrawable drawable) Implements com.jogamp.opengl.GLAnimatorControl.remove. Doc from com.jogamp.opengl.GLAnimatorControl.remove. Removes a drawable from the animator's list of rendering drawables. This method should get called in case a drawable becomes invalid, and will not be recovered. This allows the animator thread to become `not animating`, in case the last drawable has been removed. Parameters drawable:GLAutoDrawable the drawable to be removed Annotations @Override

public final synchronized void remove(final GLAutoDrawable drawable)

Implements com.jogamp.opengl.GLAnimatorControl.remove.

Doc from com.jogamp.opengl.GLAnimatorControl.remove.

Removes a drawable from the animator's list of rendering drawables.

This method should get called in case a drawable becomes invalid, and will not be recovered.

This allows the animator thread to become not animating, in case the last drawable has been removed.

Parameters

drawable:GLAutoDrawable: the drawable to be removed

Annotations

@Override

resetFPSCounter	back to summary
public final void resetFPSCounter() Implements com.jogamp.opengl.FPSCounter.resetFPSCounter. Doc from com.jogamp.opengl.FPSCounter.resetFPSCounter. Reset all performance counter (startTime, currentTime, frame number) Annotations @Override

resetFPSCounter

back to summary

public final void resetFPSCounter()

Implements com.jogamp.opengl.FPSCounter.resetFPSCounter.

Doc from com.jogamp.opengl.FPSCounter.resetFPSCounter.

Reset all performance counter (startTime, currentTime, frame number)

Annotations

@Override

setDrawablesExclCtxState back to summary

setDrawablesExclCtxState	back to summary
protected final synchronized void setDrawablesExclCtxState(final boolean enable) Should be called at `start()` and `stop()` from within the animator thread. At `stop()` an additional `display()` call shall be issued to allow propagation of releasing the exclusive thread.

protected final synchronized void setDrawablesExclCtxState(final boolean enable)

Should be called at start() and stop() from within the animator thread.

At stop() an additional display() call shall be issued to allow propagation of releasing the exclusive thread.

setExclusiveContext back to summary

setExclusiveContext	back to summary
public final synchronized Thread setExclusiveContext(final Thread t) Dedicate all `GLAutoDrawable`'s context to the given exclusive context thread. The given thread will be exclusive to all `GLAutoDrawable`'s context while `isAnimating()`. If already started and disabling, method waits until change is propagated to all `GLAutoDrawable` if not called from the animator thread or `exclusive context thread`. Note Utilizing this feature w/ AWT could lead to an AWT-EDT deadlock, depending on the AWT implementation. Hence it is advised not to use it with native AWT GLAutoDrawable like GLCanvas. Returns:Thread previous value See Also `setExclusiveContext(boolean)`, `getExclusiveContextThread()`, `isExclusiveContextEnabled()`

public final synchronized Thread setExclusiveContext(final Thread t)

Dedicate all GLAutoDrawable's context to the given exclusive context thread.

The given thread will be exclusive to all GLAutoDrawable's context while isAnimating().

If already started and disabling, method waits until change is propagated to all GLAutoDrawable if not called from the animator thread or exclusive context thread.

Note

Utilizing this feature w/ AWT could lead to an AWT-EDT deadlock, depending on the AWT implementation. Hence it is advised not to use it with native AWT GLAutoDrawable like GLCanvas.

Returns:Thread: previous value
See Also: setExclusiveContext(boolean), getExclusiveContextThread(), isExclusiveContextEnabled()

setExclusiveContext back to summary

public final boolean setExclusiveContext(final boolean enable)

Dedicate all GLAutoDrawable's context to this animator thread.

The given thread will be exclusive to all GLAutoDrawable's context while isAnimating().

If already started and disabling, method waits until change is propagated to all GLAutoDrawable if not called from the animator thread or exclusive context thread.

Note

Utilizing this feature w/ AWT could lead to an AWT-EDT deadlock, depending on the AWT implementation. Hence it is advised not to use it with native AWT GLAutoDrawable like GLCanvas.

Returns:boolean: previous value
See Also: setExclusiveContext(Thread), getExclusiveContextThread(), isExclusiveContextEnabled()

setIgnoreExceptions	back to summary
public final void setIgnoreExceptions(final boolean ignoreExceptions) Sets a flag causing this Animator to ignore exceptions produced while redrawing the drawables. By default this flag is set to false, causing any exception thrown to halt the Animator.

setModeBits back to summary

public final synchronized void setModeBits(final boolean enable, final int bitValues) throws GLException

Enables or disables the given bitValues in this Animators modeBits.

Exceptions

GLException:: if Animator is isStarted() and MODE_EXPECT_AWT_RENDERING_THREAD about to change

setPrintExceptions	back to summary
public final void setPrintExceptions(final boolean printExceptions) Sets a flag indicating that when exceptions are being ignored by this Animator (see `setIgnoreExceptions`), to print the exceptions' stack traces for diagnostic information. Defaults to false.

setUncaughtExceptionHandler back to summary

public final void setUncaughtExceptionHandler(final GLAnimatorControl.UncaughtExceptionHandler handler)

Implements com.jogamp.opengl.GLAnimatorControl.setUncaughtExceptionHandler.

Doc from com.jogamp.opengl.GLAnimatorControl.setUncaughtExceptionHandler.

Set the handler invoked when this animator abruptly stops due to an uncaught exception from one of its GLAutoDrawables.

Parameters

handler:GLAnimatorControl.UncaughtExceptionHandler: the UncaughtExceptionHandler to use as this animator's uncaught exception handler. Pass null to unset the handler.

Annotations

@Override

setUpdateFPSFrames back to summary

public final void setUpdateFPSFrames(final int frames, final PrintStream out)

Implements com.jogamp.opengl.FPSCounter.setUpdateFPSFrames.

Parameters

frames:int

Doc from com.jogamp.opengl.FPSCounter.setUpdateFPSFrames.

Update interval in frames.
At every rendered frames interval the currentTime and fps values are updated. If the frames interval is <= 0, no update will be issued, ie the FPSCounter feature is turned off. You may choose DEFAULT_FRAMES_PER_INTERVAL.

out:PrintStream

Doc from com.jogamp.opengl.FPSCounter.setUpdateFPSFrames.

optional print stream where the fps values gets printed if not null at every frames interval

Annotations

@Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

useAWTAnimatorImpl	back to summary
private static final boolean useAWTAnimatorImpl(final int modeBits)

validateDrawablesExclCtxState	back to summary
protected final boolean validateDrawablesExclCtxState(final Thread expected)

com.jogamp.opengl.util back to summary

public Interface AnimatorBase.AnimatorImpl

Known Direct Implementers: com.jogamp.opengl.util.AWTAnimatorImpl, com.jogamp.opengl.util.DefaultAnimatorImpl

Method Summary

Modifier and Type	Method and Description
public boolean	blockUntilDone(final Thread thread)
public void	display(final ArrayList<GLAutoDrawable> drawables, final boolean ignoreExceptions, final boolean printExceptions)

Method Detail

blockUntilDone	back to summary
public boolean blockUntilDone(final Thread thread)

display	back to summary
public void display(final ArrayList<GLAutoDrawable> drawables, final boolean ignoreExceptions, final boolean printExceptions) throws UncaughtAnimatorException Exceptions UncaughtAnimatorException: as caused by `GLAutoDrawable#display()`

com.jogamp.opengl.util back to summary

protected Interface AnimatorBase.Condition

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if branching (continue waiting, action), otherwise false eval()

Method Detail

eval	back to summary
public boolean eval() Returns:boolean true if branching (continue waiting, action), otherwise false

com.jogamp.opengl.util back to summary

public Class AnimatorBase.UncaughtAnimatorException

Class Inheritance

extends RuntimeException

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
com.jogamp.opengl.util.AnimatorBase.UncaughtAnimatorException

Annotations

@SuppressWarnings:serial

Field Summary

Modifier and Type	Field and Description
pack-priv final GLAutoDrawable	drawable

Constructor Summary

Access	Constructor and Description
public	UncaughtAnimatorException(final GLAutoDrawable drawable, final Throwable cause)

Method Summary

Modifier and Type	Method and Description
public final GLAutoDrawable	getGLAutoDrawable()

Field Detail

drawable	back to summary
pack-priv final GLAutoDrawable drawable

Constructor Detail

UncaughtAnimatorException	back to summary
public UncaughtAnimatorException(final GLAutoDrawable drawable, final Throwable cause)

Method Detail

getGLAutoDrawable	back to summary
public final GLAutoDrawable getGLAutoDrawable()

public abstract Class AnimatorBase

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface AnimatorBase.AnimatorImpl

Method Summary

Method Detail

protected Interface AnimatorBase.Condition

Method Summary

Method Detail

public Class AnimatorBase.UncaughtAnimatorException

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail