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
|
/**
* 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 javax.media.opengl;
/**
* An animator control interface,
* which implementation may drive a {@link javax.media.opengl.GLAutoDrawable} animation.
* <P>
* Note that the methods {@link #start()} and {@link #stop()}
* shall be implemented fail-fast, ie {@link #start()} fails if not started, etc.
* This way an implementation can find implementation errors faster.
*/
public interface GLAnimatorControl {
/**
* @return Time of the first display call in milliseconds.
* This value is reset if started or resumed.
*
* @see #start()
* @see #resume()
*/
long getStartTime();
/**
* @return Time of the last display call in milliseconds.
* This value is reset if started or resumed.
*
* @see #start()
* @see #resume()
*/
long getCurrentTime();
/**
* @return Duration <code>getCurrentTime() - getStartTime()</code>.
*
* @see #getStartTime()
* @see #getCurrentTime()
*/
long getDuration();
/**
* @return Number of frame cycles displayed
* since the first display call, ie <code>getStartTime()</code>.
* This value is reset if started or resumed.
*
* @see #start()
* @see #resume()
*/
int getTotalFrames();
/** Reset all performance counter (startTime, currentTime, frame number) */
public void resetCounter();
/**
* Indicates whether this animator is running, ie. has been started and not stopped.
*
* @see #start()
* @see #stop()
* @see #pause()
* @see #resume()
*/
boolean isStarted();
/**
* Indicates whether this animator is running and animating,<br>
* the latter is true if it has {@link GLAutoDrawable}s to render and is not paused.
*
* @see #start()
* @see #stop()
* @see #pause()
* @see #resume()
*/
boolean isAnimating();
/**
* Indicates whether this animator is running and paused.
*
* @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>
* If started, all counters (time, frames, ..) are reset to zero.
*
* @see #stop()
* @see #isAnimating()
* @see #getThread()
* @throws GLException if started already
*/
void 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.
*
* @see #start()
* @see #isAnimating()
* @see #getThread()
* @throws GLException if not started
*/
void 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.
*
* @return false if if not started or already paused, 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>
* If resumed, all counters (time, frames, ..) are reset to zero.
*
* @return false if if not started or not paused, otherwise true
*
* @see #pause()
* @see #isAnimating()
*/
boolean resume();
/**
* Removes a drawable from the animator's list of rendering drawables.<br>
* This method should get called in case a drawable becomes invalid,
* and will not be recovered.<br>
* This allows the animator thread to become idle in case the last drawable
* has reached it's end of life.<br>
*
* @param drawable the to be removed drawable
*/
void remove(GLAutoDrawable drawable);
}
|
