1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
/**
* 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;
/**
* An animator control interface,
* which implementation may drive a {@link com.jogamp.opengl.GLAutoDrawable} animation.
*/
public interface GLAnimatorControl extends FPSCounter {
/**
* A {@link GLAnimatorControl#setUncaughtExceptionHandler(UncaughtExceptionHandler) registered}
* {@link UncaughtExceptionHandler} instance is invoked when an {@link GLAnimatorControl animator} abruptly {@link #stop() stops}
* due to an uncaught exception from one of its {@link GLAutoDrawable}s.
* @see #uncaughtException(GLAnimatorControl, GLAutoDrawable, Throwable)
* @see GLAnimatorControl#setUncaughtExceptionHandler(UncaughtExceptionHandler)
* @since 2.2
*/
public static interface UncaughtExceptionHandler {
/**
* Method invoked when the given {@link GLAnimatorControl} is {@link GLAnimatorControl#stop() stopped} due to the
* given uncaught exception happened on the given {@link GLAutoDrawable}.
* <p>
* The animator thread can still be retrieved via {@link GLAnimatorControl#getThread()}.
* </p>
* <p>
* All {@link GLAnimatorControl} states already reflect its stopped state.
* </p>
* <p>
* After this handler method is called, the {@link GLAnimatorControl} is stopped.
* </p>
* <p>
* Any exception thrown by this method will be ignored.
* </p>
* @param animator the {@link GLAnimatorControl}
* @param drawable the causing {@link GLAutoDrawable},
* may be {@code null} in case {@link Throwable} caused unrelated to any {@link GLAutoDrawable}.
* @param cause the uncaught exception
* @see GLAnimatorControl#setUncaughtExceptionHandler(UncaughtExceptionHandler)
* @since 2.2
*/
void uncaughtException(final GLAnimatorControl animator, final GLAutoDrawable drawable, final Throwable cause);
}
/**
* Indicates whether this animator has been {@link #start() started}.
*
* @see #start()
* @see #stop()
* @see #isPaused()
* @see #pause()
* @see #resume()
*/
boolean isStarted();
/**
* Indicates whether this animator {@link #isStarted() is started} and {@link #isPaused() is not paused}.
*
* @see #start()
* @see #stop()
* @see #pause()
* @see #resume()
*/
boolean isAnimating();
/**
* Indicates whether this animator {@link #isStarted() is started}
* and either {@link #pause() manually paused} or paused
* automatically due to no {@link #add(GLAutoDrawable) added} {@link GLAutoDrawable}s.
*
* @see #start()
* @see #stop()
* @see #pause()
* @see #resume()
*/
boolean isPaused();
/**
* @return The animation thread if running, otherwise null.
*
* @see #start()
* @see #stop()
*/
Thread getThread();
/**
* Starts this animator, if not running.
* <p>
* In most situations this method blocks until
* completion, except when called from the animation thread itself
* or in some cases from an implementation-internal thread like the
* AWT event queue thread.
* </p>
* <p>
* Note that an animator w/o {@link #add(GLAutoDrawable) added drawables}
* will be paused automatically.
* </p>
* <p>
* If started, all counters (time, frames, ..) are reset to zero.
* </p>
*
* @return true is started due to this call,
* otherwise false, ie started already or unable to start.
*
* @see #stop()
* @see #isAnimating()
* @see #isPaused()
* @see #getThread()
*/
boolean start();
/**
* Stops this animator.
* <p>
* In most situations this method blocks until
* completion, except when called from the animation thread itself
* or in some cases from an implementation-internal thread like the
* AWT event queue thread.
* </p>
*
* @return true is stopped due to this call,
* otherwise false, ie not started or unable to stop.
*
* @see #start()
* @see #isAnimating()
* @see #getThread()
*/
boolean stop();
/**
* Pauses this animator.
* <p>
* In most situations this method blocks until
* completion, except when called from the animation thread itself
* or in some cases from an implementation-internal thread like the
* AWT event queue thread.
* </p>
*
* @return false if not started, already paused or failed to pause, otherwise true
*
* @see #resume()
* @see #isAnimating()
*/
boolean pause();
/**
* Resumes animation if paused.
* <p>
* In most situations this method blocks until
* completion, except when called from the animation thread itself
* or in some cases from an implementation-internal thread like the
* AWT event queue thread.
* </p>
* <p>
* If resumed, all counters (time, frames, ..) are reset to zero.
* </p>
*
* @return false if not started, not paused or unable to resume, otherwise true
*
* @see #pause()
* @see #isAnimating()
*/
boolean resume();
/**
* Adds a drawable to this animator's list of rendering drawables.
* <p>
* This allows the animator thread to become {@link #isAnimating() animating},
* in case the first drawable is added and the animator {@link #isStarted() is started}.
* </p>
*
* @param drawable the drawable to be added
* @throws IllegalArgumentException if drawable was already added to this animator
*/
void add(GLAutoDrawable drawable);
/**
* Removes a drawable from the animator's list of rendering drawables.
* <p>
* This method should get called in case a drawable becomes invalid,
* and will not be recovered.
* </p>
* <p>
* This allows the animator thread to become {@link #isAnimating() not animating},
* in case the last drawable has been removed.
* </p>
*
* @param drawable the drawable to be removed
* @throws IllegalArgumentException if drawable was not added to this animator
*/
void remove(GLAutoDrawable drawable);
/**
* Returns the {@link UncaughtExceptionHandler} invoked when this {@link GLAnimatorControl animator} abruptly {@link #stop() stops}
* due to an uncaught exception from one of its {@link GLAutoDrawable}s.
* <p>
* Default is <code>null</code>.
* </p>
* @since 2.2
*/
UncaughtExceptionHandler getUncaughtExceptionHandler();
/**
* Set the handler invoked when this {@link GLAnimatorControl animator} abruptly {@link #stop() stops}
* due to an uncaught exception from one of its {@link GLAutoDrawable}s.
* @param handler the {@link UncaughtExceptionHandler} to use as this {@link GLAnimatorControl animator}'s uncaught exception
* handler. Pass <code>null</code> to unset the handler.
* @see UncaughtExceptionHandler#uncaughtException(GLAnimatorControl, GLAutoDrawable, Throwable)
* @since 2.2
*/
void setUncaughtExceptionHandler(final UncaughtExceptionHandler handler);
}
|
