aboutsummaryrefslogtreecommitdiffstats
path: root/src/jogl/classes/com/jogamp/opengl/util/AnimatorBase.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/jogl/classes/com/jogamp/opengl/util/AnimatorBase.java')
-rw-r--r--src/jogl/classes/com/jogamp/opengl/util/AnimatorBase.java145
1 files changed, 145 insertions, 0 deletions
diff --git a/src/jogl/classes/com/jogamp/opengl/util/AnimatorBase.java b/src/jogl/classes/com/jogamp/opengl/util/AnimatorBase.java
new file mode 100644
index 000000000..279fe33ef
--- /dev/null
+++ b/src/jogl/classes/com/jogamp/opengl/util/AnimatorBase.java
@@ -0,0 +1,145 @@
+/**
+ * Copyright 2010 JogAmp Community. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification, are
+ * permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this list of
+ * conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice, this list
+ * of conditions and the following disclaimer in the documentation and/or other materials
+ * provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * The views and conclusions contained in the software and documentation are those of the
+ * authors and should not be interpreted as representing official policies, either expressed
+ * or implied, of JogAmp Community.
+ */
+
+package com.jogamp.opengl.util;
+
+import com.jogamp.opengl.impl.Debug;
+import java.util.ArrayList;
+import java.util.Iterator;
+import javax.media.opengl.GLAnimatorControl;
+import javax.media.opengl.GLAutoDrawable;
+import javax.media.opengl.GLProfile;
+
+/**
+ * Base implementation of GLAnimatorControl
+ */
+public abstract class AnimatorBase implements GLAnimatorControl {
+ protected static final boolean DEBUG = Debug.debug("Animator");
+
+ private static int animatorCount = 0;
+
+ protected volatile ArrayList/*<GLAutoDrawable>*/ drawables = new ArrayList();
+ protected AnimatorImpl impl;
+ protected String baseName;
+ protected Thread thread;
+ protected boolean ignoreExceptions;
+ protected boolean printExceptions;
+ protected long startTime = 0;
+ protected long curTime = 0;
+ protected int totalFrames = 0;
+
+ /** Creates a new, empty Animator. */
+ public AnimatorBase() {
+ if(GLProfile.isAWTAvailable()) {
+ try {
+ impl = (AnimatorImpl) Class.forName("com.jogamp.opengl.util.awt.AWTAnimatorImpl").newInstance();
+ baseName = "AWTAnimator";
+ } catch (Exception e) { }
+ }
+ if(null==impl) {
+ impl = new AnimatorImpl();
+ baseName = "Animator";
+ }
+ synchronized (Animator.class) {
+ animatorCount++;
+ baseName = baseName.concat("-"+animatorCount);
+ }
+ }
+
+ protected abstract String getBaseName(String prefix);
+
+ public synchronized void add(GLAutoDrawable drawable) {
+ ArrayList newList = (ArrayList) drawables.clone();
+ newList.add(drawable);
+ drawables = newList;
+ drawable.setAnimator(this);
+ notifyAll();
+ }
+
+ public synchronized void remove(GLAutoDrawable drawable) {
+ ArrayList newList = (ArrayList) drawables.clone();
+ newList.remove(drawable);
+ drawables = newList;
+ drawable.setAnimator(null);
+ notifyAll();
+ }
+
+ /** 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. */
+ protected void display() {
+ impl.display(this, ignoreExceptions, printExceptions);
+ curTime = System.currentTimeMillis();
+ totalFrames++;
+ }
+
+ public Iterator drawableIterator() {
+ return drawables.iterator();
+ }
+
+ public long getCurrentTime() {
+ return curTime;
+ }
+
+ public long getDuration() {
+ return curTime - startTime;
+ }
+
+ protected abstract boolean getShouldPause();
+
+ protected abstract boolean getShouldStop();
+
+ public long getStartTime() {
+ return startTime;
+ }
+
+ public int getTotalFrames() {
+ return totalFrames;
+ }
+
+ public final synchronized Thread getThread() {
+ return thread;
+ }
+
+ /** 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. */
+ public void setIgnoreExceptions(boolean ignoreExceptions) {
+ this.ignoreExceptions = ignoreExceptions;
+ }
+
+ /** Sets a flag indicating that when exceptions are being ignored by
+ this Animator (see {@link #setIgnoreExceptions}), to print the
+ exceptions' stack traces for diagnostic information. Defaults to
+ false. */
+ public void setPrintExceptions(boolean printExceptions) {
+ this.printExceptions = printExceptions;
+ }
+}