Details | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 1107 | chris | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| 2 | <!-- NewPage --> |
||
| 3 | <html lang="en"> |
||
| 4 | <head> |
||
| 5 | <!-- Generated by javadoc (version 1.7.0_17) on Sun Nov 03 15:35:44 CET 2013 --> |
||
| 6 | <title>PauseableThread (libgdx API)</title> |
||
| 7 | <meta name="date" content="2013-11-03"> |
||
| 8 | <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
||
| 9 | </head> |
||
| 10 | <body> |
||
| 11 | <script type="text/javascript"><!-- |
||
| 12 | if (location.href.indexOf('is-external=true') == -1) { |
||
| 13 | parent.document.title="PauseableThread (libgdx API)"; |
||
| 14 | } |
||
| 15 | //--> |
||
| 16 | </script> |
||
| 17 | <noscript> |
||
| 18 | <div>JavaScript is disabled on your browser.</div> |
||
| 19 | </noscript> |
||
| 20 | <!-- ========= START OF TOP NAVBAR ======= --> |
||
| 21 | <div class="topNav"><a name="navbar_top"> |
||
| 22 | <!-- --> |
||
| 23 | </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
||
| 24 | <!-- --> |
||
| 25 | </a> |
||
| 26 | <ul class="navList" title="Navigation"> |
||
| 27 | <li><a href="../../../../overview-summary.html">Overview</a></li> |
||
| 28 | <li><a href="package-summary.html">Package</a></li> |
||
| 29 | <li class="navBarCell1Rev">Class</li> |
||
| 30 | <li><a href="class-use/PauseableThread.html">Use</a></li> |
||
| 31 | <li><a href="package-tree.html">Tree</a></li> |
||
| 32 | <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
||
| 33 | <li><a href="../../../../index-all.html">Index</a></li> |
||
| 34 | <li><a href="../../../../help-doc.html">Help</a></li> |
||
| 35 | </ul> |
||
| 36 | <div class="aboutLanguage"><em> |
||
| 37 | libgdx API |
||
| 38 | <style> |
||
| 39 | body, td, th { font-family:Helvetica, Tahoma, Arial, sans-serif; font-size:10pt } |
||
| 40 | pre, code, tt { font-size:9pt; font-family:Lucida Console, Courier New, sans-serif } |
||
| 41 | h1, h2, h3, .FrameTitleFont, .FrameHeadingFont, .TableHeadingColor font { font-size:105%; font-weight:bold } |
||
| 42 | .TableHeadingColor { background:#EEEEFF; } |
||
| 43 | a { text-decoration:none } |
||
| 44 | a:hover { text-decoration:underline } |
||
| 45 | a:link, a:visited { color:blue } |
||
| 46 | table { border:0px } |
||
| 47 | .TableRowColor td:first-child { border-left:1px solid black } |
||
| 48 | .TableRowColor td { border:0px; border-bottom:1px solid black; border-right:1px solid black } |
||
| 49 | hr { border:0px; border-bottom:1px solid #333366; } |
||
| 50 | </style> |
||
| 51 | </em></div> |
||
| 52 | </div> |
||
| 53 | <div class="subNav"> |
||
| 54 | <ul class="navList"> |
||
| 55 | <li><a href="../../../../com/badlogic/gdx/utils/OrderedMap.html" title="class in com.badlogic.gdx.utils"><span class="strong">Prev Class</span></a></li> |
||
| 56 | <li><a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html" title="class in com.badlogic.gdx.utils"><span class="strong">Next Class</span></a></li> |
||
| 57 | </ul> |
||
| 58 | <ul class="navList"> |
||
| 59 | <li><a href="../../../../index.html?com/badlogic/gdx/utils/PauseableThread.html" target="_top">Frames</a></li> |
||
| 60 | <li><a href="PauseableThread.html" target="_top">No Frames</a></li> |
||
| 61 | </ul> |
||
| 62 | <ul class="navList" id="allclasses_navbar_top"> |
||
| 63 | <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
||
| 64 | </ul> |
||
| 65 | <div> |
||
| 66 | <script type="text/javascript"><!-- |
||
| 67 | allClassesLink = document.getElementById("allclasses_navbar_top"); |
||
| 68 | if(window==top) { |
||
| 69 | allClassesLink.style.display = "block"; |
||
| 70 | } |
||
| 71 | else { |
||
| 72 | allClassesLink.style.display = "none"; |
||
| 73 | } |
||
| 74 | //--> |
||
| 75 | </script> |
||
| 76 | </div> |
||
| 77 | <div> |
||
| 78 | <ul class="subNavList"> |
||
| 79 | <li>Summary: </li> |
||
| 80 | <li><a href="#nested_classes_inherited_from_class_java.lang.Thread">Nested</a> | </li> |
||
| 81 | <li><a href="#fields_inherited_from_class_java.lang.Thread">Field</a> | </li> |
||
| 82 | <li><a href="#constructor_summary">Constr</a> | </li> |
||
| 83 | <li><a href="#method_summary">Method</a></li> |
||
| 84 | </ul> |
||
| 85 | <ul class="subNavList"> |
||
| 86 | <li>Detail: </li> |
||
| 87 | <li>Field | </li> |
||
| 88 | <li><a href="#constructor_detail">Constr</a> | </li> |
||
| 89 | <li><a href="#method_detail">Method</a></li> |
||
| 90 | </ul> |
||
| 91 | </div> |
||
| 92 | <a name="skip-navbar_top"> |
||
| 93 | <!-- --> |
||
| 94 | </a></div> |
||
| 95 | <!-- ========= END OF TOP NAVBAR ========= --> |
||
| 96 | <!-- ======== START OF CLASS DATA ======== --> |
||
| 97 | <div class="header"> |
||
| 98 | <div class="subTitle">com.badlogic.gdx.utils</div> |
||
| 99 | <h2 title="Class PauseableThread" class="title">Class PauseableThread</h2> |
||
| 100 | </div> |
||
| 101 | <div class="contentContainer"> |
||
| 102 | <ul class="inheritance"> |
||
| 103 | <li>java.lang.Object</li> |
||
| 104 | <li> |
||
| 105 | <ul class="inheritance"> |
||
| 106 | <li>java.lang.Thread</li> |
||
| 107 | <li> |
||
| 108 | <ul class="inheritance"> |
||
| 109 | <li>com.badlogic.gdx.utils.PauseableThread</li> |
||
| 110 | </ul> |
||
| 111 | </li> |
||
| 112 | </ul> |
||
| 113 | </li> |
||
| 114 | </ul> |
||
| 115 | <div class="description"> |
||
| 116 | <ul class="blockList"> |
||
| 117 | <li class="blockList"> |
||
| 118 | <dl> |
||
| 119 | <dt>All Implemented Interfaces:</dt> |
||
| 120 | <dd>java.lang.Runnable</dd> |
||
| 121 | </dl> |
||
| 122 | <hr> |
||
| 123 | <br> |
||
| 124 | <pre>public class <span class="strong">PauseableThread</span> |
||
| 125 | extends java.lang.Thread</pre> |
||
| 126 | <div class="block">A pausable thread. The runnable must not execute an inifite loop but should return control to the thread as often as possible |
||
| 127 | so that the thread can actually pause.</div> |
||
| 128 | <dl><dt><span class="strong">Author:</span></dt> |
||
| 129 | <dd>mzechner</dd></dl> |
||
| 130 | </li> |
||
| 131 | </ul> |
||
| 132 | </div> |
||
| 133 | <div class="summary"> |
||
| 134 | <ul class="blockList"> |
||
| 135 | <li class="blockList"> |
||
| 136 | <!-- ======== NESTED CLASS SUMMARY ======== --> |
||
| 137 | <ul class="blockList"> |
||
| 138 | <li class="blockList"><a name="nested_class_summary"> |
||
| 139 | <!-- --> |
||
| 140 | </a> |
||
| 141 | <h3>Nested Class Summary</h3> |
||
| 142 | <ul class="blockList"> |
||
| 143 | <li class="blockList"><a name="nested_classes_inherited_from_class_java.lang.Thread"> |
||
| 144 | <!-- --> |
||
| 145 | </a> |
||
| 146 | <h3>Nested classes/interfaces inherited from class java.lang.Thread</h3> |
||
| 147 | <code>java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler</code></li> |
||
| 148 | </ul> |
||
| 149 | </li> |
||
| 150 | </ul> |
||
| 151 | <!-- =========== FIELD SUMMARY =========== --> |
||
| 152 | <ul class="blockList"> |
||
| 153 | <li class="blockList"><a name="field_summary"> |
||
| 154 | <!-- --> |
||
| 155 | </a> |
||
| 156 | <h3>Field Summary</h3> |
||
| 157 | <ul class="blockList"> |
||
| 158 | <li class="blockList"><a name="fields_inherited_from_class_java.lang.Thread"> |
||
| 159 | <!-- --> |
||
| 160 | </a> |
||
| 161 | <h3>Fields inherited from class java.lang.Thread</h3> |
||
| 162 | <code>MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY</code></li> |
||
| 163 | </ul> |
||
| 164 | </li> |
||
| 165 | </ul> |
||
| 166 | <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
||
| 167 | <ul class="blockList"> |
||
| 168 | <li class="blockList"><a name="constructor_summary"> |
||
| 169 | <!-- --> |
||
| 170 | </a> |
||
| 171 | <h3>Constructor Summary</h3> |
||
| 172 | <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
||
| 173 | <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
||
| 174 | <tr> |
||
| 175 | <th class="colOne" scope="col">Constructor and Description</th> |
||
| 176 | </tr> |
||
| 177 | <tr class="altColor"> |
||
| 178 | <td class="colOne"><code><strong><a href="../../../../com/badlogic/gdx/utils/PauseableThread.html#PauseableThread(java.lang.Runnable)">PauseableThread</a></strong>(java.lang.Runnable runnable)</code> |
||
| 179 | <div class="block">Constructs a new thread setting the runnable which will be called repeatadly in a loop.</div> |
||
| 180 | </td> |
||
| 181 | </tr> |
||
| 182 | </table> |
||
| 183 | </li> |
||
| 184 | </ul> |
||
| 185 | <!-- ========== METHOD SUMMARY =========== --> |
||
| 186 | <ul class="blockList"> |
||
| 187 | <li class="blockList"><a name="method_summary"> |
||
| 188 | <!-- --> |
||
| 189 | </a> |
||
| 190 | <h3>Method Summary</h3> |
||
| 191 | <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
||
| 192 | <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
||
| 193 | <tr> |
||
| 194 | <th class="colFirst" scope="col">Modifier and Type</th> |
||
| 195 | <th class="colLast" scope="col">Method and Description</th> |
||
| 196 | </tr> |
||
| 197 | <tr class="altColor"> |
||
| 198 | <td class="colFirst"><code>boolean</code></td> |
||
| 199 | <td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/PauseableThread.html#isPaused()">isPaused</a></strong>()</code> </td> |
||
| 200 | </tr> |
||
| 201 | <tr class="rowColor"> |
||
| 202 | <td class="colFirst"><code>void</code></td> |
||
| 203 | <td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/PauseableThread.html#onPause()">onPause</a></strong>()</code> |
||
| 204 | <div class="block">Pauses the thread.</div> |
||
| 205 | </td> |
||
| 206 | </tr> |
||
| 207 | <tr class="altColor"> |
||
| 208 | <td class="colFirst"><code>void</code></td> |
||
| 209 | <td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/PauseableThread.html#onResume()">onResume</a></strong>()</code> |
||
| 210 | <div class="block">Resumes the thread.</div> |
||
| 211 | </td> |
||
| 212 | </tr> |
||
| 213 | <tr class="rowColor"> |
||
| 214 | <td class="colFirst"><code>void</code></td> |
||
| 215 | <td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/PauseableThread.html#run()">run</a></strong>()</code> </td> |
||
| 216 | </tr> |
||
| 217 | <tr class="altColor"> |
||
| 218 | <td class="colFirst"><code>void</code></td> |
||
| 219 | <td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/PauseableThread.html#stopThread()">stopThread</a></strong>()</code> |
||
| 220 | <div class="block">Stops this thread</div> |
||
| 221 | </td> |
||
| 222 | </tr> |
||
| 223 | </table> |
||
| 224 | <ul class="blockList"> |
||
| 225 | <li class="blockList"><a name="methods_inherited_from_class_java.lang.Thread"> |
||
| 226 | <!-- --> |
||
| 227 | </a> |
||
| 228 | <h3>Methods inherited from class java.lang.Thread</h3> |
||
| 229 | <code>activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield</code></li> |
||
| 230 | </ul> |
||
| 231 | <ul class="blockList"> |
||
| 232 | <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
||
| 233 | <!-- --> |
||
| 234 | </a> |
||
| 235 | <h3>Methods inherited from class java.lang.Object</h3> |
||
| 236 | <code>equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> |
||
| 237 | </ul> |
||
| 238 | </li> |
||
| 239 | </ul> |
||
| 240 | </li> |
||
| 241 | </ul> |
||
| 242 | </div> |
||
| 243 | <div class="details"> |
||
| 244 | <ul class="blockList"> |
||
| 245 | <li class="blockList"> |
||
| 246 | <!-- ========= CONSTRUCTOR DETAIL ======== --> |
||
| 247 | <ul class="blockList"> |
||
| 248 | <li class="blockList"><a name="constructor_detail"> |
||
| 249 | <!-- --> |
||
| 250 | </a> |
||
| 251 | <h3>Constructor Detail</h3> |
||
| 252 | <a name="PauseableThread(java.lang.Runnable)"> |
||
| 253 | <!-- --> |
||
| 254 | </a> |
||
| 255 | <ul class="blockListLast"> |
||
| 256 | <li class="blockList"> |
||
| 257 | <h4>PauseableThread</h4> |
||
| 258 | <pre>public PauseableThread(java.lang.Runnable runnable)</pre> |
||
| 259 | <div class="block">Constructs a new thread setting the runnable which will be called repeatadly in a loop.</div> |
||
| 260 | <dl><dt><span class="strong">Parameters:</span></dt><dd><code>runnable</code> - the runnable.</dd></dl> |
||
| 261 | </li> |
||
| 262 | </ul> |
||
| 263 | </li> |
||
| 264 | </ul> |
||
| 265 | <!-- ============ METHOD DETAIL ========== --> |
||
| 266 | <ul class="blockList"> |
||
| 267 | <li class="blockList"><a name="method_detail"> |
||
| 268 | <!-- --> |
||
| 269 | </a> |
||
| 270 | <h3>Method Detail</h3> |
||
| 271 | <a name="run()"> |
||
| 272 | <!-- --> |
||
| 273 | </a> |
||
| 274 | <ul class="blockList"> |
||
| 275 | <li class="blockList"> |
||
| 276 | <h4>run</h4> |
||
| 277 | <pre>public void run()</pre> |
||
| 278 | <dl> |
||
| 279 | <dt><strong>Specified by:</strong></dt> |
||
| 280 | <dd><code>run</code> in interface <code>java.lang.Runnable</code></dd> |
||
| 281 | <dt><strong>Overrides:</strong></dt> |
||
| 282 | <dd><code>run</code> in class <code>java.lang.Thread</code></dd> |
||
| 283 | </dl> |
||
| 284 | </li> |
||
| 285 | </ul> |
||
| 286 | <a name="onPause()"> |
||
| 287 | <!-- --> |
||
| 288 | </a> |
||
| 289 | <ul class="blockList"> |
||
| 290 | <li class="blockList"> |
||
| 291 | <h4>onPause</h4> |
||
| 292 | <pre>public void onPause()</pre> |
||
| 293 | <div class="block">Pauses the thread. This call is non-blocking</div> |
||
| 294 | </li> |
||
| 295 | </ul> |
||
| 296 | <a name="onResume()"> |
||
| 297 | <!-- --> |
||
| 298 | </a> |
||
| 299 | <ul class="blockList"> |
||
| 300 | <li class="blockList"> |
||
| 301 | <h4>onResume</h4> |
||
| 302 | <pre>public void onResume()</pre> |
||
| 303 | <div class="block">Resumes the thread. This call is non-blocking</div> |
||
| 304 | </li> |
||
| 305 | </ul> |
||
| 306 | <a name="isPaused()"> |
||
| 307 | <!-- --> |
||
| 308 | </a> |
||
| 309 | <ul class="blockList"> |
||
| 310 | <li class="blockList"> |
||
| 311 | <h4>isPaused</h4> |
||
| 312 | <pre>public boolean isPaused()</pre> |
||
| 313 | <dl><dt><span class="strong">Returns:</span></dt><dd>whether this thread is paused or not</dd></dl> |
||
| 314 | </li> |
||
| 315 | </ul> |
||
| 316 | <a name="stopThread()"> |
||
| 317 | <!-- --> |
||
| 318 | </a> |
||
| 319 | <ul class="blockListLast"> |
||
| 320 | <li class="blockList"> |
||
| 321 | <h4>stopThread</h4> |
||
| 322 | <pre>public void stopThread()</pre> |
||
| 323 | <div class="block">Stops this thread</div> |
||
| 324 | </li> |
||
| 325 | </ul> |
||
| 326 | </li> |
||
| 327 | </ul> |
||
| 328 | </li> |
||
| 329 | </ul> |
||
| 330 | </div> |
||
| 331 | </div> |
||
| 332 | <!-- ========= END OF CLASS DATA ========= --> |
||
| 333 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
||
| 334 | <div class="bottomNav"><a name="navbar_bottom"> |
||
| 335 | <!-- --> |
||
| 336 | </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
||
| 337 | <!-- --> |
||
| 338 | </a> |
||
| 339 | <ul class="navList" title="Navigation"> |
||
| 340 | <li><a href="../../../../overview-summary.html">Overview</a></li> |
||
| 341 | <li><a href="package-summary.html">Package</a></li> |
||
| 342 | <li class="navBarCell1Rev">Class</li> |
||
| 343 | <li><a href="class-use/PauseableThread.html">Use</a></li> |
||
| 344 | <li><a href="package-tree.html">Tree</a></li> |
||
| 345 | <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
||
| 346 | <li><a href="../../../../index-all.html">Index</a></li> |
||
| 347 | <li><a href="../../../../help-doc.html">Help</a></li> |
||
| 348 | </ul> |
||
| 349 | <div class="aboutLanguage"><em>libgdx API</em></div> |
||
| 350 | </div> |
||
| 351 | <div class="subNav"> |
||
| 352 | <ul class="navList"> |
||
| 353 | <li><a href="../../../../com/badlogic/gdx/utils/OrderedMap.html" title="class in com.badlogic.gdx.utils"><span class="strong">Prev Class</span></a></li> |
||
| 354 | <li><a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html" title="class in com.badlogic.gdx.utils"><span class="strong">Next Class</span></a></li> |
||
| 355 | </ul> |
||
| 356 | <ul class="navList"> |
||
| 357 | <li><a href="../../../../index.html?com/badlogic/gdx/utils/PauseableThread.html" target="_top">Frames</a></li> |
||
| 358 | <li><a href="PauseableThread.html" target="_top">No Frames</a></li> |
||
| 359 | </ul> |
||
| 360 | <ul class="navList" id="allclasses_navbar_bottom"> |
||
| 361 | <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
||
| 362 | </ul> |
||
| 363 | <div> |
||
| 364 | <script type="text/javascript"><!-- |
||
| 365 | allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
||
| 366 | if(window==top) { |
||
| 367 | allClassesLink.style.display = "block"; |
||
| 368 | } |
||
| 369 | else { |
||
| 370 | allClassesLink.style.display = "none"; |
||
| 371 | } |
||
| 372 | //--> |
||
| 373 | </script> |
||
| 374 | </div> |
||
| 375 | <div> |
||
| 376 | <ul class="subNavList"> |
||
| 377 | <li>Summary: </li> |
||
| 378 | <li><a href="#nested_classes_inherited_from_class_java.lang.Thread">Nested</a> | </li> |
||
| 379 | <li><a href="#fields_inherited_from_class_java.lang.Thread">Field</a> | </li> |
||
| 380 | <li><a href="#constructor_summary">Constr</a> | </li> |
||
| 381 | <li><a href="#method_summary">Method</a></li> |
||
| 382 | </ul> |
||
| 383 | <ul class="subNavList"> |
||
| 384 | <li>Detail: </li> |
||
| 385 | <li>Field | </li> |
||
| 386 | <li><a href="#constructor_detail">Constr</a> | </li> |
||
| 387 | <li><a href="#method_detail">Method</a></li> |
||
| 388 | </ul> |
||
| 389 | </div> |
||
| 390 | <a name="skip-navbar_bottom"> |
||
| 391 | <!-- --> |
||
| 392 | </a></div> |
||
| 393 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
||
| 394 | <p class="legalCopy"><small> |
||
| 395 | <div style="font-size:9pt"><i> |
||
| 396 | Copyright © 2010-2013 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com) |
||
| 397 | </i></div> |
||
| 398 | </small></p> |
||
| 399 | </body> |
||
| 400 | </html> |