Home Explore Help
Sign In
java
/
jMonkeyEngine-wiki
mirror of https://github.com/jMonkeyEngine/wiki.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: eda43e4eb7
Branches Tags
jMonkeyEngine-w...
/
jme3
/
advanced
/
application_states.html

application_states.html 55 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992 
  1. <!DOCTYPE html>
    2. 

  2. <html lang="en">
    3. 

  3. <head>
    4. 

  4. <meta charset="UTF-8">
    5. 

  5. <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
    6. 

  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
    7. 

  7. <meta name="generator" content="Asciidoctor 1.5.4">
    8. 

  8. <title>Application States</title>
    9. 

  9. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
    10. 

  10. <style>
    11. 

  11. /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
    12. 

  12. /* Remove comment around @import statement below when using as a custom stylesheet */
    13. 

  13. /*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
    14. 

  14. article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
    15. 

  15. audio,canvas,video{display:inline-block}
    16. 

  16. audio:not([controls]){display:none;height:0}
    17. 

  17. [hidden],template{display:none}
    18. 

  18. script{display:none!important}
    19. 

  19. html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
    20. 

  20. body{margin:0}
    21. 

  21. a{background:transparent}
    22. 

  22. a:focus{outline:thin dotted}
    23. 

  23. a:active,a:hover{outline:0}
    24. 

  24. h1{font-size:2em;margin:.67em 0}
    25. 

  25. abbr[title]{border-bottom:1px dotted}
    26. 

  26. b,strong{font-weight:bold}
    27. 

  27. dfn{font-style:italic}
    28. 

  28. hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
    29. 

  29. mark{background:#ff0;color:#000}
    30. 

  30. code,kbd,pre,samp{font-family:monospace;font-size:1em}
    31. 

  31. pre{white-space:pre-wrap}
    32. 

  32. q{quotes:"\201C" "\201D" "\2018" "\2019"}
    33. 

  33. small{font-size:80%}
    34. 

  34. sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
    35. 

  35. sup{top:-.5em}
    36. 

  36. sub{bottom:-.25em}
    37. 

  37. img{border:0}
    38. 

  38. svg:not(:root){overflow:hidden}
    39. 

  39. figure{margin:0}
    40. 

  40. fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
    41. 

  41. legend{border:0;padding:0}
    42. 

  42. button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
    43. 

  43. button,input{line-height:normal}
    44. 

  44. button,select{text-transform:none}
    45. 

  45. button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
    46. 

  46. button[disabled],html input[disabled]{cursor:default}
    47. 

  47. input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
    48. 

  48. input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}
    49. 

  49. input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}
    50. 

  50. button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
    51. 

  51. textarea{overflow:auto;vertical-align:top}
    52. 

  52. table{border-collapse:collapse;border-spacing:0}
    53. 

  53. *,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
    54. 

  54. html,body{font-size:100%}
    55. 

  55. body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto}
    56. 

  56. a:hover{cursor:pointer}
    57. 

  57. img,object,embed{max-width:100%;height:auto}
    58. 

  58. object,embed{height:100%}
    59. 

  59. img{-ms-interpolation-mode:bicubic}
    60. 

  60. .left{float:left!important}
    61. 

  61. .right{float:right!important}
    62. 

  62. .text-left{text-align:left!important}
    63. 

  63. .text-right{text-align:right!important}
    64. 

  64. .text-center{text-align:center!important}
    65. 

  65. .text-justify{text-align:justify!important}
    66. 

  66. .hide{display:none}
    67. 

  67. body{-webkit-font-smoothing:antialiased}
    68. 

  68. img,object,svg{display:inline-block;vertical-align:middle}
    69. 

  69. textarea{height:auto;min-height:50px}
    70. 

  70. select{width:100%}
    71. 

  71. .center{margin-left:auto;margin-right:auto}
    72. 

  72. .spread{width:100%}
    73. 

  73. p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6}
    74. 

  74. .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
    75. 

  75. div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
    76. 

  76. a{color:#2156a5;text-decoration:underline;line-height:inherit}
    77. 

  77. a:hover,a:focus{color:#1d4b8f}
    78. 

  78. a img{border:none}
    79. 

  79. p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
    80. 

  80. p aside{font-size:.875em;line-height:1.35;font-style:italic}
    81. 

  81. h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
    82. 

  82. h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
    83. 

  83. h1{font-size:2.125em}
    84. 

  84. h2{font-size:1.6875em}
    85. 

  85. h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
    86. 

  86. h4,h5{font-size:1.125em}
    87. 

  87. h6{font-size:1em}
    88. 

  88. hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
    89. 

  89. em,i{font-style:italic;line-height:inherit}
    90. 

  90. strong,b{font-weight:bold;line-height:inherit}
    91. 

  91. small{font-size:60%;line-height:inherit}
    92. 

  92. code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
    93. 

  93. ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
    94. 

  94. ul,ol,ul.no-bullet,ol.no-bullet{margin-left:1.5em}
    95. 

  95. ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
    96. 

  96. ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
    97. 

  97. ul.square{list-style-type:square}
    98. 

  98. ul.circle{list-style-type:circle}
    99. 

  99. ul.disc{list-style-type:disc}
    100. 

  100. ul.no-bullet{list-style:none}
    101. 

  101. ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
    102. 

  102. dl dt{margin-bottom:.3125em;font-weight:bold}
    103. 

  103. dl dd{margin-bottom:1.25em}
    104. 

  104. abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
    105. 

  105. abbr{text-transform:none}
    106. 

  106. blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
    107. 

  107. blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
    108. 

  108. blockquote cite:before{content:"\2014 \0020"}
    109. 

  109. blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
    110. 

  110. blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
    111. 

  111. @media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
    112. 

  112. h1{font-size:2.75em}
    113. 

  113. h2{font-size:2.3125em}
    114. 

  114. h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
    115. 

  115. h4{font-size:1.4375em}}
    116. 

  116. table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
    117. 

  117. table thead,table tfoot{background:#f7f8f7;font-weight:bold}
    118. 

  118. table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
    119. 

  119. table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
    120. 

  120. table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
    121. 

  121. table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
    122. 

  122. body{tab-size:4}
    123. 

  123. h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
    124. 

  124. h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
    125. 

  125. .clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table}
    126. 

  126. .clearfix:after,.float-group:after{clear:both}
    127. 

  127. *:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
    128. 

  128. pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed}
    129. 

  129. .keyseq{color:rgba(51,51,51,.8)}
    130. 

  130. kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
    131. 

  131. .keyseq kbd:first-child{margin-left:0}
    132. 

  132. .keyseq kbd:last-child{margin-right:0}
    133. 

  133. .menuseq,.menu{color:rgba(0,0,0,.8)}
    134. 

  134. b.button:before,b.button:after{position:relative;top:-1px;font-weight:400}
    135. 

  135. b.button:before{content:"[";padding:0 3px 0 2px}
    136. 

  136. b.button:after{content:"]";padding:0 2px 0 3px}
    137. 

  137. p a>code:hover{color:rgba(0,0,0,.9)}
    138. 

  138. #header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
    139. 

  139. #header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table}
    140. 

  140. #header:after,#content:after,#footnotes:after,#footer:after{clear:both}
    141. 

  141. #content{margin-top:1.25em}
    142. 

  142. #content:before{content:none}
    143. 

  143. #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
    144. 

  144. #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8}
    145. 

  145. #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px}
    146. 

  146. #header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
    147. 

  147. #header .details span:first-child{margin-left:-.125em}
    148. 

  148. #header .details span.email a{color:rgba(0,0,0,.85)}
    149. 

  149. #header .details br{display:none}
    150. 

  150. #header .details br+span:before{content:"\00a0\2013\00a0"}
    151. 

  151. #header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
    152. 

  152. #header .details br+span#revremark:before{content:"\00a0|\00a0"}
    153. 

  153. #header #revnumber{text-transform:capitalize}
    154. 

  154. #header #revnumber:after{content:"\00a0"}
    155. 

  155. #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
    156. 

  156. #toc{border-bottom:1px solid #efefed;padding-bottom:.5em}
    157. 

  157. #toc>ul{margin-left:.125em}
    158. 

  158. #toc ul.sectlevel0>li>a{font-style:italic}
    159. 

  159. #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
    160. 

  160. #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
    161. 

  161. #toc li{line-height:1.3334;margin-top:.3334em}
    162. 

  162. #toc a{text-decoration:none}
    163. 

  163. #toc a:active{text-decoration:underline}
    164. 

  164. #toctitle{color:#7a2518;font-size:1.2em}
    165. 

  165. @media only screen and (min-width:768px){#toctitle{font-size:1.375em}
    166. 

  166. body.toc2{padding-left:15em;padding-right:0}
    167. 

  167. #toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
    168. 

  168. #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
    169. 

  169. #toc.toc2>ul{font-size:.9em;margin-bottom:0}
    170. 

  170. #toc.toc2 ul ul{margin-left:0;padding-left:1em}
    171. 

  171. #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
    172. 

  172. body.toc2.toc-right{padding-left:0;padding-right:15em}
    173. 

  173. body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}
    174. 

  174. @media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
    175. 

  175. #toc.toc2{width:20em}
    176. 

  176. #toc.toc2 #toctitle{font-size:1.375em}
    177. 

  177. #toc.toc2>ul{font-size:.95em}
    178. 

  178. #toc.toc2 ul ul{padding-left:1.25em}
    179. 

  179. body.toc2.toc-right{padding-left:0;padding-right:20em}}
    180. 

  180. #content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
    181. 

  181. #content #toc>:first-child{margin-top:0}
    182. 

  182. #content #toc>:last-child{margin-bottom:0}
    183. 

  183. #footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em}
    184. 

  184. #footer-text{color:rgba(255,255,255,.8);line-height:1.44}
    185. 

  185. .sect1{padding-bottom:.625em}
    186. 

  186. @media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}
    187. 

  187. .sect1+.sect1{border-top:1px solid #efefed}
    188. 

  188. #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
    189. 

  189. #content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
    190. 

  190. #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
    191. 

  191. #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
    192. 

  192. #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
    193. 

  193. .audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
    194. 

  194. .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
    195. 

  195. table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0}
    196. 

  196. .paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)}
    197. 

  197. table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit}
    198. 

  198. .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
    199. 

  199. .admonitionblock>table td.icon{text-align:center;width:80px}
    200. 

  200. .admonitionblock>table td.icon img{max-width:none}
    201. 

  201. .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
    202. 

  202. .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)}
    203. 

  203. .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
    204. 

  204. .exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
    205. 

  205. .exampleblock>.content>:first-child{margin-top:0}
    206. 

  206. .exampleblock>.content>:last-child{margin-bottom:0}
    207. 

  207. .sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
    208. 

  208. .sidebarblock>:first-child{margin-top:0}
    209. 

  209. .sidebarblock>:last-child{margin-bottom:0}
    210. 

  210. .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
    211. 

  211. .exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
    212. 

  212. .literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}
    213. 

  213. .sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1}
    214. 

  214. .literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em}
    215. 

  215. .literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal}
    216. 

  216. @media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}
    217. 

  217. @media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}
    218. 

  218. .literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}
    219. 

  219. .listingblock pre.highlightjs{padding:0}
    220. 

  220. .listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
    221. 

  221. .listingblock pre.prettyprint{border-width:0}
    222. 

  222. .listingblock>.content{position:relative}
    223. 

  223. .listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999}
    224. 

  224. .listingblock:hover code[data-lang]:before{display:block}
    225. 

  225. .listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999}
    226. 

  226. .listingblock.terminal pre .command:not([data-prompt]):before{content:"$"}
    227. 

  227. table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
    228. 

  228. table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45}
    229. 

  229. table.pyhltable td.code{padding-left:.75em;padding-right:0}
    230. 

  230. pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}
    231. 

  231. pre.pygments .lineno{display:inline-block;margin-right:.25em}
    232. 

  232. table.pyhltable .linenodiv{background:none!important;padding-right:0!important}
    233. 

  233. .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
    234. 

  234. .quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
    235. 

  235. .quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
    236. 

  236. .quoteblock blockquote{margin:0;padding:0;border:0}
    237. 

  237. .quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
    238. 

  238. .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
    239. 

  239. .quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right}
    240. 

  240. .quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)}
    241. 

  241. .quoteblock .quoteblock blockquote{padding:0 0 0 .75em}
    242. 

  242. .quoteblock .quoteblock blockquote:before{display:none}
    243. 

  243. .verseblock{margin:0 1em 1.25em 1em}
    244. 

  244. .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
    245. 

  245. .verseblock pre strong{font-weight:400}
    246. 

  246. .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
    247. 

  247. .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
    248. 

  248. .quoteblock .attribution br,.verseblock .attribution br{display:none}
    249. 

  249. .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
    250. 

  250. .quoteblock.abstract{margin:0 0 1.25em 0;display:block}
    251. 

  251. .quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0}
    252. 

  252. .quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none}
    253. 

  253. table.tableblock{max-width:100%;border-collapse:separate}
    254. 

  254. table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0}
    255. 

  255. table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
    256. 

  256. table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0}
    257. 

  257. table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0}
    258. 

  258. table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0}
    259. 

  259. table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0}
    260. 

  260. table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0}
    261. 

  261. table.grid-all tbody>tr:last-child>th.tableblock,table.grid-all tbody>tr:last-child>td.tableblock,table.grid-all thead:last-child>tr>th.tableblock,table.grid-rows tbody>tr:last-child>th.tableblock,table.grid-rows tbody>tr:last-child>td.tableblock,table.grid-rows thead:last-child>tr>th.tableblock{border-bottom-width:0}
    262. 

  262. table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0}
    263. 

  263. table.frame-all{border-width:1px}
    264. 

  264. table.frame-sides{border-width:0 1px}
    265. 

  265. table.frame-topbot{border-width:1px 0}
    266. 

  266. th.halign-left,td.halign-left{text-align:left}
    267. 

  267. th.halign-right,td.halign-right{text-align:right}
    268. 

  268. th.halign-center,td.halign-center{text-align:center}
    269. 

  269. th.valign-top,td.valign-top{vertical-align:top}
    270. 

  270. th.valign-bottom,td.valign-bottom{vertical-align:bottom}
    271. 

  271. th.valign-middle,td.valign-middle{vertical-align:middle}
    272. 

  272. table thead th,table tfoot th{font-weight:bold}
    273. 

  273. tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
    274. 

  274. tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
    275. 

  275. p.tableblock>code:only-child{background:none;padding:0}
    276. 

  276. p.tableblock{font-size:1em}
    277. 

  277. td>div.verse{white-space:pre}
    278. 

  278. ol{margin-left:1.75em}
    279. 

  279. ul li ol{margin-left:1.5em}
    280. 

  280. dl dd{margin-left:1.125em}
    281. 

  281. dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
    282. 

  282. ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
    283. 

  283. ul.unstyled,ol.unnumbered,ul.checklist,ul.none{list-style-type:none}
    284. 

  284. ul.unstyled,ol.unnumbered,ul.checklist{margin-left:.625em}
    285. 

  285. ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1em;font-size:.85em}
    286. 

  286. ul.checklist li>p:first-child>input[type="checkbox"]:first-child{width:1em;position:relative;top:1px}
    287. 

  287. ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden}
    288. 

  288. ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block}
    289. 

  289. ul.inline>li>*{display:block}
    290. 

  290. .unstyled dl dt{font-weight:400;font-style:normal}
    291. 

  291. ol.arabic{list-style-type:decimal}
    292. 

  292. ol.decimal{list-style-type:decimal-leading-zero}
    293. 

  293. ol.loweralpha{list-style-type:lower-alpha}
    294. 

  294. ol.upperalpha{list-style-type:upper-alpha}
    295. 

  295. ol.lowerroman{list-style-type:lower-roman}
    296. 

  296. ol.upperroman{list-style-type:upper-roman}
    297. 

  297. ol.lowergreek{list-style-type:lower-greek}
    298. 

  298. .hdlist>table,.colist>table{border:0;background:none}
    299. 

  299. .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
    300. 

  300. td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
    301. 

  301. td.hdlist1{font-weight:bold;padding-bottom:1.25em}
    302. 

  302. .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
    303. 

  303. .colist>table tr>td:first-of-type{padding:0 .75em;line-height:1}
    304. 

  304. .colist>table tr>td:last-of-type{padding:.25em 0}
    305. 

  305. .thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
    306. 

  306. .imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0}
    307. 

  307. .imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em}
    308. 

  308. .imageblock>.title{margin-bottom:0}
    309. 

  309. .imageblock.thumb,.imageblock.th{border-width:6px}
    310. 

  310. .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
    311. 

  311. .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
    312. 

  312. .image.left{margin-right:.625em}
    313. 

  313. .image.right{margin-left:.625em}
    314. 

  314. a.image{text-decoration:none;display:inline-block}
    315. 

  315. a.image object{pointer-events:none}
    316. 

  316. sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
    317. 

  317. sup.footnote a,sup.footnoteref a{text-decoration:none}
    318. 

  318. sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
    319. 

  319. #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
    320. 

  320. #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0}
    321. 

  321. #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;text-indent:-1.05em;margin-bottom:.2em}
    322. 

  322. #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none}
    323. 

  323. #footnotes .footnote:last-of-type{margin-bottom:0}
    324. 

  324. #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
    325. 

  325. .gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
    326. 

  326. .gist .file-data>table td.line-data{width:99%}
    327. 

  327. div.unbreakable{page-break-inside:avoid}
    328. 

  328. .big{font-size:larger}
    329. 

  329. .small{font-size:smaller}
    330. 

  330. .underline{text-decoration:underline}
    331. 

  331. .overline{text-decoration:overline}
    332. 

  332. .line-through{text-decoration:line-through}
    333. 

  333. .aqua{color:#00bfbf}
    334. 

  334. .aqua-background{background-color:#00fafa}
    335. 

  335. .black{color:#000}
    336. 

  336. .black-background{background-color:#000}
    337. 

  337. .blue{color:#0000bf}
    338. 

  338. .blue-background{background-color:#0000fa}
    339. 

  339. .fuchsia{color:#bf00bf}
    340. 

  340. .fuchsia-background{background-color:#fa00fa}
    341. 

  341. .gray{color:#606060}
    342. 

  342. .gray-background{background-color:#7d7d7d}
    343. 

  343. .green{color:#006000}
    344. 

  344. .green-background{background-color:#007d00}
    345. 

  345. .lime{color:#00bf00}
    346. 

  346. .lime-background{background-color:#00fa00}
    347. 

  347. .maroon{color:#600000}
    348. 

  348. .maroon-background{background-color:#7d0000}
    349. 

  349. .navy{color:#000060}
    350. 

  350. .navy-background{background-color:#00007d}
    351. 

  351. .olive{color:#606000}
    352. 

  352. .olive-background{background-color:#7d7d00}
    353. 

  353. .purple{color:#600060}
    354. 

  354. .purple-background{background-color:#7d007d}
    355. 

  355. .red{color:#bf0000}
    356. 

  356. .red-background{background-color:#fa0000}
    357. 

  357. .silver{color:#909090}
    358. 

  358. .silver-background{background-color:#bcbcbc}
    359. 

  359. .teal{color:#006060}
    360. 

  360. .teal-background{background-color:#007d7d}
    361. 

  361. .white{color:#bfbfbf}
    362. 

  362. .white-background{background-color:#fafafa}
    363. 

  363. .yellow{color:#bfbf00}
    364. 

  364. .yellow-background{background-color:#fafa00}
    365. 

  365. span.icon>.fa{cursor:default}
    366. 

  366. .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
    367. 

  367. .admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c}
    368. 

  368. .admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
    369. 

  369. .admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900}
    370. 

  370. .admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400}
    371. 

  371. .admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000}
    372. 

  372. .conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
    373. 

  373. .conum[data-value] *{color:#fff!important}
    374. 

  374. .conum[data-value]+b{display:none}
    375. 

  375. .conum[data-value]:after{content:attr(data-value)}
    376. 

  376. pre .conum[data-value]{position:relative;top:-.125em}
    377. 

  377. b.conum *{color:inherit!important}
    378. 

  378. .conum:not([data-value]):empty{display:none}
    379. 

  379. dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
    380. 

  380. h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
    381. 

  381. p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
    382. 

  382. p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
    383. 

  383. p{margin-bottom:1.25rem}
    384. 

  384. .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
    385. 

  385. .exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
    386. 

  386. .print-only{display:none!important}
    387. 

  387. @media print{@page{margin:1.25cm .75cm}
    388. 

  388. *{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
    389. 

  389. a{color:inherit!important;text-decoration:underline!important}
    390. 

  390. a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
    391. 

  391. a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
    392. 

  392. abbr[title]:after{content:" (" attr(title) ")"}
    393. 

  393. pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
    394. 

  394. thead{display:table-header-group}
    395. 

  395. svg{max-width:100%}
    396. 

  396. p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
    397. 

  397. h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
    398. 

  398. #toc,.sidebarblock,.exampleblock>.content{background:none!important}
    399. 

  399. #toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important}
    400. 

  400. .sect1{padding-bottom:0!important}
    401. 

  401. .sect1+.sect1{border:0!important}
    402. 

  402. #header>h1:first-child{margin-top:1.25rem}
    403. 

  403. body.book #header{text-align:center}
    404. 

  404. body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0}
    405. 

  405. body.book #header .details{border:0!important;display:block;padding:0!important}
    406. 

  406. body.book #header .details span:first-child{margin-left:0!important}
    407. 

  407. body.book #header .details br{display:block}
    408. 

  408. body.book #header .details br+span:before{content:none!important}
    409. 

  409. body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
    410. 

  410. body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
    411. 

  411. .listingblock code[data-lang]:before{display:block}
    412. 

  412. #footer{background:none!important;padding:0 .9375em}
    413. 

  413. #footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em}
    414. 

  414. .hide-on-print{display:none!important}
    415. 

  415. .print-only{display:block!important}
    416. 

  416. .hide-for-print{display:none!important}
    417. 

  417. .show-for-print{display:inherit!important}}
    418. 

  418. </style>
    419. 

  419. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.5.0/css/font-awesome.min.css">
    420. 

  420. <style>
    421. 

  421. /* Stylesheet for CodeRay to match GitHub theme | MIT License | http://foundation.zurb.com */
    422. 

  422. /*pre.CodeRay {background-color:#f7f7f8;}*/
    423. 

  423. .CodeRay .line-numbers{border-right:1px solid #d8d8d8;padding:0 0.5em 0 .25em}
    424. 

  424. .CodeRay span.line-numbers{display:inline-block;margin-right:.5em;color:rgba(0,0,0,.3)}
    425. 

  425. .CodeRay .line-numbers strong{color:rgba(0,0,0,.4)}
    426. 

  426. table.CodeRay{border-collapse:separate;border-spacing:0;margin-bottom:0;border:0;background:none}
    427. 

  427. table.CodeRay td{vertical-align: top;line-height:1.45}
    428. 

  428. table.CodeRay td.line-numbers{text-align:right}
    429. 

  429. table.CodeRay td.line-numbers>pre{padding:0;color:rgba(0,0,0,.3)}
    430. 

  430. table.CodeRay td.code{padding:0 0 0 .5em}
    431. 

  431. table.CodeRay td.code>pre{padding:0}
    432. 

  432. .CodeRay .debug{color:#fff !important;background:#000080 !important}
    433. 

  433. .CodeRay .annotation{color:#007}
    434. 

  434. .CodeRay .attribute-name{color:#000080}
    435. 

  435. .CodeRay .attribute-value{color:#700}
    436. 

  436. .CodeRay .binary{color:#509}
    437. 

  437. .CodeRay .comment{color:#998;font-style:italic}
    438. 

  438. .CodeRay .char{color:#04d}
    439. 

  439. .CodeRay .char .content{color:#04d}
    440. 

  440. .CodeRay .char .delimiter{color:#039}
    441. 

  441. .CodeRay .class{color:#458;font-weight:bold}
    442. 

  442. .CodeRay .complex{color:#a08}
    443. 

  443. .CodeRay .constant,.CodeRay .predefined-constant{color:#008080}
    444. 

  444. .CodeRay .color{color:#099}
    445. 

  445. .CodeRay .class-variable{color:#369}
    446. 

  446. .CodeRay .decorator{color:#b0b}
    447. 

  447. .CodeRay .definition{color:#099}
    448. 

  448. .CodeRay .delimiter{color:#000}
    449. 

  449. .CodeRay .doc{color:#970}
    450. 

  450. .CodeRay .doctype{color:#34b}
    451. 

  451. .CodeRay .doc-string{color:#d42}
    452. 

  452. .CodeRay .escape{color:#666}
    453. 

  453. .CodeRay .entity{color:#800}
    454. 

  454. .CodeRay .error{color:#808}
    455. 

  455. .CodeRay .exception{color:inherit}
    456. 

  456. .CodeRay .filename{color:#099}
    457. 

  457. .CodeRay .function{color:#900;font-weight:bold}
    458. 

  458. .CodeRay .global-variable{color:#008080}
    459. 

  459. .CodeRay .hex{color:#058}
    460. 

  460. .CodeRay .integer,.CodeRay .float{color:#099}
    461. 

  461. .CodeRay .include{color:#555}
    462. 

  462. .CodeRay .inline{color:#000}
    463. 

  463. .CodeRay .inline .inline{background:#ccc}
    464. 

  464. .CodeRay .inline .inline .inline{background:#bbb}
    465. 

  465. .CodeRay .inline .inline-delimiter{color:#d14}
    466. 

  466. .CodeRay .inline-delimiter{color:#d14}
    467. 

  467. .CodeRay .important{color:#555;font-weight:bold}
    468. 

  468. .CodeRay .interpreted{color:#b2b}
    469. 

  469. .CodeRay .instance-variable{color:#008080}
    470. 

  470. .CodeRay .label{color:#970}
    471. 

  471. .CodeRay .local-variable{color:#963}
    472. 

  472. .CodeRay .octal{color:#40e}
    473. 

  473. .CodeRay .predefined{color:#369}
    474. 

  474. .CodeRay .preprocessor{color:#579}
    475. 

  475. .CodeRay .pseudo-class{color:#555}
    476. 

  476. .CodeRay .directive{font-weight:bold}
    477. 

  477. .CodeRay .type{font-weight:bold}
    478. 

  478. .CodeRay .predefined-type{color:inherit}
    479. 

  479. .CodeRay .reserved,.CodeRay .keyword {color:#000;font-weight:bold}
    480. 

  480. .CodeRay .key{color:#808}
    481. 

  481. .CodeRay .key .delimiter{color:#606}
    482. 

  482. .CodeRay .key .char{color:#80f}
    483. 

  483. .CodeRay .value{color:#088}
    484. 

  484. .CodeRay .regexp .delimiter{color:#808}
    485. 

  485. .CodeRay .regexp .content{color:#808}
    486. 

  486. .CodeRay .regexp .modifier{color:#808}
    487. 

  487. .CodeRay .regexp .char{color:#d14}
    488. 

  488. .CodeRay .regexp .function{color:#404;font-weight:bold}
    489. 

  489. .CodeRay .string{color:#d20}
    490. 

  490. .CodeRay .string .string .string{background:#ffd0d0}
    491. 

  491. .CodeRay .string .content{color:#d14}
    492. 

  492. .CodeRay .string .char{color:#d14}
    493. 

  493. .CodeRay .string .delimiter{color:#d14}
    494. 

  494. .CodeRay .shell{color:#d14}
    495. 

  495. .CodeRay .shell .delimiter{color:#d14}
    496. 

  496. .CodeRay .symbol{color:#990073}
    497. 

  497. .CodeRay .symbol .content{color:#a60}
    498. 

  498. .CodeRay .symbol .delimiter{color:#630}
    499. 

  499. .CodeRay .tag{color:#008080}
    500. 

  500. .CodeRay .tag-special{color:#d70}
    501. 

  501. .CodeRay .variable{color:#036}
    502. 

  502. .CodeRay .insert{background:#afa}
    503. 

  503. .CodeRay .delete{background:#faa}
    504. 

  504. .CodeRay .change{color:#aaf;background:#007}
    505. 

  505. .CodeRay .head{color:#f8f;background:#505}
    506. 

  506. .CodeRay .insert .insert{color:#080}
    507. 

  507. .CodeRay .delete .delete{color:#800}
    508. 

  508. .CodeRay .change .change{color:#66f}
    509. 

  509. .CodeRay .head .head{color:#f4f}
    510. 

  510. </style>
    511. 

  511. </head>
    512. 

  512. <body class="article toc2 toc-left">
    513. 

  513. <div id="header">
    514. 

  514. <h1>Application States</h1>
    515. 

  515. <div class="details">
    516. 

  516. <span id="author" class="author"></span><br>
    517. 

  517. <span id="revnumber">version ,</span>
    518. 

  518. <span id="revdate">2016/03/17 20:48</span>
    519. 

  519. </div>
    520. 

  520. <div id="toc" class="toc2">
    521. 

  521. <div id="toctitle">Table of Contents</div>
    522. 

  522. <ul class="sectlevel1">
    523. 

  523. <li><a href="#overview">Overview</a>
    524. 

  524. <ul class="sectlevel2">
    525. 

  525. <li><a href="#use-case-examples">Use Case Examples</a></li>
    526. 

  526. <li><a href="#supported-features">Supported Features</a></li>
    527. 

  527. <li><a href="#usage">Usage</a></li>
    528. 

  528. <li><a href="#code-samples">Code Samples</a></li>
    529. 

  529. </ul>
    530. 

  530. </li>
    531. 

  531. <li><a href="#appstate">AppState</a></li>
    532. 

  532. <li><a href="#abstractappstate">AbstractAppState</a></li>
    533. 

  533. <li><a href="#pausing-and-unpausing">Pausing and Unpausing</a></li>
    534. 

  534. <li><a href="#appstatemanager">AppStateManager</a></li>
    535. 

  535. <li><a href="#best-practices">Best Practices</a>
    536. 

  536. <ul class="sectlevel2">
    537. 

  537. <li><a href="#communication-among-appstates">Communication Among AppStates</a></li>
    538. 

  538. <li><a href="#initialize-familiar-class-fields">Initialize Familiar Class Fields</a></li>
    539. 

  539. </ul>
    540. 

  540. </li>
    541. 

  541. </ul>
    542. 

  542. </div>
    543. 

  543. </div>
    544. 

  544. <div id="content">
    545. 

  545. <div id="preamble">
    546. 

  546. <div class="sectionbody">
    547. 

  547. <div class="paragraph">
    548. 

  548. <p>The <code>com.jme3.app.state.AppState</code> class is a customizable jME3 interface that allows you to control the global game logic, the overall game mechanics. (To control the behaviour of a Spatial, see <a href="../../jme3/advanced/custom_controls.html">Custom Controls</a> instead. Controls and AppStates can be used together.)</p>
    549. 

  549. </div>
    550. 

  550. </div>
    551. 

  551. </div>
    552. 

  552. <div class="sect1">
    553. 

  553. <h2 id="overview">Overview</h2>
    554. 

  554. <div class="sectionbody">
    555. 

  555. <div class="sect2">
    556. 

  556. <h3 id="use-case-examples">Use Case Examples</h3>
    557. 

  557. <div class="paragraph">
    558. 

  558. <p>There are situations during your game development where you think:</p>
    559. 

  559. </div>
    560. 

  560. <div class="ulist">
    561. 

  561. <ul>
    562. 

  562. <li>
    563. 

  563. <p>Mouse and key inputs are handled differently in-game versus in the main menu. Can I group a set of input handler settings, and activate and deactivate them all in one step?</p>
    564. 

  564. </li>
    565. 

  565. <li>
    566. 

  566. <p>I have the in-game scene, and a character editor, and a Captain&#8217;s Quarters screen. Can I group a set of nodes and behaviours, and swap them in and out in one step?</p>
    567. 

  567. </li>
    568. 

  568. <li>
    569. 

  569. <p>When I pause the game, I want the character&#8217;s “idle animation to continue, but all other loops and game events should stop. How do I define what happens when the game is paused/unpaused?</p>
    570. 

  570. </li>
    571. 

  571. <li>
    572. 

  572. <p>I have a conditional block that takes up a lot of space in my simpleUpdate() loop. Can I wrap up this block of code, and switch it on and off in one step?</p>
    573. 

  573. </li>
    574. 

  574. <li>
    575. 

  575. <p>Can I package everything that belongs in-game, and everything that belongs to the menu screen, and switch between these two “big states in one step?</p>
    576. 

  576. </li>
    577. 

  577. </ul>
    578. 

  578. </div>
    579. 

  579. <div class="paragraph">
    580. 

  580. <p>You can! This is what AppStates are there for. An AppState class is subset of (or an extension to) your application. Every AppState class has access to all fields in your main application (AssetManager, ViewPort, StateManager, InputManager, RootNode, GuiNode, etc) and hooks into the main update loop. An AppState can contain:</p>
    581. 

  581. </div>
    582. 

  582. <div class="ulist">
    583. 

  583. <ul>
    584. 

  584. <li>
    585. 

  585. <p>a subset of class fields, functions, methods (game state data and accessors),</p>
    586. 

  586. </li>
    587. 

  587. <li>
    588. 

  588. <p>a subset of <abbr title="Graphical User Interface">GUI</abbr> elements and their listeners,</p>
    589. 

  589. </li>
    590. 

  590. <li>
    591. 

  591. <p>a subset of input handlers and mappings,</p>
    592. 

  592. </li>
    593. 

  593. <li>
    594. 

  594. <p>a subset of nodes that you load and attach to the rootNode,</p>
    595. 

  595. </li>
    596. 

  596. <li>
    597. 

  597. <p>a subset of conditional actions that you branch to in the simpleUpdate() loop,</p>
    598. 

  598. </li>
    599. 

  599. <li>
    600. 

  600. <p>a subset of other AppStates and Controls</p>
    601. 

  601. </li>
    602. 

  602. <li>
    603. 

  603. <p>… or combinations thereof.</p>
    604. 

  604. </li>
    605. 

  605. </ul>
    606. 

  606. </div>
    607. 

  607. </div>
    608. 

  608. <div class="sect2">
    609. 

  609. <h3 id="supported-features">Supported Features</h3>
    610. 

  610. <div class="paragraph">
    611. 

  611. <p>Each AppState lets you define what happens to it in the following situations:</p>
    612. 

  612. </div>
    613. 

  613. <div class="ulist">
    614. 

  614. <ul>
    615. 

  615. <li>
    616. 

  616. <p><strong>The AppState is initialized:</strong> You load and initialize game data, InputHandlers, AppStates and Controls and attach nodes.<br>
    617. 

  617. The AppState executes its own simpleInitApp() method when it is attached, so to speak.</p>
    618. 

  618. </li>
    619. 

  619. <li>
    620. 

  620. <p><strong>The AppState has been enabled (unpaused):</strong> This toggles a boolean isEnabled() to true. Here you attach nodes and listeners that should become active while it&#8217;s running.</p>
    621. 

  621. </li>
    622. 

  622. <li>
    623. 

  623. <p><strong>While the AppState is running/paused:</strong> You can poll isEnabled() to define paused and unpaused game behaviour in the update() loop. In update(), you poll and modify the game state, modify the scene graph, and trigger events. Test if <code>!isEnabled()</code>, and write code that skips the running sections of this AppState&#8217;s <code>update()</code> loop.<br>
    624. 

  624. Each AppState has its own update loop, which hooks into the main simpleUpdate() loop (callback).</p>
    625. 

  625. </li>
    626. 

  626. <li>
    627. 

  627. <p><strong>The AppState has been disabled (paused):</strong> This toggles a boolean isEnabled() to false. Here you switch all objects to their specific “paused behaviour.</p>
    628. 

  628. </li>
    629. 

  629. <li>
    630. 

  630. <p><strong>The AppState is cleaned up:</strong> Here you decide what happens when the AppState is detached. Save this AppState&#8217;s game state, unregister Controls and InputHandlers, detach related AppStates, detach nodes from the rootNode, etc.</p>
    631. 

  631. </li>
    632. 

  632. </ul>
    633. 

  633. </div>
    634. 

  634. <div class="paragraph">
    635. 

  635. <p><abbr title="Graphical User Interface">GUI</abbr><abbr title="Graphical User Interface">GUI</abbr></p>
    636. 

  636. </div>
    637. 

  637. </div>
    638. 

  638. <div class="sect2">
    639. 

  639. <h3 id="usage">Usage</h3>
    640. 

  640. <div class="paragraph">
    641. 

  641. <p>To implement game logic:</p>
    642. 

  642. </div>
    643. 

  643. <div class="olist arabic">
    644. 

  644. <ol class="arabic">
    645. 

  645. <li>
    646. 

  646. <p>Create one AbstractAppState instance for each set of game mechanics.</p>
    647. 

  647. </li>
    648. 

  648. <li>
    649. 

  649. <p>Implement game behaviour in the AppState&#8217;s update() method.</p>
    650. 

  650. <div class="ulist">
    651. 

  651. <ul>
    652. 

  652. <li>
    653. 

  653. <p>You can pass custom data as arguments in the constructor.</p>
    654. 

  654. </li>
    655. 

  655. <li>
    656. 

  656. <p>The AppState has access to everything inside the app&#8217;s scope via the Application <code>app</code> object.</p>
    657. 

  657. </li>
    658. 

  658. </ul>
    659. 

  659. </div>
    660. 

  660. </li>
    661. 

  661. <li>
    662. 

  662. <p>Create and attach the AppState to the AppStateManager (<code>stateManager.attach(myAppState);</code>) and initialize it.</p>
    663. 

  663. </li>
    664. 

  664. <li>
    665. 

  665. <p>Enable and disable (unpause and pause) the AppStates that you need during the game.</p>
    666. 

  666. </li>
    667. 

  667. <li>
    668. 

  668. <p>Detach the AppState from the AppStateManager (<code>stateManager.detach(myAppState);</code>) and clean it up.</p>
    669. 

  669. </li>
    670. 

  670. </ol>
    671. 

  671. </div>
    672. 

  672. <div class="paragraph">
    673. 

  673. <p>When you add several AppStates to one Application and activate them, their initialize() methods and update() loops are executed in the order in which the AppStates were added to the AppStateManager.</p>
    674. 

  674. </div>
    675. 

  675. </div>
    676. 

  676. <div class="sect2">
    677. 

  677. <h3 id="code-samples">Code Samples</h3>
    678. 

  678. <div class="paragraph">
    679. 

  679. <p>JME3 comes with a BulletAppState that implements Physical behaviour (using the jBullet library). You, for example, could write an Artificial Intelligence AppState to control all your enemy units. Existing examples in the code base include:</p>
    680. 

  680. </div>
    681. 

  681. <div class="ulist">
    682. 

  682. <ul>
    683. 

  683. <li>
    684. 

  684. <p><a href="https://github.com/jMonkeyEngine/jmonkeyengine/blob/master/jme3-bullet/src/common/java/com/jme3/bullet/BulletAppState.java">BulletAppState</a> controls physical behaviour in PhysicsControl&#8217;ed Spatials.</p>
    685. 

  685. </li>
    686. 

  686. <li>
    687. 

  687. <p><a href="https://github.com/jMonkeyEngine/jmonkeyengine/blob/master/jme3-examples/src/main/java/jme3test/app/state/TestAppStates.java">TestAppStates.java</a> an example of a custom AppState</p>
    688. 

  688. <div class="ulist">
    689. 

  689. <ul>
    690. 

  690. <li>
    691. 

  691. <p><a href="https://github.com/jMonkeyEngine/jmonkeyengine/blob/master/jme3-examples/src/main/java/jme3test/app/state/RootNodeState.java">RootNodeState.java</a></p>
    692. 

  692. </li>
    693. 

  693. </ul>
    694. 

  694. </div>
    695. 

  695. </li>
    696. 

  696. </ul>
    697. 

  697. </div>
    698. 

  698. </div>
    699. 

  699. </div>
    700. 

  700. </div>
    701. 

  701. <div class="sect1">
    702. 

  702. <h2 id="appstate">AppState</h2>
    703. 

  703. <div class="sectionbody">
    704. 

  704. <div class="paragraph">
    705. 

  705. <p>The AppState interface lets you initialize sets of objects, and hook a set of continuously executing code into the main loop.</p>
    706. 

  706. </div>
    707. 

  707. <table class="tableblock frame-all grid-all spread">
    708. 

  708. <colgroup>
    709. 

  709. <col style="width: 50%;">
    710. 

  710. <col style="width: 50%;">
    711. 

  711. </colgroup>
    712. 

  712. <thead>
    713. 

  713. <tr>
    714. 

  714. <th class="tableblock halign-left valign-top">AppState Method</th>
    715. 

  715. <th class="tableblock halign-left valign-top">Usage</th>
    716. 

  716. </tr>
    717. 

  717. </thead>
    718. 

  718. <tbody>
    719. 

  719. <tr>
    720. 

  720. <td class="tableblock halign-left valign-top"><div><div class="paragraph">
    721. 

  721. <p>initialize(asm,app)</p>
    722. 

  722. </div></div></td>
    723. 

  723. <td class="tableblock halign-left valign-top"><div><div class="paragraph">
    724. 

  724. <p>When this AppState is added to the game, the RenderThread initializes the AppState and then calls this method. You can modify the scene graph from here (e.g. attach nodes). To get access to the main app, call:</p>
    725. 

  725. </div>
    726. 

  726. <div class="listingblock">
    727. 

  727. <div class="content">
    728. 

  728. <pre class="CodeRay highlight"><code data-lang="java"><span class="local-variable">super</span>.initialize(stateManager, app);
    729. 

  729. <span class="local-variable">this</span>.app = (SimpleApplication) app;</code></pre>
    730. 

  730. </div>
    731. 

  731. </div></div></td>
    732. 

  732. </tr>
    733. 

  733. <tr>
    734. 

  734. <td class="tableblock halign-left valign-top"><div><div class="paragraph">
    735. 

  735. <p>cleanup()</p>
    736. 

  736. </div></div></td>
    737. 

  737. <td class="tableblock halign-left valign-top"><div><div class="paragraph">
    738. 

  738. <p>This method is executed after you remove the AppState from the game. Here you implement clean-up code for when this state is detached. You can modify the scene graph from here (e.g. detach nodes).</p>
    739. 

  739. </div></div></td>
    740. 

  740. </tr>
    741. 

  741. <tr>
    742. 

  742. <td class="tableblock halign-left valign-top"><div><div class="paragraph">
    743. 

  743. <p>update(float tpf)</p>
    744. 

  744. </div></div></td>
    745. 

  745. <td class="tableblock halign-left valign-top"><div><div class="paragraph">
    746. 

  746. <p>Here you implement the behaviour that you want to hook into the simpleUpdate() loop while this state is attached to the game. You can modify the scene graph from here.</p>
    747. 

  747. </div></div></td>
    748. 

  748. </tr>
    749. 

  749. <tr>
    750. 

  750. <td class="tableblock halign-left valign-top"><div><div class="paragraph">
    751. 

  751. <p>isInitialized()</p>
    752. 

  752. </div></div></td>
    753. 

  753. <td class="tableblock halign-left valign-top"><div><div class="paragraph">
    754. 

  754. <p>Your implementations of this interface should return the correct respective boolean value. (See AbstractAppState)</p>
    755. 

  755. </div></div></td>
    756. 

  756. </tr>
    757. 

  757. <tr>
    758. 

  758. <td class="tableblock halign-left valign-top"><div><div class="paragraph">
    759. 

  759. <p>setEnabled(true)<br>
    760. 

  760. setEnabled(false)</p>
    761. 

  761. </div></div></td>
    762. 

  762. <td class="tableblock halign-left valign-top"><div><div class="paragraph">
    763. 

  763. <p>Temporarily enables or disables an AppState. (See AbstractAppState)</p>
    764. 

  764. </div></div></td>
    765. 

  765. </tr>
    766. 

  766. <tr>
    767. 

  767. <td class="tableblock halign-left valign-top"><div><div class="paragraph">
    768. 

  768. <p>isEnabled()</p>
    769. 

  769. </div></div></td>
    770. 

  770. <td class="tableblock halign-left valign-top"><div><div class="paragraph">
    771. 

  771. <p>Test whether AppState is enabled or disabled. Your implementation should consider the boolean. (See AbstractAppState)</p>
    772. 

  772. </div></div></td>
    773. 

  773. </tr>
    774. 

  774. <tr>
    775. 

  775. <td class="tableblock halign-left valign-top"><div><div class="paragraph">
    776. 

  776. <p>stateAttached(asm)<br>
    777. 

  777. stateDetached(asm)</p>
    778. 

  778. </div></div></td>
    779. 

  779. <td class="tableblock halign-left valign-top"><div><div class="paragraph">
    780. 

  780. <p>The AppState knows when it is attached to, or detached from, the AppStateManager, and triggers these two methods. Don&#8217;t modify the scene graph from here! (Typically not used.)</p>
    781. 

  781. </div></div></td>
    782. 

  782. </tr>
    783. 

  783. <tr>
    784. 

  784. <td class="tableblock halign-left valign-top"><div><div class="paragraph">
    785. 

  785. <p>render(RenderManager rm)</p>
    786. 

  786. </div></div></td>
    787. 

  787. <td class="tableblock halign-left valign-top"><div><div class="paragraph">
    788. 

  788. <p>Renders the state, plus your optional customizations. (Typically not used.)</p>
    789. 

  789. </div></div></td>
    790. 

  790. </tr>
    791. 

  791. <tr>
    792. 

  792. <td class="tableblock halign-left valign-top"><div><div class="paragraph">
    793. 

  793. <p>postRender()</p>
    794. 

  794. </div></div></td>
    795. 

  795. <td class="tableblock halign-left valign-top"><div><div class="paragraph">
    796. 

  796. <p>Called after all rendering commands are flushed, including your optional customizations. (Typically not used.)</p>
    797. 

  797. </div></div></td>
    798. 

  798. </tr>
    799. 

  799. </tbody>
    800. 

  800. </table>
    801. 

  801. </div>
    802. 

  802. </div>
    803. 

  803. <div class="sect1">
    804. 

  804. <h2 id="abstractappstate">AbstractAppState</h2>
    805. 

  805. <div class="sectionbody">
    806. 

  806. <div class="paragraph">
    807. 

  807. <p>The <a href="https://github.com/jMonkeyEngine/jmonkeyengine/blob/master/jme3-core/src/main/java/com/jme3/app/state/AbstractAppState.java">AbstractAppState</a> class already implements some common methods (<code>isInitialized(), setEnabled(), isEnabled()</code>) and makes creation of custom AppStates a bit easier. We recommend you extend AbstractAppState and override the remaining AppState methods: <code>initialize(), setEnabled(), cleanup()</code>.</p>
    808. 

  808. </div>
    809. 

  809. <div class="paragraph">
    810. 

  810. <p>Definition:</p>
    811. 

  811. </div>
    812. 

  812. <div class="listingblock">
    813. 

  813. <div class="content">
    814. 

  814. <pre class="CodeRay highlight"><code data-lang="java"><span class="directive">public</span> <span class="type">class</span> <span class="class">MyAppState</span> <span class="directive">extends</span> AbstractAppState {
    815. 

  815. 

  816.     <span class="directive">private</span> SimpleApplication app;
    817. 

  817. 

  818.     <span class="directive">private</span> Node x = <span class="keyword">new</span> Node(<span class="string"><span class="delimiter">&quot;</span><span class="content">x</span><span class="delimiter">&quot;</span></span>);  <span class="comment">// some custom class fields...</span>
    819. 

  819.     <span class="directive">public</span> Node getX(){ <span class="keyword">return</span> x; }  <span class="comment">// some custom methods...</span>
    820. 

  820. 

  821.     <span class="annotation">@Override</span>
    822. 

  822.     <span class="directive">public</span> <span class="type">void</span> initialize(AppStateManager stateManager, Application app) {
    823. 

  823.       <span class="local-variable">super</span>.initialize(stateManager, app);
    824. 

  824.       <span class="local-variable">this</span>.app = (SimpleApplication)app;          <span class="comment">// cast to a more specific class</span>
    825. 

  825. 

  826.       <span class="comment">// init stuff that is independent of whether state is PAUSED or RUNNING</span>
    827. 

  827.       <span class="local-variable">this</span>.app.getRootNode().attachChild(getX()); <span class="comment">// modify scene graph...</span>
    828. 

  828.       <span class="local-variable">this</span>.app.doSomething();                     <span class="comment">// call custom methods...</span>
    829. 

  829.    }
    830. 

  830. 

  831.    <span class="annotation">@Override</span>
    832. 

  832.     <span class="directive">public</span> <span class="type">void</span> cleanup() {
    833. 

  833.       <span class="local-variable">super</span>.cleanup();
    834. 

  834.       <span class="comment">// unregister all my listeners, detach all my nodes, etc...</span>
    835. 

  835.       <span class="local-variable">this</span>.app.getRootNode().detachChild(getX()); <span class="comment">// modify scene graph...</span>
    836. 

  836.       <span class="local-variable">this</span>.app.doSomethingElse();                 <span class="comment">// call custom methods...</span>
    837. 

  837.     }
    838. 

  838. 

  839.     <span class="annotation">@Override</span>
    840. 

  840.     <span class="directive">public</span> <span class="type">void</span> setEnabled(<span class="type">boolean</span> enabled) {
    841. 

  841.       <span class="comment">// Pause and unpause</span>
    842. 

  842.       <span class="local-variable">super</span>.setEnabled(enabled);
    843. 

  843.       <span class="keyword">if</span>(enabled){
    844. 

  844.         <span class="comment">// init stuff that is in use while this state is RUNNING</span>
    845. 

  845.         <span class="local-variable">this</span>.app.getRootNode().attachChild(getX()); <span class="comment">// modify scene graph...</span>
    846. 

  846.         <span class="local-variable">this</span>.app.doSomethingElse();                 <span class="comment">// call custom methods...</span>
    847. 

  847.       } <span class="keyword">else</span> {
    848. 

  848.         <span class="comment">// take away everything not needed while this state is PAUSED</span>
    849. 

  849.         ...
    850. 

  850.       }
    851. 

  851.     }
    852. 

  852. 

  853.     <span class="comment">// Note that update is only called while the state is both attached and enabled.</span>
    854. 

  854.     <span class="annotation">@Override</span>
    855. 

  855.     <span class="directive">public</span> <span class="type">void</span> update(<span class="type">float</span> tpf) {
    856. 

  856.       <span class="comment">// do the following while game is RUNNING</span>
    857. 

  857.       <span class="local-variable">this</span>.app.getRootNode().getChild(<span class="string"><span class="delimiter">&quot;</span><span class="content">blah</span><span class="delimiter">&quot;</span></span>).scale(tpf); <span class="comment">// modify scene graph...</span>
    858. 

  858.       x.setUserData(...);                                 <span class="comment">// call some methods...</span>
    859. 

  859.     }
    860. 

  860. 

  861. }</code></pre>
    862. 

  862. </div>
    863. 

  863. </div>
    864. 

  864. </div>
    865. 

  865. </div>
    866. 

  866. <div class="sect1">
    867. 

  867. <h2 id="pausing-and-unpausing">Pausing and Unpausing</h2>
    868. 

  868. <div class="sectionbody">
    869. 

  869. <div class="paragraph">
    870. 

  870. <p>You define what an AppState does when Paused or Unpaused, in the <code>setEnabled()</code> and <code>update()</code> methods. Call <code>myState.setEnabled(false)</code> on all states that you want to pause. Call <code>myState.setEnabled(true)</code> on all states that you want to unpause.</p>
    871. 

  871. </div>
    872. 

  872. </div>
    873. 

  873. </div>
    874. 

  874. <div class="sect1">
    875. 

  875. <h2 id="appstatemanager">AppStateManager</h2>
    876. 

  876. <div class="sectionbody">
    877. 

  877. <div class="paragraph">
    878. 

  878. <p>The com.jme3.app.state.AppStateManager holds the list of AppStates for an application. AppStateManager ensures that active AppStates can modify the scene graph, and that the update() loops of active AppStates is executed. There is one AppStateManager per application. You typically attach several AppStates to one AppStateManager, but the same state can only be attached once.</p>
    879. 

  879. </div>
    880. 

  880. <table class="tableblock frame-all grid-all spread">
    881. 

  881. <colgroup>
    882. 

  882. <col style="width: 50%;">
    883. 

  883. <col style="width: 50%;">
    884. 

  884. </colgroup>
    885. 

  885. <thead>
    886. 

  886. <tr>
    887. 

  887. <th class="tableblock halign-left valign-top">AppStateManager Method</th>
    888. 

  888. <th class="tableblock halign-left valign-top">Usage</th>
    889. 

  889. </tr>
    890. 

  890. </thead>
    891. 

  891. <tbody>
    892. 

  892. <tr>
    893. 

  893. <td class="tableblock halign-left valign-top"><div><div class="paragraph">
    894. 

  894. <p>hasState(myState)</p>
    895. 

  895. </div></div></td>
    896. 

  896. <td class="tableblock halign-left valign-top"><div><div class="paragraph">
    897. 

  897. <p>Is AppState object 'myState' attached?</p>
    898. 

  898. </div></div></td>
    899. 

  899. </tr>
    900. 

  900. <tr>
    901. 

  901. <td class="tableblock halign-left valign-top"><div><div class="paragraph">
    902. 

  902. <p>getState(MyAppState.class)</p>
    903. 

  903. </div></div></td>
    904. 

  904. <td class="tableblock halign-left valign-top"><div><div class="paragraph">
    905. 

  905. <p>Returns the first attached state that is an instance of a subclass of <code>MyAppState.class</code>.</p>
    906. 

  906. </div></div></td>
    907. 

  907. </tr>
    908. 

  908. </tbody>
    909. 

  909. </table>
    910. 

  910. <div class="paragraph">
    911. 

  911. <p>The AppStateManager&#8217;s <code>render(), postRender(), cleanup()</code> methods are internal, ignore them, users never call them directly.</p>
    912. 

  912. </div>
    913. 

  913. <div class="ulist">
    914. 

  914. <ul>
    915. 

  915. <li>
    916. 

  916. <p>If a detached AppState is attached then initialize() will be called on the following render pass.</p>
    917. 

  917. </li>
    918. 

  918. <li>
    919. 

  919. <p>If an attached AppState is detached then cleanup() will be called on the following render pass.</p>
    920. 

  920. </li>
    921. 

  921. <li>
    922. 

  922. <p>If you attach an already-attached AppState then the second attach is a no-op and will return false.</p>
    923. 

  923. </li>
    924. 

  924. <li>
    925. 

  925. <p>If you both attach and detach an AppState within one frame then neither initialize() or cleanup() will be called, although if either is called both will be.</p>
    926. 

  926. </li>
    927. 

  927. <li>
    928. 

  928. <p>If you both detach and then re-attach an AppState within one frame then on the next update pass its cleanup() and initialize() methods will be called in that order.</p>
    929. 

  929. </li>
    930. 

  930. </ul>
    931. 

  931. </div>
    932. 

  932. </div>
    933. 

  933. </div>
    934. 

  934. <div class="sect1">
    935. 

  935. <h2 id="best-practices">Best Practices</h2>
    936. 

  936. <div class="sectionbody">
    937. 

  937. <div class="sect2">
    938. 

  938. <h3 id="communication-among-appstates">Communication Among AppStates</h3>
    939. 

  939. <div class="paragraph">
    940. 

  940. <p>You can only access other AppStates (read from and write to them) from certain places: From a Control&#8217;s update() method, from an AppState&#8217;s update() method, and from the SimpleApplication&#8217;s simpleUpdate() loop. Don&#8217;t mess with the AppState from other places, because from other methods you have no control over the order of modifications; the game can go out of sync because you can&#8217;t know when (during which half-finished step of another state change) your modification will be performed.</p>
    941. 

  941. </div>
    942. 

  942. <div class="paragraph">
    943. 

  943. <p>You can use custom accessors to get data from AppStates, to set data in AppStates, or to trigger methods in AppStates.</p>
    944. 

  944. </div>
    945. 

  945. <div class="listingblock">
    946. 

  946. <div class="content">
    947. 

  947. <pre class="CodeRay highlight"><code data-lang="java"><span class="local-variable">this</span>.app.getStateManager().getState(MyAppState.class).doSomeCustomStuffInThisState();</code></pre>
    948. 

  948. </div>
    949. 

  949. </div>
    950. 

  950. </div>
    951. 

  951. <div class="sect2">
    952. 

  952. <h3 id="initialize-familiar-class-fields">Initialize Familiar Class Fields</h3>
    953. 

  953. <div class="paragraph">
    954. 

  954. <p>To access class fields of the SimpleApplication the way you are used to, initialize them to local variables, as shown in the following AppState template:</p>
    955. 

  955. </div>
    956. 

  956. <div class="listingblock">
    957. 

  957. <div class="content">
    958. 

  958. <pre class="CodeRay highlight"><code data-lang="java"><span class="directive">private</span> SimpleApplication app;
    959. 

  959. <span class="directive">private</span> Node              rootNode;
    960. 

  960. <span class="directive">private</span> AssetManager      assetManager;
    961. 

  961. <span class="directive">private</span> AppStateManager   stateManager;
    962. 

  962. <span class="directive">private</span> InputManager      inputManager;
    963. 

  963. <span class="directive">private</span> ViewPort          viewPort;
    964. 

  964. <span class="directive">private</span> BulletAppState    physics;
    965. 

  965. 

  966. <span class="directive">public</span> <span class="type">class</span> <span class="class">MyAppState</span> <span class="directive">extends</span> AbstractAppState {
    967. 

  967.   <span class="annotation">@Override</span>
    968. 

  968.   <span class="directive">public</span> <span class="type">void</span> initialize(AppStateManager stateManager, Application app) {
    969. 

  969.     <span class="local-variable">super</span>.initialize(stateManager, app);
    970. 

  970.     <span class="local-variable">this</span>.app = (SimpleApplication) app; <span class="comment">// can cast Application to something more specific</span>
    971. 

  971.     <span class="local-variable">this</span>.rootNode     = <span class="local-variable">this</span>.app.getRootNode();
    972. 

  972.     <span class="local-variable">this</span>.assetManager = <span class="local-variable">this</span>.app.getAssetManager();
    973. 

  973.     <span class="local-variable">this</span>.stateManager = <span class="local-variable">this</span>.app.getStateManager();
    974. 

  974.     <span class="local-variable">this</span>.inputManager = <span class="local-variable">this</span>.app.getInputManager();
    975. 

  975.     <span class="local-variable">this</span>.viewPort     = <span class="local-variable">this</span>.app.getViewPort();
    976. 

  976.     <span class="local-variable">this</span>.physics      = <span class="local-variable">this</span>.stateManager.getState(BulletAppState.class);
    977. 

  977.   }
    978. 

  978. }</code></pre>
    979. 

  979. </div>
    980. 

  980. </div>
    981. 

  981. </div>
    982. 

  982. </div>
    983. 

  983. </div>
    984. 

  984. </div>
    985. 

  985. <div id="footer">
    986. 

  986. <div id="footer-text">
    987. 

  987. Version <br>
    988. 

  988. Last updated 2016-06-05 15:58:32 UTC
    989. 

  989. </div>
    990. 

  990. </div>
    991. 

  991. </body>
    992. 

  992. </html>
    993.