brick-engine-js 1.0.26 → 1.0.28

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (67) hide show
  1. package/dist/css/game.bundle.css +5 -0
  2. package/dist/docs/GAME_DEVELOPER_GUIDE.html +2271 -662
  3. package/dist/docs/brick-engine-guide.html +2238 -609
  4. package/dist/docs/documentation_style_guide.html +2698 -973
  5. package/dist/docs/getting-started.html +2192 -574
  6. package/dist/docs/index.html +2278 -608
  7. package/dist/docs/jsdoc_standard.html +2235 -617
  8. package/dist/docs/publishing.html +2196 -572
  9. package/dist/docs/reference/bootstrap.html +2172 -555
  10. package/dist/docs/reference/context/RendererContext.html +2220 -582
  11. package/dist/docs/reference/enums/Color.html +2152 -538
  12. package/dist/docs/reference/enums/ControlEventType.html +2108 -506
  13. package/dist/docs/reference/enums/ControlKey.html +2144 -530
  14. package/dist/docs/reference/enums/EventSuffix.html +2121 -514
  15. package/dist/docs/reference/enums/FontAlignment.html +2157 -546
  16. package/dist/docs/reference/enums/FontSize.html +2122 -518
  17. package/dist/docs/reference/enums/Sound.html +2210 -559
  18. package/dist/docs/reference/enums/StateProperty.html +2131 -526
  19. package/dist/docs/reference/helpers/CellHelper.html +2135 -523
  20. package/dist/docs/reference/helpers/ControlInputHandlerHelper.html +2204 -572
  21. package/dist/docs/reference/helpers/CoordinateHelper.html +2377 -681
  22. package/dist/docs/reference/helpers/RelativeValuesHelper.html +2165 -553
  23. package/dist/docs/reference/interfaces/Debuggable.html +2103 -502
  24. package/dist/docs/reference/interfaces/GameModules.html +2203 -550
  25. package/dist/docs/reference/interfaces/Initializable.html +2093 -496
  26. package/dist/docs/reference/interfaces/RendererInitializable.html +2125 -518
  27. package/dist/docs/reference/interfaces/StateContext.html +2133 -518
  28. package/dist/docs/reference/interfaces/StateSyncable.html +2154 -543
  29. package/dist/docs/reference/interfaces/modules/Control.html +2353 -649
  30. package/dist/docs/reference/interfaces/modules/Grid.html +3202 -1277
  31. package/dist/docs/reference/interfaces/modules/Renderer.html +2140 -523
  32. package/dist/docs/reference/interfaces/modules/RendererComposite.html +2209 -578
  33. package/dist/docs/reference/interfaces/modules/Score.html +2326 -670
  34. package/dist/docs/reference/interfaces/modules/Session.html +2333 -660
  35. package/dist/docs/reference/interfaces/modules/State.html +2651 -898
  36. package/dist/docs/reference/interfaces/modules/Text.html +2362 -669
  37. package/dist/docs/reference/interfaces/modules/Time.html +2418 -739
  38. package/dist/docs/reference/modules/Debugger.html +2206 -578
  39. package/dist/docs/reference/modules/DisplayRenderer.html +2186 -558
  40. package/dist/docs/reference/modules/EventEmitter.html +2321 -631
  41. package/dist/docs/reference/modules/Game.html +2544 -808
  42. package/dist/docs/reference/modules/GameControl.html +2745 -879
  43. package/dist/docs/reference/modules/GameEventRegistry.html +2226 -587
  44. package/dist/docs/reference/modules/GameGrid.html +4236 -1967
  45. package/dist/docs/reference/modules/GameHudGrid.html +2103 -503
  46. package/dist/docs/reference/modules/GameRenderer.html +2247 -590
  47. package/dist/docs/reference/modules/GameScore.html +2383 -695
  48. package/dist/docs/reference/modules/GameSession.html +2232 -580
  49. package/dist/docs/reference/modules/GameSound.html +2300 -637
  50. package/dist/docs/reference/modules/GameState.html +2846 -1032
  51. package/dist/docs/reference/modules/GameText.html +2427 -702
  52. package/dist/docs/reference/modules/GameTime.html +2460 -763
  53. package/dist/docs/reference/modules/HudRenderer.html +2205 -569
  54. package/dist/docs/reference/modules/InitialStateSnapshot.html +2185 -561
  55. package/dist/docs/reference/modules/SessionModal.html +2145 -521
  56. package/dist/docs/reference/types/Axis.html +2102 -506
  57. package/dist/docs/reference/types/Cell.html +2124 -515
  58. package/dist/docs/reference/types/ControlCallback.html +2084 -489
  59. package/dist/docs/reference/types/Coordinate.html +2110 -511
  60. package/dist/docs/reference/types/GameEvent.html +2123 -515
  61. package/dist/docs/reference/types/RendererMetrics.html +2133 -515
  62. package/dist/docs/reference/types/Vector.html +2111 -510
  63. package/dist/docs/reference/view/GameView.html +2282 -613
  64. package/dist/docs/testing_best_practices.html +2338 -699
  65. package/dist/game.bundle.js +1 -1
  66. package/dist/types/view/components/layout/FrameLayout.d.ts +1 -1
  67. package/package.json +1 -1
package/dist/docs/reference/helpers/CoordinateHelper.html CHANGED
@@ -1,682 +1,2378 @@
1
- <!DOCTYPE html>
1
+ <!doctype html>
2
2
  <html lang="en">
3
- <head>
4
- <meta charset="UTF-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
7
- <meta name="generator" content="Asciidoctor 2.0.20">
8
- <meta name="description" content="Specialized math utilities for converting between Grid, Display, and Pixel coordinate systems.">
9
- <meta name="keywords" content="coordinates, math, grid, display, conversion, helper">
10
- <meta name="author" content="== Architectural Purpose">
11
- <title>CoordinateHelper Reference</title>
12
- <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">
13
- <style>
14
- /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
15
- /* Uncomment the following line when using as a custom stylesheet */
16
- /* @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"; */
17
- html{font-family:sans-serif;-webkit-text-size-adjust:100%}
18
- a{background:none}
19
- a:focus{outline:thin dotted}
20
- a:active,a:hover{outline:0}
21
- h1{font-size:2em;margin:.67em 0}
22
- b,strong{font-weight:bold}
23
- abbr{font-size:.9em}
24
- abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
25
- dfn{font-style:italic}
26
- hr{height:0}
27
- mark{background:#ff0;color:#000}
28
- code,kbd,pre,samp{font-family:monospace;font-size:1em}
29
- pre{white-space:pre-wrap}
30
- q{quotes:"\201C" "\201D" "\2018" "\2019"}
31
- small{font-size:80%}
32
- sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
33
- sup{top:-.5em}
34
- sub{bottom:-.25em}
35
- img{border:0}
36
- svg:not(:root){overflow:hidden}
37
- figure{margin:0}
38
- audio,video{display:inline-block}
39
- audio:not([controls]){display:none;height:0}
40
- fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
41
- legend{border:0;padding:0}
42
- button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
43
- button,input{line-height:normal}
44
- button,select{text-transform:none}
45
- button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
46
- button[disabled],html input[disabled]{cursor:default}
47
- input[type=checkbox],input[type=radio]{padding:0}
48
- button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
49
- textarea{overflow:auto;vertical-align:top}
50
- table{border-collapse:collapse;border-spacing:0}
51
- *,::before,::after{box-sizing:border-box}
52
- html,body{font-size:100%}
53
- body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
54
- a:hover{cursor:pointer}
55
- img,object,embed{max-width:100%;height:auto}
56
- object,embed{height:100%}
57
- img{-ms-interpolation-mode:bicubic}
58
- .left{float:left!important}
59
- .right{float:right!important}
60
- .text-left{text-align:left!important}
61
- .text-right{text-align:right!important}
62
- .text-center{text-align:center!important}
63
- .text-justify{text-align:justify!important}
64
- .hide{display:none}
65
- img,object,svg{display:inline-block;vertical-align:middle}
66
- textarea{height:auto;min-height:50px}
67
- select{width:100%}
68
- .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}
69
- 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}
70
- a{color:#2156a5;text-decoration:underline;line-height:inherit}
71
- a:hover,a:focus{color:#1d4b8f}
72
- a img{border:0}
73
- p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
74
- p aside{font-size:.875em;line-height:1.35;font-style:italic}
75
- 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}
76
- 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}
77
- h1{font-size:2.125em}
78
- h2{font-size:1.6875em}
79
- h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
80
- h4,h5{font-size:1.125em}
81
- h6{font-size:1em}
82
- hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
83
- em,i{font-style:italic;line-height:inherit}
84
- strong,b{font-weight:bold;line-height:inherit}
85
- small{font-size:60%;line-height:inherit}
86
- code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
87
- ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
88
- ul,ol{margin-left:1.5em}
89
- ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
90
- ul.circle{list-style-type:circle}
91
- ul.disc{list-style-type:disc}
92
- ul.square{list-style-type:square}
93
- ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
94
- ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
95
- dl dt{margin-bottom:.3125em;font-weight:bold}
96
- dl dd{margin-bottom:1.25em}
97
- blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
98
- blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
99
- @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
100
- h1{font-size:2.75em}
101
- h2{font-size:2.3125em}
102
- h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
103
- h4{font-size:1.4375em}}
104
- table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
105
- table thead,table tfoot{background:#f7f8f7}
106
- 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}
107
- table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
108
- table tr.even,table tr.alt{background:#f8f8f7}
109
- table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
110
- h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
111
- h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
112
- .center{margin-left:auto;margin-right:auto}
113
- .stretch{width:100%}
114
- .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
115
- .clearfix::after,.float-group::after{clear:both}
116
- :not(pre).nobreak{word-wrap:normal}
117
- :not(pre).nowrap{white-space:nowrap}
118
- :not(pre).pre-wrap{white-space:pre-wrap}
119
- :not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
120
- pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
121
- pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
122
- pre>code{display:block}
123
- pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
124
- em em{font-style:normal}
125
- strong strong{font-weight:400}
126
- .keyseq{color:rgba(51,51,51,.8)}
127
- 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:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
128
- .keyseq kbd:first-child{margin-left:0}
129
- .keyseq kbd:last-child{margin-right:0}
130
- .menuseq,.menuref{color:#000}
131
- .menuseq b:not(.caret),.menuref{font-weight:inherit}
132
- .menuseq{word-spacing:-.02em}
133
- .menuseq b.caret{font-size:1.25em;line-height:.8}
134
- .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
135
- b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
136
- b.button::before{content:"[";padding:0 3px 0 2px}
137
- b.button::after{content:"]";padding:0 2px 0 3px}
138
- p a>code:hover{color:rgba(0,0,0,.9)}
139
- #header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
140
- #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
141
- #header::after,#content::after,#footnotes::after,#footer::after{clear:both}
142
- #content{margin-top:1.25em}
143
- #content::before{content:none}
144
- #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
145
- #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
146
- #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
147
- #header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
148
- #header .details span:first-child{margin-left:-.125em}
149
- #header .details span.email a{color:rgba(0,0,0,.85)}
150
- #header .details br{display:none}
151
- #header .details br+span::before{content:"\00a0\2013\00a0"}
152
- #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
153
- #header .details br+span#revremark::before{content:"\00a0|\00a0"}
154
- #header #revnumber{text-transform:capitalize}
155
- #header #revnumber::after{content:"\00a0"}
156
- #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
157
- #toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
158
- #toc>ul{margin-left:.125em}
159
- #toc ul.sectlevel0>li>a{font-style:italic}
160
- #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
161
- #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
162
- #toc li{line-height:1.3334;margin-top:.3334em}
163
- #toc a{text-decoration:none}
164
- #toc a:active{text-decoration:underline}
165
- #toctitle{color:#7a2518;font-size:1.2em}
166
- @media screen and (min-width:768px){#toctitle{font-size:1.375em}
167
- body.toc2{padding-left:15em;padding-right:0}
168
- #toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
169
- #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
170
- #toc.toc2>ul{font-size:.9em;margin-bottom:0}
171
- #toc.toc2 ul ul{margin-left:0;padding-left:1em}
172
- #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
173
- body.toc2.toc-right{padding-left:0;padding-right:15em}
174
- body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
175
- @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
176
- #toc.toc2{width:20em}
177
- #toc.toc2 #toctitle{font-size:1.375em}
178
- #toc.toc2>ul{font-size:.95em}
179
- #toc.toc2 ul ul{padding-left:1.25em}
180
- body.toc2.toc-right{padding-left:0;padding-right:20em}}
181
- #content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
182
- #content #toc>:first-child{margin-top:0}
183
- #content #toc>:last-child{margin-bottom:0}
184
- #footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
185
- #footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
186
- #content{margin-bottom:.625em}
187
- .sect1{padding-bottom:.625em}
188
- @media screen and (min-width:768px){#content{margin-bottom:1.25em}
189
- .sect1{padding-bottom:1.25em}}
190
- .sect1:last-child{padding-bottom:0}
191
- .sect1+.sect1{border-top:1px solid #e7e7e9}
192
- #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}
193
- #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}
194
- #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}
195
- #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}
196
- #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}
197
- details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
198
- details{margin-left:1.25rem}
199
- details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
200
- details>summary::-webkit-details-marker{display:none}
201
- details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
202
- details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
203
- details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
204
- .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}
205
- table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
206
- .paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
207
- .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
208
- .admonitionblock>table td.icon{text-align:center;width:80px}
209
- .admonitionblock>table td.icon img{max-width:none}
210
- .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
211
- .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
212
- .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
213
- .exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
214
- .sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
215
- .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
216
- .exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
217
- .exampleblock>.content>:last-child,.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,.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}
218
- .literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
219
- @media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
220
- @media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
221
- .literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
222
- .literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
223
- .listingblock>.content{position:relative}
224
- .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:inherit;opacity:.5}
225
- .listingblock:hover code[data-lang]::before{display:block}
226
- .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
227
- .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
228
- .listingblock pre.highlightjs{padding:0}
229
- .listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
230
- .listingblock pre.prettyprint{border-width:0}
231
- .prettyprint{background:#f7f7f8}
232
- pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
233
- pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
234
- pre.prettyprint li code[data-lang]::before{opacity:1}
235
- pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
236
- table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
237
- table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
238
- table.linenotable td.code{padding-left:.75em}
239
- table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
240
- pre.pygments span.linenos{display:inline-block;margin-right:.75em}
241
- .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
242
- .quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
243
- .quoteblock blockquote,.quoteblock 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}
244
- .quoteblock blockquote{margin:0;padding:0;border:0}
245
- .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)}
246
- .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
247
- .quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
248
- .verseblock{margin:0 1em 1.25em}
249
- .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
250
- .verseblock pre strong{font-weight:400}
251
- .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
252
- .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
253
- .quoteblock .attribution br,.verseblock .attribution br{display:none}
254
- .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
255
- .quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
256
- .quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
257
- .quoteblock.abstract{margin:0 1em 1.25em;display:block}
258
- .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
259
- .quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
260
- .quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
261
- .quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
262
- .quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
263
- p.tableblock:last-child{margin-bottom:0}
264
- td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
265
- td.tableblock>.content>:last-child{margin-bottom:-1.25em}
266
- table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
267
- table.grid-all>*>tr>*{border-width:1px}
268
- table.grid-cols>*>tr>*{border-width:0 1px}
269
- table.grid-rows>*>tr>*{border-width:1px 0}
270
- table.frame-all{border-width:1px}
271
- table.frame-ends{border-width:1px 0}
272
- table.frame-sides{border-width:0 1px}
273
- table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
274
- table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
275
- table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
276
- table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
277
- table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
278
- th.halign-left,td.halign-left{text-align:left}
279
- th.halign-right,td.halign-right{text-align:right}
280
- th.halign-center,td.halign-center{text-align:center}
281
- th.valign-top,td.valign-top{vertical-align:top}
282
- th.valign-bottom,td.valign-bottom{vertical-align:bottom}
283
- th.valign-middle,td.valign-middle{vertical-align:middle}
284
- table thead th,table tfoot th{font-weight:bold}
285
- tbody tr th{background:#f7f8f7}
286
- tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
287
- p.tableblock>code:only-child{background:none;padding:0}
288
- p.tableblock{font-size:1em}
289
- ol{margin-left:1.75em}
290
- ul li ol{margin-left:1.5em}
291
- dl dd{margin-left:1.125em}
292
- dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
293
- li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
294
- ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
295
- ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
296
- ul.unstyled,ol.unstyled{margin-left:0}
297
- li>p:empty:only-child::before{content:"";display:inline-block}
298
- ul.checklist>li>p:first-child{margin-left:-1em}
299
- ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
300
- ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
301
- ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
302
- ul.inline>li{margin-left:1.25em}
303
- .unstyled dl dt{font-weight:400;font-style:normal}
304
- ol.arabic{list-style-type:decimal}
305
- ol.decimal{list-style-type:decimal-leading-zero}
306
- ol.loweralpha{list-style-type:lower-alpha}
307
- ol.upperalpha{list-style-type:upper-alpha}
308
- ol.lowerroman{list-style-type:lower-roman}
309
- ol.upperroman{list-style-type:upper-roman}
310
- ol.lowergreek{list-style-type:lower-greek}
311
- .hdlist>table,.colist>table{border:0;background:none}
312
- .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
313
- td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
314
- td.hdlist1{font-weight:bold;padding-bottom:1.25em}
315
- td.hdlist2{word-wrap:anywhere}
316
- .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
317
- .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
318
- .colist td:not([class]):first-child img{max-width:none}
319
- .colist td:not([class]):last-child{padding:.25em 0}
320
- .thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
321
- .imageblock.left{margin:.25em .625em 1.25em 0}
322
- .imageblock.right{margin:.25em 0 1.25em .625em}
323
- .imageblock>.title{margin-bottom:0}
324
- .imageblock.thumb,.imageblock.th{border-width:6px}
325
- .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
326
- .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
327
- .image.left{margin-right:.625em}
328
- .image.right{margin-left:.625em}
329
- a.image{text-decoration:none;display:inline-block}
330
- a.image object{pointer-events:none}
331
- sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
332
- sup.footnote a,sup.footnoteref a{text-decoration:none}
333
- sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
334
- #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
335
- #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
336
- #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
337
- #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
338
- #footnotes .footnote:last-of-type{margin-bottom:0}
339
- #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
340
- div.unbreakable{page-break-inside:avoid}
341
- .big{font-size:larger}
342
- .small{font-size:smaller}
343
- .underline{text-decoration:underline}
344
- .overline{text-decoration:overline}
345
- .line-through{text-decoration:line-through}
346
- .aqua{color:#00bfbf}
347
- .aqua-background{background:#00fafa}
348
- .black{color:#000}
349
- .black-background{background:#000}
350
- .blue{color:#0000bf}
351
- .blue-background{background:#0000fa}
352
- .fuchsia{color:#bf00bf}
353
- .fuchsia-background{background:#fa00fa}
354
- .gray{color:#606060}
355
- .gray-background{background:#7d7d7d}
356
- .green{color:#006000}
357
- .green-background{background:#007d00}
358
- .lime{color:#00bf00}
359
- .lime-background{background:#00fa00}
360
- .maroon{color:#600000}
361
- .maroon-background{background:#7d0000}
362
- .navy{color:#000060}
363
- .navy-background{background:#00007d}
364
- .olive{color:#606000}
365
- .olive-background{background:#7d7d00}
366
- .purple{color:#600060}
367
- .purple-background{background:#7d007d}
368
- .red{color:#bf0000}
369
- .red-background{background:#fa0000}
370
- .silver{color:#909090}
371
- .silver-background{background:#bcbcbc}
372
- .teal{color:#006060}
373
- .teal-background{background:#007d7d}
374
- .white{color:#bfbfbf}
375
- .white-background{background:#fafafa}
376
- .yellow{color:#bfbf00}
377
- .yellow-background{background:#fafa00}
378
- span.icon>.fa{cursor:default}
379
- a span.icon>.fa{cursor:inherit}
380
- .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
381
- .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
382
- .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
383
- .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
384
- .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
385
- .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
386
- .conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;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}
387
- .conum[data-value] *{color:#fff!important}
388
- .conum[data-value]+b{display:none}
389
- .conum[data-value]::after{content:attr(data-value)}
390
- pre .conum[data-value]{position:relative;top:-.125em}
391
- b.conum *{color:inherit!important}
392
- .conum:not([data-value]):empty{display:none}
393
- dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
394
- h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
395
- p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
396
- p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
397
- p{margin-bottom:1.25rem}
398
- .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
399
- .exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
400
- .print-only{display:none!important}
401
- @page{margin:1.25cm .75cm}
402
- @media print{*{box-shadow:none!important;text-shadow:none!important}
403
- html{font-size:80%}
404
- a{color:inherit!important;text-decoration:underline!important}
405
- a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
406
- a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
407
- abbr[title]{border-bottom:1px dotted}
408
- abbr[title]::after{content:" (" attr(title) ")"}
409
- pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
410
- thead{display:table-header-group}
411
- svg{max-width:100%}
412
- p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
413
- h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
414
- #header,#content,#footnotes,#footer{max-width:none}
415
- #toc,.sidebarblock,.exampleblock>.content{background:none!important}
416
- #toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
417
- body.book #header{text-align:center}
418
- body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
419
- body.book #header .details{border:0!important;display:block;padding:0!important}
420
- body.book #header .details span:first-child{margin-left:0!important}
421
- body.book #header .details br{display:block}
422
- body.book #header .details br+span::before{content:none!important}
423
- body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
424
- body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
425
- .listingblock code[data-lang]::before{display:block}
426
- #footer{padding:0 .9375em}
427
- .hide-on-print{display:none!important}
428
- .print-only{display:block!important}
429
- .hide-for-print{display:none!important}
430
- .show-for-print{display:inherit!important}}
431
- @media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
432
- .sect1{padding:0!important}
433
- .sect1+.sect1{border:0}
434
- #footer{background:none}
435
- #footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
436
- @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
437
- </style>
438
- <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
439
- <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/styles/github.min.css">
440
- </head>
441
- <body class="article toc2 toc-left">
442
- <div id="header">
443
- <h1>CoordinateHelper Reference</h1>
444
- <div class="details">
445
- <span id="author" class="author">== Architectural Purpose</span><br>
446
- </div>
447
- <div id="toc" class="toc2">
448
- <div id="toctitle">Table of Contents</div>
449
- <ul class="sectlevel1">
450
- <li><a href="#api-reference">1. API Reference</a>
451
- <ul class="sectlevel2">
452
- <li><a href="#getrelativecoordinatecoordinate-coordinate-coordinate">1.1. <code>getRelativeCoordinate(coordinate: Coordinate): Coordinate</code></a></li>
453
- <li><a href="#getdisplayposxx-number-displaywidth-number-number">1.2. <code>getDisplayPosX(x: number, displayWidth: number): number</code></a></li>
454
- <li><a href="#getdisplayposyy-number-displayheight-number-number">1.3. <code>getDisplayPosY(y: number, displayHeight: number): number</code></a></li>
455
- <li><a href="#gethudposxx-number-displaywidth-number-number">1.4. <code>getHudPosX(x: number, displayWidth: number): number</code></a></li>
456
- <li><a href="#gethudposyy-number-displayheight-number-number">1.5. <code>getHudPosY(y: number, displayHeight: number): number</code></a></li>
457
- </ul>
458
- </li>
459
- </ul>
460
- </div>
461
- </div>
462
- <div id="content">
463
- <div id="preamble">
464
- <div class="sectionbody">
465
- <div class="paragraph">
466
- <p>The <code>CoordinateHelper</code> acts as the engine&#8217;s translation layer between the different abstract mathematical models (e.g., the logical <code><a href="../modules/GameGrid.html">Game Grid</a></code> or scaling normalized values from 0.0 to 1.0) and the absolute physical layout on screen. It ensures consistency in calculating element sizes dynamically so interfaces remain strictly responsive to the runtime canvas resolution.</p>
467
- </div>
468
- </div>
469
- </div>
470
- <div class="sect1">
471
- <h2 id="api-reference"><a class="link" href="#api-reference">1. API Reference</a></h2>
472
- <div class="sectionbody">
473
- <div class="sect2">
474
- <h3 id="getrelativecoordinatecoordinate-coordinate-coordinate"><a class="link" href="#getrelativecoordinatecoordinate-coordinate-coordinate">1.1. <code>getRelativeCoordinate(coordinate: <a href="../types/Coordinate.html">Coordinate</a>): <a href="../types/Coordinate.html">Coordinate</a></code></a></h3>
475
- <div class="paragraph">
476
- <p>Converts a pixel-based coordinate into a normalized relative coordinate (0.0 to 1.0).</p>
477
- </div>
478
- <div class="paragraph">
479
- <p><strong>Parameters</strong></p>
480
- </div>
481
- <table class="tableblock frame-all grid-all stretch">
482
- <colgroup>
483
- <col style="width: 20%;">
484
- <col style="width: 20%;">
485
- <col style="width: 60%;">
486
- </colgroup>
487
- <tbody>
488
- <tr>
489
- <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
490
- <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
491
- <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
492
- </tr>
493
- <tr>
494
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>coordinate</code></p></td>
495
- <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../types/Coordinate.html">Coordinate</a></p></td>
496
- <td class="tableblock halign-left valign-top"><p class="tableblock">The absolute pixel coordinate.</p></td>
497
- </tr>
498
- </tbody>
499
- </table>
500
- <div class="paragraph">
501
- <p><strong>Returns</strong></p>
502
- </div>
503
- <div class="paragraph">
504
- <p><code><a href="../types/Coordinate.html">Coordinate</a></code> - The new coordinate structure scaled proportionately to the physical base canvas width/height.</p>
505
- </div>
506
- <hr>
507
- </div>
508
- <div class="sect2">
509
- <h3 id="getdisplayposxx-number-displaywidth-number-number"><a class="link" href="#getdisplayposxx-number-displaywidth-number-number">1.2. <code>getDisplayPosX(x: number, displayWidth: number): number</code></a></h3>
510
- <div class="paragraph">
511
- <p>Calculates the absolute X pixel position on the main game display.</p>
512
- </div>
513
- <div class="paragraph">
514
- <p><strong>Parameters</strong></p>
515
- </div>
516
- <table class="tableblock frame-all grid-all stretch">
517
- <colgroup>
518
- <col style="width: 20%;">
519
- <col style="width: 20%;">
520
- <col style="width: 60%;">
521
- </colgroup>
522
- <tbody>
523
- <tr>
524
- <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
525
- <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
526
- <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
527
- </tr>
528
- <tr>
529
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>x</code></p></td>
530
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
531
- <td class="tableblock halign-left valign-top"><p class="tableblock">The relative or normalized input X horizontal position (0.0 to 1.0).</p></td>
532
- </tr>
533
- <tr>
534
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>displayWidth</code></p></td>
535
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
536
- <td class="tableblock halign-left valign-top"><p class="tableblock">The dynamically calculated width of the central display area.</p></td>
537
- </tr>
538
- </tbody>
539
- </table>
540
- <div class="paragraph">
541
- <p><strong>Returns</strong></p>
542
- </div>
543
- <div class="paragraph">
544
- <p><code>number</code> - The absolute horizontal pixel position.</p>
545
- </div>
546
- <hr>
547
- </div>
548
- <div class="sect2">
549
- <h3 id="getdisplayposyy-number-displayheight-number-number"><a class="link" href="#getdisplayposyy-number-displayheight-number-number">1.3. <code>getDisplayPosY(y: number, displayHeight: number): number</code></a></h3>
550
- <div class="paragraph">
551
- <p>Calculates the absolute Y pixel position on the main game display.</p>
552
- </div>
553
- <div class="paragraph">
554
- <p><strong>Parameters</strong></p>
555
- </div>
556
- <table class="tableblock frame-all grid-all stretch">
557
- <colgroup>
558
- <col style="width: 20%;">
559
- <col style="width: 20%;">
560
- <col style="width: 60%;">
561
- </colgroup>
562
- <tbody>
563
- <tr>
564
- <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
565
- <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
566
- <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
567
- </tr>
568
- <tr>
569
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>y</code></p></td>
570
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
571
- <td class="tableblock halign-left valign-top"><p class="tableblock">The relative or normalized input Y vertical position (0.0 to 1.0).</p></td>
572
- </tr>
573
- <tr>
574
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>displayHeight</code></p></td>
575
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
576
- <td class="tableblock halign-left valign-top"><p class="tableblock">The dynamically calculated height of the central display area.</p></td>
577
- </tr>
578
- </tbody>
579
- </table>
580
- <div class="paragraph">
581
- <p><strong>Returns</strong></p>
582
- </div>
583
- <div class="paragraph">
584
- <p><code>number</code> - The absolute vertical pixel position.</p>
585
- </div>
586
- <hr>
587
- </div>
588
- <div class="sect2">
589
- <h3 id="gethudposxx-number-displaywidth-number-number"><a class="link" href="#gethudposxx-number-displaywidth-number-number">1.4. <code>getHudPosX(x: number, displayWidth: number): number</code></a></h3>
590
- <div class="paragraph">
591
- <p>Calculates the absolute X pixel position within the HUD area.</p>
592
- </div>
593
- <div class="paragraph">
594
- <p><strong>Parameters</strong></p>
595
- </div>
596
- <table class="tableblock frame-all grid-all stretch">
597
- <colgroup>
598
- <col style="width: 20%;">
599
- <col style="width: 20%;">
600
- <col style="width: 60%;">
601
- </colgroup>
602
- <tbody>
603
- <tr>
604
- <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
605
- <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
606
- <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
607
- </tr>
608
- <tr>
609
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>x</code></p></td>
610
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
611
- <td class="tableblock halign-left valign-top"><p class="tableblock">The relative or normalized X position specifically within the bounded HUD compartment.</p></td>
612
- </tr>
613
- <tr>
614
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>displayWidth</code></p></td>
615
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
616
- <td class="tableblock halign-left valign-top"><p class="tableblock">The total real width of the central display (used for zero-point alignment offset calculation).</p></td>
617
- </tr>
618
- </tbody>
619
- </table>
620
- <div class="paragraph">
621
- <p><strong>Returns</strong></p>
622
- </div>
623
- <div class="paragraph">
624
- <p><code>number</code> - The absolute horizontal pixel position within the HUD.</p>
625
- </div>
626
- <hr>
627
- </div>
628
- <div class="sect2">
629
- <h3 id="gethudposyy-number-displayheight-number-number"><a class="link" href="#gethudposyy-number-displayheight-number-number">1.5. <code>getHudPosY(y: number, displayHeight: number): number</code></a></h3>
630
- <div class="paragraph">
631
- <p>Calculates the absolute Y pixel position within the HUD area.</p>
632
- </div>
633
- <div class="paragraph">
634
- <p><strong>Parameters</strong></p>
635
- </div>
636
- <table class="tableblock frame-all grid-all stretch">
637
- <colgroup>
638
- <col style="width: 20%;">
639
- <col style="width: 20%;">
640
- <col style="width: 60%;">
641
- </colgroup>
642
- <tbody>
643
- <tr>
644
- <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
645
- <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
646
- <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
647
- </tr>
648
- <tr>
649
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>y</code></p></td>
650
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
651
- <td class="tableblock halign-left valign-top"><p class="tableblock">The relative or normalized Y position specifically within the bounded HUD compartment.</p></td>
652
- </tr>
653
- <tr>
654
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>displayHeight</code></p></td>
655
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
656
- <td class="tableblock halign-left valign-top"><p class="tableblock">The absolute pixel height assigned logically to the central display (used for scaled positioning bounds).</p></td>
657
- </tr>
658
- </tbody>
659
- </table>
660
- <div class="paragraph">
661
- <p><strong>Returns</strong></p>
662
- </div>
663
- <div class="paragraph">
664
- <p><code>number</code> - The absolute vertical pixel position within the HUD.</p>
665
- </div>
666
- </div>
667
- </div>
668
- </div>
669
- </div>
670
- <div id="footer">
671
- <div id="footer-text">
672
- </div>
673
- </div>
674
- <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>
675
- <script>
676
- if (!hljs.initHighlighting.called) {
677
- hljs.initHighlighting.called = true
678
- ;[].slice.call(document.querySelectorAll('pre.highlight > code[data-lang]')).forEach(function (el) { hljs.highlightBlock(el) })
679
- }
680
- </script>
681
- </body>
682
- </html>
3
+ <head>
4
+ <meta charset="UTF-8" />
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge" />
6
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
7
+ <meta name="generator" content="Asciidoctor 2.0.20" />
8
+ <meta name="description" content="Specialized math utilities for converting between Grid, Display, and Pixel coordinate systems." />
9
+ <meta name="keywords" content="coordinates, math, grid, display, conversion, helper" />
10
+ <meta name="author" content="== Architectural Purpose" />
11
+ <title>CoordinateHelper Reference</title>
12
+ <link
13
+ rel="stylesheet"
14
+ 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"
15
+ />
16
+ <style>
17
+ /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
18
+ /* Uncomment the following line when using as a custom stylesheet */
19
+ /* @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"; */
20
+ html {
21
+ font-family: sans-serif;
22
+ -webkit-text-size-adjust: 100%;
23
+ }
24
+ a {
25
+ background: none;
26
+ }
27
+ a:focus {
28
+ outline: thin dotted;
29
+ }
30
+ a:active,
31
+ a:hover {
32
+ outline: 0;
33
+ }
34
+ h1 {
35
+ font-size: 2em;
36
+ margin: 0.67em 0;
37
+ }
38
+ b,
39
+ strong {
40
+ font-weight: bold;
41
+ }
42
+ abbr {
43
+ font-size: 0.9em;
44
+ }
45
+ abbr[title] {
46
+ cursor: help;
47
+ border-bottom: 1px dotted #dddddf;
48
+ text-decoration: none;
49
+ }
50
+ dfn {
51
+ font-style: italic;
52
+ }
53
+ hr {
54
+ height: 0;
55
+ }
56
+ mark {
57
+ background: #ff0;
58
+ color: #000;
59
+ }
60
+ code,
61
+ kbd,
62
+ pre,
63
+ samp {
64
+ font-family: monospace;
65
+ font-size: 1em;
66
+ }
67
+ pre {
68
+ white-space: pre-wrap;
69
+ }
70
+ q {
71
+ quotes: '\201C' '\201D' '\2018' '\2019';
72
+ }
73
+ small {
74
+ font-size: 80%;
75
+ }
76
+ sub,
77
+ sup {
78
+ font-size: 75%;
79
+ line-height: 0;
80
+ position: relative;
81
+ vertical-align: baseline;
82
+ }
83
+ sup {
84
+ top: -0.5em;
85
+ }
86
+ sub {
87
+ bottom: -0.25em;
88
+ }
89
+ img {
90
+ border: 0;
91
+ }
92
+ svg:not(:root) {
93
+ overflow: hidden;
94
+ }
95
+ figure {
96
+ margin: 0;
97
+ }
98
+ audio,
99
+ video {
100
+ display: inline-block;
101
+ }
102
+ audio:not([controls]) {
103
+ display: none;
104
+ height: 0;
105
+ }
106
+ fieldset {
107
+ border: 1px solid silver;
108
+ margin: 0 2px;
109
+ padding: 0.35em 0.625em 0.75em;
110
+ }
111
+ legend {
112
+ border: 0;
113
+ padding: 0;
114
+ }
115
+ button,
116
+ input,
117
+ select,
118
+ textarea {
119
+ font-family: inherit;
120
+ font-size: 100%;
121
+ margin: 0;
122
+ }
123
+ button,
124
+ input {
125
+ line-height: normal;
126
+ }
127
+ button,
128
+ select {
129
+ text-transform: none;
130
+ }
131
+ button,
132
+ html input[type='button'],
133
+ input[type='reset'],
134
+ input[type='submit'] {
135
+ -webkit-appearance: button;
136
+ cursor: pointer;
137
+ }
138
+ button[disabled],
139
+ html input[disabled] {
140
+ cursor: default;
141
+ }
142
+ input[type='checkbox'],
143
+ input[type='radio'] {
144
+ padding: 0;
145
+ }
146
+ button::-moz-focus-inner,
147
+ input::-moz-focus-inner {
148
+ border: 0;
149
+ padding: 0;
150
+ }
151
+ textarea {
152
+ overflow: auto;
153
+ vertical-align: top;
154
+ }
155
+ table {
156
+ border-collapse: collapse;
157
+ border-spacing: 0;
158
+ }
159
+ *,
160
+ ::before,
161
+ ::after {
162
+ box-sizing: border-box;
163
+ }
164
+ html,
165
+ body {
166
+ font-size: 100%;
167
+ }
168
+ body {
169
+ background: #fff;
170
+ color: rgba(0, 0, 0, 0.8);
171
+ padding: 0;
172
+ margin: 0;
173
+ font-family: 'Noto Serif', 'DejaVu Serif', serif;
174
+ line-height: 1;
175
+ position: relative;
176
+ cursor: auto;
177
+ -moz-tab-size: 4;
178
+ -o-tab-size: 4;
179
+ tab-size: 4;
180
+ word-wrap: anywhere;
181
+ -moz-osx-font-smoothing: grayscale;
182
+ -webkit-font-smoothing: antialiased;
183
+ }
184
+ a:hover {
185
+ cursor: pointer;
186
+ }
187
+ img,
188
+ object,
189
+ embed {
190
+ max-width: 100%;
191
+ height: auto;
192
+ }
193
+ object,
194
+ embed {
195
+ height: 100%;
196
+ }
197
+ img {
198
+ -ms-interpolation-mode: bicubic;
199
+ }
200
+ .left {
201
+ float: left !important;
202
+ }
203
+ .right {
204
+ float: right !important;
205
+ }
206
+ .text-left {
207
+ text-align: left !important;
208
+ }
209
+ .text-right {
210
+ text-align: right !important;
211
+ }
212
+ .text-center {
213
+ text-align: center !important;
214
+ }
215
+ .text-justify {
216
+ text-align: justify !important;
217
+ }
218
+ .hide {
219
+ display: none;
220
+ }
221
+ img,
222
+ object,
223
+ svg {
224
+ display: inline-block;
225
+ vertical-align: middle;
226
+ }
227
+ textarea {
228
+ height: auto;
229
+ min-height: 50px;
230
+ }
231
+ select {
232
+ width: 100%;
233
+ }
234
+ .subheader,
235
+ .admonitionblock td.content > .title,
236
+ .audioblock > .title,
237
+ .exampleblock > .title,
238
+ .imageblock > .title,
239
+ .listingblock > .title,
240
+ .literalblock > .title,
241
+ .stemblock > .title,
242
+ .openblock > .title,
243
+ .paragraph > .title,
244
+ .quoteblock > .title,
245
+ table.tableblock > .title,
246
+ .verseblock > .title,
247
+ .videoblock > .title,
248
+ .dlist > .title,
249
+ .olist > .title,
250
+ .ulist > .title,
251
+ .qlist > .title,
252
+ .hdlist > .title {
253
+ line-height: 1.45;
254
+ color: #7a2518;
255
+ font-weight: 400;
256
+ margin-top: 0;
257
+ margin-bottom: 0.25em;
258
+ }
259
+ div,
260
+ dl,
261
+ dt,
262
+ dd,
263
+ ul,
264
+ ol,
265
+ li,
266
+ h1,
267
+ h2,
268
+ h3,
269
+ #toctitle,
270
+ .sidebarblock > .content > .title,
271
+ h4,
272
+ h5,
273
+ h6,
274
+ pre,
275
+ form,
276
+ p,
277
+ blockquote,
278
+ th,
279
+ td {
280
+ margin: 0;
281
+ padding: 0;
282
+ }
283
+ a {
284
+ color: #2156a5;
285
+ text-decoration: underline;
286
+ line-height: inherit;
287
+ }
288
+ a:hover,
289
+ a:focus {
290
+ color: #1d4b8f;
291
+ }
292
+ a img {
293
+ border: 0;
294
+ }
295
+ p {
296
+ line-height: 1.6;
297
+ margin-bottom: 1.25em;
298
+ text-rendering: optimizeLegibility;
299
+ }
300
+ p aside {
301
+ font-size: 0.875em;
302
+ line-height: 1.35;
303
+ font-style: italic;
304
+ }
305
+ h1,
306
+ h2,
307
+ h3,
308
+ #toctitle,
309
+ .sidebarblock > .content > .title,
310
+ h4,
311
+ h5,
312
+ h6 {
313
+ font-family: 'Open Sans', 'DejaVu Sans', sans-serif;
314
+ font-weight: 300;
315
+ font-style: normal;
316
+ color: #ba3925;
317
+ text-rendering: optimizeLegibility;
318
+ margin-top: 1em;
319
+ margin-bottom: 0.5em;
320
+ line-height: 1.0125em;
321
+ }
322
+ h1 small,
323
+ h2 small,
324
+ h3 small,
325
+ #toctitle small,
326
+ .sidebarblock > .content > .title small,
327
+ h4 small,
328
+ h5 small,
329
+ h6 small {
330
+ font-size: 60%;
331
+ color: #e99b8f;
332
+ line-height: 0;
333
+ }
334
+ h1 {
335
+ font-size: 2.125em;
336
+ }
337
+ h2 {
338
+ font-size: 1.6875em;
339
+ }
340
+ h3,
341
+ #toctitle,
342
+ .sidebarblock > .content > .title {
343
+ font-size: 1.375em;
344
+ }
345
+ h4,
346
+ h5 {
347
+ font-size: 1.125em;
348
+ }
349
+ h6 {
350
+ font-size: 1em;
351
+ }
352
+ hr {
353
+ border: solid #dddddf;
354
+ border-width: 1px 0 0;
355
+ clear: both;
356
+ margin: 1.25em 0 1.1875em;
357
+ }
358
+ em,
359
+ i {
360
+ font-style: italic;
361
+ line-height: inherit;
362
+ }
363
+ strong,
364
+ b {
365
+ font-weight: bold;
366
+ line-height: inherit;
367
+ }
368
+ small {
369
+ font-size: 60%;
370
+ line-height: inherit;
371
+ }
372
+ code {
373
+ font-family: 'Droid Sans Mono', 'DejaVu Sans Mono', monospace;
374
+ font-weight: 400;
375
+ color: rgba(0, 0, 0, 0.9);
376
+ }
377
+ ul,
378
+ ol,
379
+ dl {
380
+ line-height: 1.6;
381
+ margin-bottom: 1.25em;
382
+ list-style-position: outside;
383
+ font-family: inherit;
384
+ }
385
+ ul,
386
+ ol {
387
+ margin-left: 1.5em;
388
+ }
389
+ ul li ul,
390
+ ul li ol {
391
+ margin-left: 1.25em;
392
+ margin-bottom: 0;
393
+ }
394
+ ul.circle {
395
+ list-style-type: circle;
396
+ }
397
+ ul.disc {
398
+ list-style-type: disc;
399
+ }
400
+ ul.square {
401
+ list-style-type: square;
402
+ }
403
+ ul.circle ul:not([class]),
404
+ ul.disc ul:not([class]),
405
+ ul.square ul:not([class]) {
406
+ list-style: inherit;
407
+ }
408
+ ol li ul,
409
+ ol li ol {
410
+ margin-left: 1.25em;
411
+ margin-bottom: 0;
412
+ }
413
+ dl dt {
414
+ margin-bottom: 0.3125em;
415
+ font-weight: bold;
416
+ }
417
+ dl dd {
418
+ margin-bottom: 1.25em;
419
+ }
420
+ blockquote {
421
+ margin: 0 0 1.25em;
422
+ padding: 0.5625em 1.25em 0 1.1875em;
423
+ border-left: 1px solid #ddd;
424
+ }
425
+ blockquote,
426
+ blockquote p {
427
+ line-height: 1.6;
428
+ color: rgba(0, 0, 0, 0.85);
429
+ }
430
+ @media screen and (min-width: 768px) {
431
+ h1,
432
+ h2,
433
+ h3,
434
+ #toctitle,
435
+ .sidebarblock > .content > .title,
436
+ h4,
437
+ h5,
438
+ h6 {
439
+ line-height: 1.2;
440
+ }
441
+ h1 {
442
+ font-size: 2.75em;
443
+ }
444
+ h2 {
445
+ font-size: 2.3125em;
446
+ }
447
+ h3,
448
+ #toctitle,
449
+ .sidebarblock > .content > .title {
450
+ font-size: 1.6875em;
451
+ }
452
+ h4 {
453
+ font-size: 1.4375em;
454
+ }
455
+ }
456
+ table {
457
+ background: #fff;
458
+ margin-bottom: 1.25em;
459
+ border: 1px solid #dedede;
460
+ word-wrap: normal;
461
+ }
462
+ table thead,
463
+ table tfoot {
464
+ background: #f7f8f7;
465
+ }
466
+ table thead tr th,
467
+ table thead tr td,
468
+ table tfoot tr th,
469
+ table tfoot tr td {
470
+ padding: 0.5em 0.625em 0.625em;
471
+ font-size: inherit;
472
+ color: rgba(0, 0, 0, 0.8);
473
+ text-align: left;
474
+ }
475
+ table tr th,
476
+ table tr td {
477
+ padding: 0.5625em 0.625em;
478
+ font-size: inherit;
479
+ color: rgba(0, 0, 0, 0.8);
480
+ }
481
+ table tr.even,
482
+ table tr.alt {
483
+ background: #f8f8f7;
484
+ }
485
+ table thead tr th,
486
+ table tfoot tr th,
487
+ table tbody tr td,
488
+ table tr td,
489
+ table tfoot tr td {
490
+ line-height: 1.6;
491
+ }
492
+ h1,
493
+ h2,
494
+ h3,
495
+ #toctitle,
496
+ .sidebarblock > .content > .title,
497
+ h4,
498
+ h5,
499
+ h6 {
500
+ line-height: 1.2;
501
+ word-spacing: -0.05em;
502
+ }
503
+ h1 strong,
504
+ h2 strong,
505
+ h3 strong,
506
+ #toctitle strong,
507
+ .sidebarblock > .content > .title strong,
508
+ h4 strong,
509
+ h5 strong,
510
+ h6 strong {
511
+ font-weight: 400;
512
+ }
513
+ .center {
514
+ margin-left: auto;
515
+ margin-right: auto;
516
+ }
517
+ .stretch {
518
+ width: 100%;
519
+ }
520
+ .clearfix::before,
521
+ .clearfix::after,
522
+ .float-group::before,
523
+ .float-group::after {
524
+ content: ' ';
525
+ display: table;
526
+ }
527
+ .clearfix::after,
528
+ .float-group::after {
529
+ clear: both;
530
+ }
531
+ :not(pre).nobreak {
532
+ word-wrap: normal;
533
+ }
534
+ :not(pre).nowrap {
535
+ white-space: nowrap;
536
+ }
537
+ :not(pre).pre-wrap {
538
+ white-space: pre-wrap;
539
+ }
540
+ :not(pre):not([class^='L']) > code {
541
+ font-size: 0.9375em;
542
+ font-style: normal !important;
543
+ letter-spacing: 0;
544
+ padding: 0.1em 0.5ex;
545
+ word-spacing: -0.15em;
546
+ background: #f7f7f8;
547
+ border-radius: 4px;
548
+ line-height: 1.45;
549
+ text-rendering: optimizeSpeed;
550
+ }
551
+ pre {
552
+ color: rgba(0, 0, 0, 0.9);
553
+ font-family: 'Droid Sans Mono', 'DejaVu Sans Mono', monospace;
554
+ line-height: 1.45;
555
+ text-rendering: optimizeSpeed;
556
+ }
557
+ pre code,
558
+ pre pre {
559
+ color: inherit;
560
+ font-size: inherit;
561
+ line-height: inherit;
562
+ }
563
+ pre > code {
564
+ display: block;
565
+ }
566
+ pre.nowrap,
567
+ pre.nowrap pre {
568
+ white-space: pre;
569
+ word-wrap: normal;
570
+ }
571
+ em em {
572
+ font-style: normal;
573
+ }
574
+ strong strong {
575
+ font-weight: 400;
576
+ }
577
+ .keyseq {
578
+ color: rgba(51, 51, 51, 0.8);
579
+ }
580
+ kbd {
581
+ font-family: 'Droid Sans Mono', 'DejaVu Sans Mono', monospace;
582
+ display: inline-block;
583
+ color: rgba(0, 0, 0, 0.8);
584
+ font-size: 0.65em;
585
+ line-height: 1.45;
586
+ background: #f7f7f7;
587
+ border: 1px solid #ccc;
588
+ border-radius: 3px;
589
+ box-shadow:
590
+ 0 1px 0 rgba(0, 0, 0, 0.2),
591
+ inset 0 0 0 0.1em #fff;
592
+ margin: 0 0.15em;
593
+ padding: 0.2em 0.5em;
594
+ vertical-align: middle;
595
+ position: relative;
596
+ top: -0.1em;
597
+ white-space: nowrap;
598
+ }
599
+ .keyseq kbd:first-child {
600
+ margin-left: 0;
601
+ }
602
+ .keyseq kbd:last-child {
603
+ margin-right: 0;
604
+ }
605
+ .menuseq,
606
+ .menuref {
607
+ color: #000;
608
+ }
609
+ .menuseq b:not(.caret),
610
+ .menuref {
611
+ font-weight: inherit;
612
+ }
613
+ .menuseq {
614
+ word-spacing: -0.02em;
615
+ }
616
+ .menuseq b.caret {
617
+ font-size: 1.25em;
618
+ line-height: 0.8;
619
+ }
620
+ .menuseq i.caret {
621
+ font-weight: bold;
622
+ text-align: center;
623
+ width: 0.45em;
624
+ }
625
+ b.button::before,
626
+ b.button::after {
627
+ position: relative;
628
+ top: -1px;
629
+ font-weight: 400;
630
+ }
631
+ b.button::before {
632
+ content: '[';
633
+ padding: 0 3px 0 2px;
634
+ }
635
+ b.button::after {
636
+ content: ']';
637
+ padding: 0 2px 0 3px;
638
+ }
639
+ p a > code:hover {
640
+ color: rgba(0, 0, 0, 0.9);
641
+ }
642
+ #header,
643
+ #content,
644
+ #footnotes,
645
+ #footer {
646
+ width: 100%;
647
+ margin: 0 auto;
648
+ max-width: 62.5em;
649
+ *zoom: 1;
650
+ position: relative;
651
+ padding-left: 0.9375em;
652
+ padding-right: 0.9375em;
653
+ }
654
+ #header::before,
655
+ #header::after,
656
+ #content::before,
657
+ #content::after,
658
+ #footnotes::before,
659
+ #footnotes::after,
660
+ #footer::before,
661
+ #footer::after {
662
+ content: ' ';
663
+ display: table;
664
+ }
665
+ #header::after,
666
+ #content::after,
667
+ #footnotes::after,
668
+ #footer::after {
669
+ clear: both;
670
+ }
671
+ #content {
672
+ margin-top: 1.25em;
673
+ }
674
+ #content::before {
675
+ content: none;
676
+ }
677
+ #header > h1:first-child {
678
+ color: rgba(0, 0, 0, 0.85);
679
+ margin-top: 2.25rem;
680
+ margin-bottom: 0;
681
+ }
682
+ #header > h1:first-child + #toc {
683
+ margin-top: 8px;
684
+ border-top: 1px solid #dddddf;
685
+ }
686
+ #header > h1:only-child,
687
+ body.toc2 #header > h1:nth-last-child(2) {
688
+ border-bottom: 1px solid #dddddf;
689
+ padding-bottom: 8px;
690
+ }
691
+ #header .details {
692
+ border-bottom: 1px solid #dddddf;
693
+ line-height: 1.45;
694
+ padding-top: 0.25em;
695
+ padding-bottom: 0.25em;
696
+ padding-left: 0.25em;
697
+ color: rgba(0, 0, 0, 0.6);
698
+ display: flex;
699
+ flex-flow: row wrap;
700
+ }
701
+ #header .details span:first-child {
702
+ margin-left: -0.125em;
703
+ }
704
+ #header .details span.email a {
705
+ color: rgba(0, 0, 0, 0.85);
706
+ }
707
+ #header .details br {
708
+ display: none;
709
+ }
710
+ #header .details br + span::before {
711
+ content: '\00a0\2013\00a0';
712
+ }
713
+ #header .details br + span.author::before {
714
+ content: '\00a0\22c5\00a0';
715
+ color: rgba(0, 0, 0, 0.85);
716
+ }
717
+ #header .details br + span#revremark::before {
718
+ content: '\00a0|\00a0';
719
+ }
720
+ #header #revnumber {
721
+ text-transform: capitalize;
722
+ }
723
+ #header #revnumber::after {
724
+ content: '\00a0';
725
+ }
726
+ #content > h1:first-child:not([class]) {
727
+ color: rgba(0, 0, 0, 0.85);
728
+ border-bottom: 1px solid #dddddf;
729
+ padding-bottom: 8px;
730
+ margin-top: 0;
731
+ padding-top: 1rem;
732
+ margin-bottom: 1.25rem;
733
+ }
734
+ #toc {
735
+ border-bottom: 1px solid #e7e7e9;
736
+ padding-bottom: 0.5em;
737
+ }
738
+ #toc > ul {
739
+ margin-left: 0.125em;
740
+ }
741
+ #toc ul.sectlevel0 > li > a {
742
+ font-style: italic;
743
+ }
744
+ #toc ul.sectlevel0 ul.sectlevel1 {
745
+ margin: 0.5em 0;
746
+ }
747
+ #toc ul {
748
+ font-family: 'Open Sans', 'DejaVu Sans', sans-serif;
749
+ list-style-type: none;
750
+ }
751
+ #toc li {
752
+ line-height: 1.3334;
753
+ margin-top: 0.3334em;
754
+ }
755
+ #toc a {
756
+ text-decoration: none;
757
+ }
758
+ #toc a:active {
759
+ text-decoration: underline;
760
+ }
761
+ #toctitle {
762
+ color: #7a2518;
763
+ font-size: 1.2em;
764
+ }
765
+ @media screen and (min-width: 768px) {
766
+ #toctitle {
767
+ font-size: 1.375em;
768
+ }
769
+ body.toc2 {
770
+ padding-left: 15em;
771
+ padding-right: 0;
772
+ }
773
+ #toc.toc2 {
774
+ margin-top: 0 !important;
775
+ background: #f8f8f7;
776
+ position: fixed;
777
+ width: 15em;
778
+ left: 0;
779
+ top: 0;
780
+ border-right: 1px solid #e7e7e9;
781
+ border-top-width: 0 !important;
782
+ border-bottom-width: 0 !important;
783
+ z-index: 1000;
784
+ padding: 1.25em 1em;
785
+ height: 100%;
786
+ overflow: auto;
787
+ }
788
+ #toc.toc2 #toctitle {
789
+ margin-top: 0;
790
+ margin-bottom: 0.8rem;
791
+ font-size: 1.2em;
792
+ }
793
+ #toc.toc2 > ul {
794
+ font-size: 0.9em;
795
+ margin-bottom: 0;
796
+ }
797
+ #toc.toc2 ul ul {
798
+ margin-left: 0;
799
+ padding-left: 1em;
800
+ }
801
+ #toc.toc2 ul.sectlevel0 ul.sectlevel1 {
802
+ padding-left: 0;
803
+ margin-top: 0.5em;
804
+ margin-bottom: 0.5em;
805
+ }
806
+ body.toc2.toc-right {
807
+ padding-left: 0;
808
+ padding-right: 15em;
809
+ }
810
+ body.toc2.toc-right #toc.toc2 {
811
+ border-right-width: 0;
812
+ border-left: 1px solid #e7e7e9;
813
+ left: auto;
814
+ right: 0;
815
+ }
816
+ }
817
+ @media screen and (min-width: 1280px) {
818
+ body.toc2 {
819
+ padding-left: 20em;
820
+ padding-right: 0;
821
+ }
822
+ #toc.toc2 {
823
+ width: 20em;
824
+ }
825
+ #toc.toc2 #toctitle {
826
+ font-size: 1.375em;
827
+ }
828
+ #toc.toc2 > ul {
829
+ font-size: 0.95em;
830
+ }
831
+ #toc.toc2 ul ul {
832
+ padding-left: 1.25em;
833
+ }
834
+ body.toc2.toc-right {
835
+ padding-left: 0;
836
+ padding-right: 20em;
837
+ }
838
+ }
839
+ #content #toc {
840
+ border: 1px solid #e0e0dc;
841
+ margin-bottom: 1.25em;
842
+ padding: 1.25em;
843
+ background: #f8f8f7;
844
+ border-radius: 4px;
845
+ }
846
+ #content #toc > :first-child {
847
+ margin-top: 0;
848
+ }
849
+ #content #toc > :last-child {
850
+ margin-bottom: 0;
851
+ }
852
+ #footer {
853
+ max-width: none;
854
+ background: rgba(0, 0, 0, 0.8);
855
+ padding: 1.25em;
856
+ }
857
+ #footer-text {
858
+ color: hsla(0, 0%, 100%, 0.8);
859
+ line-height: 1.44;
860
+ }
861
+ #content {
862
+ margin-bottom: 0.625em;
863
+ }
864
+ .sect1 {
865
+ padding-bottom: 0.625em;
866
+ }
867
+ @media screen and (min-width: 768px) {
868
+ #content {
869
+ margin-bottom: 1.25em;
870
+ }
871
+ .sect1 {
872
+ padding-bottom: 1.25em;
873
+ }
874
+ }
875
+ .sect1:last-child {
876
+ padding-bottom: 0;
877
+ }
878
+ .sect1 + .sect1 {
879
+ border-top: 1px solid #e7e7e9;
880
+ }
881
+ #content h1 > a.anchor,
882
+ h2 > a.anchor,
883
+ h3 > a.anchor,
884
+ #toctitle > a.anchor,
885
+ .sidebarblock > .content > .title > a.anchor,
886
+ h4 > a.anchor,
887
+ h5 > a.anchor,
888
+ h6 > a.anchor {
889
+ position: absolute;
890
+ z-index: 1001;
891
+ width: 1.5ex;
892
+ margin-left: -1.5ex;
893
+ display: block;
894
+ text-decoration: none !important;
895
+ visibility: hidden;
896
+ text-align: center;
897
+ font-weight: 400;
898
+ }
899
+ #content h1 > a.anchor::before,
900
+ h2 > a.anchor::before,
901
+ h3 > a.anchor::before,
902
+ #toctitle > a.anchor::before,
903
+ .sidebarblock > .content > .title > a.anchor::before,
904
+ h4 > a.anchor::before,
905
+ h5 > a.anchor::before,
906
+ h6 > a.anchor::before {
907
+ content: '\00A7';
908
+ font-size: 0.85em;
909
+ display: block;
910
+ padding-top: 0.1em;
911
+ }
912
+ #content h1:hover > a.anchor,
913
+ #content h1 > a.anchor:hover,
914
+ h2:hover > a.anchor,
915
+ h2 > a.anchor:hover,
916
+ h3:hover > a.anchor,
917
+ #toctitle:hover > a.anchor,
918
+ .sidebarblock > .content > .title:hover > a.anchor,
919
+ h3 > a.anchor:hover,
920
+ #toctitle > a.anchor:hover,
921
+ .sidebarblock > .content > .title > a.anchor:hover,
922
+ h4:hover > a.anchor,
923
+ h4 > a.anchor:hover,
924
+ h5:hover > a.anchor,
925
+ h5 > a.anchor:hover,
926
+ h6:hover > a.anchor,
927
+ h6 > a.anchor:hover {
928
+ visibility: visible;
929
+ }
930
+ #content h1 > a.link,
931
+ h2 > a.link,
932
+ h3 > a.link,
933
+ #toctitle > a.link,
934
+ .sidebarblock > .content > .title > a.link,
935
+ h4 > a.link,
936
+ h5 > a.link,
937
+ h6 > a.link {
938
+ color: #ba3925;
939
+ text-decoration: none;
940
+ }
941
+ #content h1 > a.link:hover,
942
+ h2 > a.link:hover,
943
+ h3 > a.link:hover,
944
+ #toctitle > a.link:hover,
945
+ .sidebarblock > .content > .title > a.link:hover,
946
+ h4 > a.link:hover,
947
+ h5 > a.link:hover,
948
+ h6 > a.link:hover {
949
+ color: #a53221;
950
+ }
951
+ details,
952
+ .audioblock,
953
+ .imageblock,
954
+ .literalblock,
955
+ .listingblock,
956
+ .stemblock,
957
+ .videoblock {
958
+ margin-bottom: 1.25em;
959
+ }
960
+ details {
961
+ margin-left: 1.25rem;
962
+ }
963
+ details > summary {
964
+ cursor: pointer;
965
+ display: block;
966
+ position: relative;
967
+ line-height: 1.6;
968
+ margin-bottom: 0.625rem;
969
+ outline: none;
970
+ -webkit-tap-highlight-color: transparent;
971
+ }
972
+ details > summary::-webkit-details-marker {
973
+ display: none;
974
+ }
975
+ details > summary::before {
976
+ content: '';
977
+ border: solid transparent;
978
+ border-left: solid;
979
+ border-width: 0.3em 0 0.3em 0.5em;
980
+ position: absolute;
981
+ top: 0.5em;
982
+ left: -1.25rem;
983
+ transform: translateX(15%);
984
+ }
985
+ details[open] > summary::before {
986
+ border: solid transparent;
987
+ border-top: solid;
988
+ border-width: 0.5em 0.3em 0;
989
+ transform: translateY(15%);
990
+ }
991
+ details > summary::after {
992
+ content: '';
993
+ width: 1.25rem;
994
+ height: 1em;
995
+ position: absolute;
996
+ top: 0.3em;
997
+ left: -1.25rem;
998
+ }
999
+ .admonitionblock td.content > .title,
1000
+ .audioblock > .title,
1001
+ .exampleblock > .title,
1002
+ .imageblock > .title,
1003
+ .listingblock > .title,
1004
+ .literalblock > .title,
1005
+ .stemblock > .title,
1006
+ .openblock > .title,
1007
+ .paragraph > .title,
1008
+ .quoteblock > .title,
1009
+ table.tableblock > .title,
1010
+ .verseblock > .title,
1011
+ .videoblock > .title,
1012
+ .dlist > .title,
1013
+ .olist > .title,
1014
+ .ulist > .title,
1015
+ .qlist > .title,
1016
+ .hdlist > .title {
1017
+ text-rendering: optimizeLegibility;
1018
+ text-align: left;
1019
+ font-family: 'Noto Serif', 'DejaVu Serif', serif;
1020
+ font-size: 1rem;
1021
+ font-style: italic;
1022
+ }
1023
+ table.tableblock.fit-content > caption.title {
1024
+ white-space: nowrap;
1025
+ width: 0;
1026
+ }
1027
+ .paragraph.lead > p,
1028
+ #preamble > .sectionbody > [class='paragraph']:first-of-type p {
1029
+ font-size: 1.21875em;
1030
+ line-height: 1.6;
1031
+ color: rgba(0, 0, 0, 0.85);
1032
+ }
1033
+ .admonitionblock > table {
1034
+ border-collapse: separate;
1035
+ border: 0;
1036
+ background: none;
1037
+ width: 100%;
1038
+ }
1039
+ .admonitionblock > table td.icon {
1040
+ text-align: center;
1041
+ width: 80px;
1042
+ }
1043
+ .admonitionblock > table td.icon img {
1044
+ max-width: none;
1045
+ }
1046
+ .admonitionblock > table td.icon .title {
1047
+ font-weight: bold;
1048
+ font-family: 'Open Sans', 'DejaVu Sans', sans-serif;
1049
+ text-transform: uppercase;
1050
+ }
1051
+ .admonitionblock > table td.content {
1052
+ padding-left: 1.125em;
1053
+ padding-right: 1.25em;
1054
+ border-left: 1px solid #dddddf;
1055
+ color: rgba(0, 0, 0, 0.6);
1056
+ word-wrap: anywhere;
1057
+ }
1058
+ .admonitionblock > table td.content > :last-child > :last-child {
1059
+ margin-bottom: 0;
1060
+ }
1061
+ .exampleblock > .content {
1062
+ border: 1px solid #e6e6e6;
1063
+ margin-bottom: 1.25em;
1064
+ padding: 1.25em;
1065
+ background: #fff;
1066
+ border-radius: 4px;
1067
+ }
1068
+ .sidebarblock {
1069
+ border: 1px solid #dbdbd6;
1070
+ margin-bottom: 1.25em;
1071
+ padding: 1.25em;
1072
+ background: #f3f3f2;
1073
+ border-radius: 4px;
1074
+ }
1075
+ .sidebarblock > .content > .title {
1076
+ color: #7a2518;
1077
+ margin-top: 0;
1078
+ text-align: center;
1079
+ }
1080
+ .exampleblock > .content > :first-child,
1081
+ .sidebarblock > .content > :first-child {
1082
+ margin-top: 0;
1083
+ }
1084
+ .exampleblock > .content > :last-child,
1085
+ .exampleblock > .content > :last-child > :last-child,
1086
+ .exampleblock > .content .olist > ol > li:last-child > :last-child,
1087
+ .exampleblock > .content .ulist > ul > li:last-child > :last-child,
1088
+ .exampleblock > .content .qlist > ol > li:last-child > :last-child,
1089
+ .sidebarblock > .content > :last-child,
1090
+ .sidebarblock > .content > :last-child > :last-child,
1091
+ .sidebarblock > .content .olist > ol > li:last-child > :last-child,
1092
+ .sidebarblock > .content .ulist > ul > li:last-child > :last-child,
1093
+ .sidebarblock > .content .qlist > ol > li:last-child > :last-child {
1094
+ margin-bottom: 0;
1095
+ }
1096
+ .literalblock pre,
1097
+ .listingblock > .content > pre {
1098
+ border-radius: 4px;
1099
+ overflow-x: auto;
1100
+ padding: 1em;
1101
+ font-size: 0.8125em;
1102
+ }
1103
+ @media screen and (min-width: 768px) {
1104
+ .literalblock pre,
1105
+ .listingblock > .content > pre {
1106
+ font-size: 0.90625em;
1107
+ }
1108
+ }
1109
+ @media screen and (min-width: 1280px) {
1110
+ .literalblock pre,
1111
+ .listingblock > .content > pre {
1112
+ font-size: 1em;
1113
+ }
1114
+ }
1115
+ .literalblock pre,
1116
+ .listingblock > .content > pre:not(.highlight),
1117
+ .listingblock > .content > pre[class='highlight'],
1118
+ .listingblock > .content > pre[class^='highlight '] {
1119
+ background: #f7f7f8;
1120
+ }
1121
+ .literalblock.output pre {
1122
+ color: #f7f7f8;
1123
+ background: rgba(0, 0, 0, 0.9);
1124
+ }
1125
+ .listingblock > .content {
1126
+ position: relative;
1127
+ }
1128
+ .listingblock code[data-lang]::before {
1129
+ display: none;
1130
+ content: attr(data-lang);
1131
+ position: absolute;
1132
+ font-size: 0.75em;
1133
+ top: 0.425rem;
1134
+ right: 0.5rem;
1135
+ line-height: 1;
1136
+ text-transform: uppercase;
1137
+ color: inherit;
1138
+ opacity: 0.5;
1139
+ }
1140
+ .listingblock:hover code[data-lang]::before {
1141
+ display: block;
1142
+ }
1143
+ .listingblock.terminal pre .command::before {
1144
+ content: attr(data-prompt);
1145
+ padding-right: 0.5em;
1146
+ color: inherit;
1147
+ opacity: 0.5;
1148
+ }
1149
+ .listingblock.terminal pre .command:not([data-prompt])::before {
1150
+ content: '$';
1151
+ }
1152
+ .listingblock pre.highlightjs {
1153
+ padding: 0;
1154
+ }
1155
+ .listingblock pre.highlightjs > code {
1156
+ padding: 1em;
1157
+ border-radius: 4px;
1158
+ }
1159
+ .listingblock pre.prettyprint {
1160
+ border-width: 0;
1161
+ }
1162
+ .prettyprint {
1163
+ background: #f7f7f8;
1164
+ }
1165
+ pre.prettyprint .linenums {
1166
+ line-height: 1.45;
1167
+ margin-left: 2em;
1168
+ }
1169
+ pre.prettyprint li {
1170
+ background: none;
1171
+ list-style-type: inherit;
1172
+ padding-left: 0;
1173
+ }
1174
+ pre.prettyprint li code[data-lang]::before {
1175
+ opacity: 1;
1176
+ }
1177
+ pre.prettyprint li:not(:first-child) code[data-lang]::before {
1178
+ display: none;
1179
+ }
1180
+ table.linenotable {
1181
+ border-collapse: separate;
1182
+ border: 0;
1183
+ margin-bottom: 0;
1184
+ background: none;
1185
+ }
1186
+ table.linenotable td[class] {
1187
+ color: inherit;
1188
+ vertical-align: top;
1189
+ padding: 0;
1190
+ line-height: inherit;
1191
+ white-space: normal;
1192
+ }
1193
+ table.linenotable td.code {
1194
+ padding-left: 0.75em;
1195
+ }
1196
+ table.linenotable td.linenos,
1197
+ pre.pygments .linenos {
1198
+ border-right: 1px solid;
1199
+ opacity: 0.35;
1200
+ padding-right: 0.5em;
1201
+ -webkit-user-select: none;
1202
+ -moz-user-select: none;
1203
+ -ms-user-select: none;
1204
+ user-select: none;
1205
+ }
1206
+ pre.pygments span.linenos {
1207
+ display: inline-block;
1208
+ margin-right: 0.75em;
1209
+ }
1210
+ .quoteblock {
1211
+ margin: 0 1em 1.25em 1.5em;
1212
+ display: table;
1213
+ }
1214
+ .quoteblock:not(.excerpt) > .title {
1215
+ margin-left: -1.5em;
1216
+ margin-bottom: 0.75em;
1217
+ }
1218
+ .quoteblock blockquote,
1219
+ .quoteblock p {
1220
+ color: rgba(0, 0, 0, 0.85);
1221
+ font-size: 1.15rem;
1222
+ line-height: 1.75;
1223
+ word-spacing: 0.1em;
1224
+ letter-spacing: 0;
1225
+ font-style: italic;
1226
+ text-align: justify;
1227
+ }
1228
+ .quoteblock blockquote {
1229
+ margin: 0;
1230
+ padding: 0;
1231
+ border: 0;
1232
+ }
1233
+ .quoteblock blockquote::before {
1234
+ content: '\201c';
1235
+ float: left;
1236
+ font-size: 2.75em;
1237
+ font-weight: bold;
1238
+ line-height: 0.6em;
1239
+ margin-left: -0.6em;
1240
+ color: #7a2518;
1241
+ text-shadow: 0 1px 2px rgba(0, 0, 0, 0.1);
1242
+ }
1243
+ .quoteblock blockquote > .paragraph:last-child p {
1244
+ margin-bottom: 0;
1245
+ }
1246
+ .quoteblock .attribution {
1247
+ margin-top: 0.75em;
1248
+ margin-right: 0.5ex;
1249
+ text-align: right;
1250
+ }
1251
+ .verseblock {
1252
+ margin: 0 1em 1.25em;
1253
+ }
1254
+ .verseblock pre {
1255
+ font-family: 'Open Sans', 'DejaVu Sans', sans-serif;
1256
+ font-size: 1.15rem;
1257
+ color: rgba(0, 0, 0, 0.85);
1258
+ font-weight: 300;
1259
+ text-rendering: optimizeLegibility;
1260
+ }
1261
+ .verseblock pre strong {
1262
+ font-weight: 400;
1263
+ }
1264
+ .verseblock .attribution {
1265
+ margin-top: 1.25rem;
1266
+ margin-left: 0.5ex;
1267
+ }
1268
+ .quoteblock .attribution,
1269
+ .verseblock .attribution {
1270
+ font-size: 0.9375em;
1271
+ line-height: 1.45;
1272
+ font-style: italic;
1273
+ }
1274
+ .quoteblock .attribution br,
1275
+ .verseblock .attribution br {
1276
+ display: none;
1277
+ }
1278
+ .quoteblock .attribution cite,
1279
+ .verseblock .attribution cite {
1280
+ display: block;
1281
+ letter-spacing: -0.025em;
1282
+ color: rgba(0, 0, 0, 0.6);
1283
+ }
1284
+ .quoteblock.abstract blockquote::before,
1285
+ .quoteblock.excerpt blockquote::before,
1286
+ .quoteblock .quoteblock blockquote::before {
1287
+ display: none;
1288
+ }
1289
+ .quoteblock.abstract blockquote,
1290
+ .quoteblock.abstract p,
1291
+ .quoteblock.excerpt blockquote,
1292
+ .quoteblock.excerpt p,
1293
+ .quoteblock .quoteblock blockquote,
1294
+ .quoteblock .quoteblock p {
1295
+ line-height: 1.6;
1296
+ word-spacing: 0;
1297
+ }
1298
+ .quoteblock.abstract {
1299
+ margin: 0 1em 1.25em;
1300
+ display: block;
1301
+ }
1302
+ .quoteblock.abstract > .title {
1303
+ margin: 0 0 0.375em;
1304
+ font-size: 1.15em;
1305
+ text-align: center;
1306
+ }
1307
+ .quoteblock.excerpt > blockquote,
1308
+ .quoteblock .quoteblock {
1309
+ padding: 0 0 0.25em 1em;
1310
+ border-left: 0.25em solid #dddddf;
1311
+ }
1312
+ .quoteblock.excerpt,
1313
+ .quoteblock .quoteblock {
1314
+ margin-left: 0;
1315
+ }
1316
+ .quoteblock.excerpt blockquote,
1317
+ .quoteblock.excerpt p,
1318
+ .quoteblock .quoteblock blockquote,
1319
+ .quoteblock .quoteblock p {
1320
+ color: inherit;
1321
+ font-size: 1.0625rem;
1322
+ }
1323
+ .quoteblock.excerpt .attribution,
1324
+ .quoteblock .quoteblock .attribution {
1325
+ color: inherit;
1326
+ font-size: 0.85rem;
1327
+ text-align: left;
1328
+ margin-right: 0;
1329
+ }
1330
+ p.tableblock:last-child {
1331
+ margin-bottom: 0;
1332
+ }
1333
+ td.tableblock > .content {
1334
+ margin-bottom: 1.25em;
1335
+ word-wrap: anywhere;
1336
+ }
1337
+ td.tableblock > .content > :last-child {
1338
+ margin-bottom: -1.25em;
1339
+ }
1340
+ table.tableblock,
1341
+ th.tableblock,
1342
+ td.tableblock {
1343
+ border: 0 solid #dedede;
1344
+ }
1345
+ table.grid-all > * > tr > * {
1346
+ border-width: 1px;
1347
+ }
1348
+ table.grid-cols > * > tr > * {
1349
+ border-width: 0 1px;
1350
+ }
1351
+ table.grid-rows > * > tr > * {
1352
+ border-width: 1px 0;
1353
+ }
1354
+ table.frame-all {
1355
+ border-width: 1px;
1356
+ }
1357
+ table.frame-ends {
1358
+ border-width: 1px 0;
1359
+ }
1360
+ table.frame-sides {
1361
+ border-width: 0 1px;
1362
+ }
1363
+ table.frame-none > colgroup + * > :first-child > *,
1364
+ table.frame-sides > colgroup + * > :first-child > * {
1365
+ border-top-width: 0;
1366
+ }
1367
+ table.frame-none > :last-child > :last-child > *,
1368
+ table.frame-sides > :last-child > :last-child > * {
1369
+ border-bottom-width: 0;
1370
+ }
1371
+ table.frame-none > * > tr > :first-child,
1372
+ table.frame-ends > * > tr > :first-child {
1373
+ border-left-width: 0;
1374
+ }
1375
+ table.frame-none > * > tr > :last-child,
1376
+ table.frame-ends > * > tr > :last-child {
1377
+ border-right-width: 0;
1378
+ }
1379
+ table.stripes-all > * > tr,
1380
+ table.stripes-odd > * > tr:nth-of-type(odd),
1381
+ table.stripes-even > * > tr:nth-of-type(even),
1382
+ table.stripes-hover > * > tr:hover {
1383
+ background: #f8f8f7;
1384
+ }
1385
+ th.halign-left,
1386
+ td.halign-left {
1387
+ text-align: left;
1388
+ }
1389
+ th.halign-right,
1390
+ td.halign-right {
1391
+ text-align: right;
1392
+ }
1393
+ th.halign-center,
1394
+ td.halign-center {
1395
+ text-align: center;
1396
+ }
1397
+ th.valign-top,
1398
+ td.valign-top {
1399
+ vertical-align: top;
1400
+ }
1401
+ th.valign-bottom,
1402
+ td.valign-bottom {
1403
+ vertical-align: bottom;
1404
+ }
1405
+ th.valign-middle,
1406
+ td.valign-middle {
1407
+ vertical-align: middle;
1408
+ }
1409
+ table thead th,
1410
+ table tfoot th {
1411
+ font-weight: bold;
1412
+ }
1413
+ tbody tr th {
1414
+ background: #f7f8f7;
1415
+ }
1416
+ tbody tr th,
1417
+ tbody tr th p,
1418
+ tfoot tr th,
1419
+ tfoot tr th p {
1420
+ color: rgba(0, 0, 0, 0.8);
1421
+ font-weight: bold;
1422
+ }
1423
+ p.tableblock > code:only-child {
1424
+ background: none;
1425
+ padding: 0;
1426
+ }
1427
+ p.tableblock {
1428
+ font-size: 1em;
1429
+ }
1430
+ ol {
1431
+ margin-left: 1.75em;
1432
+ }
1433
+ ul li ol {
1434
+ margin-left: 1.5em;
1435
+ }
1436
+ dl dd {
1437
+ margin-left: 1.125em;
1438
+ }
1439
+ dl dd:last-child,
1440
+ dl dd:last-child > :last-child {
1441
+ margin-bottom: 0;
1442
+ }
1443
+ li p,
1444
+ ul dd,
1445
+ ol dd,
1446
+ .olist .olist,
1447
+ .ulist .ulist,
1448
+ .ulist .olist,
1449
+ .olist .ulist {
1450
+ margin-bottom: 0.625em;
1451
+ }
1452
+ ul.checklist,
1453
+ ul.none,
1454
+ ol.none,
1455
+ ul.no-bullet,
1456
+ ol.no-bullet,
1457
+ ol.unnumbered,
1458
+ ul.unstyled,
1459
+ ol.unstyled {
1460
+ list-style-type: none;
1461
+ }
1462
+ ul.no-bullet,
1463
+ ol.no-bullet,
1464
+ ol.unnumbered {
1465
+ margin-left: 0.625em;
1466
+ }
1467
+ ul.unstyled,
1468
+ ol.unstyled {
1469
+ margin-left: 0;
1470
+ }
1471
+ li > p:empty:only-child::before {
1472
+ content: '';
1473
+ display: inline-block;
1474
+ }
1475
+ ul.checklist > li > p:first-child {
1476
+ margin-left: -1em;
1477
+ }
1478
+ ul.checklist > li > p:first-child > .fa-square-o:first-child,
1479
+ ul.checklist > li > p:first-child > .fa-check-square-o:first-child {
1480
+ width: 1.25em;
1481
+ font-size: 0.8em;
1482
+ position: relative;
1483
+ bottom: 0.125em;
1484
+ }
1485
+ ul.checklist > li > p:first-child > input[type='checkbox']:first-child {
1486
+ margin-right: 0.25em;
1487
+ }
1488
+ ul.inline {
1489
+ display: flex;
1490
+ flex-flow: row wrap;
1491
+ list-style: none;
1492
+ margin: 0 0 0.625em -1.25em;
1493
+ }
1494
+ ul.inline > li {
1495
+ margin-left: 1.25em;
1496
+ }
1497
+ .unstyled dl dt {
1498
+ font-weight: 400;
1499
+ font-style: normal;
1500
+ }
1501
+ ol.arabic {
1502
+ list-style-type: decimal;
1503
+ }
1504
+ ol.decimal {
1505
+ list-style-type: decimal-leading-zero;
1506
+ }
1507
+ ol.loweralpha {
1508
+ list-style-type: lower-alpha;
1509
+ }
1510
+ ol.upperalpha {
1511
+ list-style-type: upper-alpha;
1512
+ }
1513
+ ol.lowerroman {
1514
+ list-style-type: lower-roman;
1515
+ }
1516
+ ol.upperroman {
1517
+ list-style-type: upper-roman;
1518
+ }
1519
+ ol.lowergreek {
1520
+ list-style-type: lower-greek;
1521
+ }
1522
+ .hdlist > table,
1523
+ .colist > table {
1524
+ border: 0;
1525
+ background: none;
1526
+ }
1527
+ .hdlist > table > tbody > tr,
1528
+ .colist > table > tbody > tr {
1529
+ background: none;
1530
+ }
1531
+ td.hdlist1,
1532
+ td.hdlist2 {
1533
+ vertical-align: top;
1534
+ padding: 0 0.625em;
1535
+ }
1536
+ td.hdlist1 {
1537
+ font-weight: bold;
1538
+ padding-bottom: 1.25em;
1539
+ }
1540
+ td.hdlist2 {
1541
+ word-wrap: anywhere;
1542
+ }
1543
+ .literalblock + .colist,
1544
+ .listingblock + .colist {
1545
+ margin-top: -0.5em;
1546
+ }
1547
+ .colist td:not([class]):first-child {
1548
+ padding: 0.4em 0.75em 0;
1549
+ line-height: 1;
1550
+ vertical-align: top;
1551
+ }
1552
+ .colist td:not([class]):first-child img {
1553
+ max-width: none;
1554
+ }
1555
+ .colist td:not([class]):last-child {
1556
+ padding: 0.25em 0;
1557
+ }
1558
+ .thumb,
1559
+ .th {
1560
+ line-height: 0;
1561
+ display: inline-block;
1562
+ border: 4px solid #fff;
1563
+ box-shadow: 0 0 0 1px #ddd;
1564
+ }
1565
+ .imageblock.left {
1566
+ margin: 0.25em 0.625em 1.25em 0;
1567
+ }
1568
+ .imageblock.right {
1569
+ margin: 0.25em 0 1.25em 0.625em;
1570
+ }
1571
+ .imageblock > .title {
1572
+ margin-bottom: 0;
1573
+ }
1574
+ .imageblock.thumb,
1575
+ .imageblock.th {
1576
+ border-width: 6px;
1577
+ }
1578
+ .imageblock.thumb > .title,
1579
+ .imageblock.th > .title {
1580
+ padding: 0 0.125em;
1581
+ }
1582
+ .image.left,
1583
+ .image.right {
1584
+ margin-top: 0.25em;
1585
+ margin-bottom: 0.25em;
1586
+ display: inline-block;
1587
+ line-height: 0;
1588
+ }
1589
+ .image.left {
1590
+ margin-right: 0.625em;
1591
+ }
1592
+ .image.right {
1593
+ margin-left: 0.625em;
1594
+ }
1595
+ a.image {
1596
+ text-decoration: none;
1597
+ display: inline-block;
1598
+ }
1599
+ a.image object {
1600
+ pointer-events: none;
1601
+ }
1602
+ sup.footnote,
1603
+ sup.footnoteref {
1604
+ font-size: 0.875em;
1605
+ position: static;
1606
+ vertical-align: super;
1607
+ }
1608
+ sup.footnote a,
1609
+ sup.footnoteref a {
1610
+ text-decoration: none;
1611
+ }
1612
+ sup.footnote a:active,
1613
+ sup.footnoteref a:active {
1614
+ text-decoration: underline;
1615
+ }
1616
+ #footnotes {
1617
+ padding-top: 0.75em;
1618
+ padding-bottom: 0.75em;
1619
+ margin-bottom: 0.625em;
1620
+ }
1621
+ #footnotes hr {
1622
+ width: 20%;
1623
+ min-width: 6.25em;
1624
+ margin: -0.25em 0 0.75em;
1625
+ border-width: 1px 0 0;
1626
+ }
1627
+ #footnotes .footnote {
1628
+ padding: 0 0.375em 0 0.225em;
1629
+ line-height: 1.3334;
1630
+ font-size: 0.875em;
1631
+ margin-left: 1.2em;
1632
+ margin-bottom: 0.2em;
1633
+ }
1634
+ #footnotes .footnote a:first-of-type {
1635
+ font-weight: bold;
1636
+ text-decoration: none;
1637
+ margin-left: -1.05em;
1638
+ }
1639
+ #footnotes .footnote:last-of-type {
1640
+ margin-bottom: 0;
1641
+ }
1642
+ #content #footnotes {
1643
+ margin-top: -0.625em;
1644
+ margin-bottom: 0;
1645
+ padding: 0.75em 0;
1646
+ }
1647
+ div.unbreakable {
1648
+ page-break-inside: avoid;
1649
+ }
1650
+ .big {
1651
+ font-size: larger;
1652
+ }
1653
+ .small {
1654
+ font-size: smaller;
1655
+ }
1656
+ .underline {
1657
+ text-decoration: underline;
1658
+ }
1659
+ .overline {
1660
+ text-decoration: overline;
1661
+ }
1662
+ .line-through {
1663
+ text-decoration: line-through;
1664
+ }
1665
+ .aqua {
1666
+ color: #00bfbf;
1667
+ }
1668
+ .aqua-background {
1669
+ background: #00fafa;
1670
+ }
1671
+ .black {
1672
+ color: #000;
1673
+ }
1674
+ .black-background {
1675
+ background: #000;
1676
+ }
1677
+ .blue {
1678
+ color: #0000bf;
1679
+ }
1680
+ .blue-background {
1681
+ background: #0000fa;
1682
+ }
1683
+ .fuchsia {
1684
+ color: #bf00bf;
1685
+ }
1686
+ .fuchsia-background {
1687
+ background: #fa00fa;
1688
+ }
1689
+ .gray {
1690
+ color: #606060;
1691
+ }
1692
+ .gray-background {
1693
+ background: #7d7d7d;
1694
+ }
1695
+ .green {
1696
+ color: #006000;
1697
+ }
1698
+ .green-background {
1699
+ background: #007d00;
1700
+ }
1701
+ .lime {
1702
+ color: #00bf00;
1703
+ }
1704
+ .lime-background {
1705
+ background: #00fa00;
1706
+ }
1707
+ .maroon {
1708
+ color: #600000;
1709
+ }
1710
+ .maroon-background {
1711
+ background: #7d0000;
1712
+ }
1713
+ .navy {
1714
+ color: #000060;
1715
+ }
1716
+ .navy-background {
1717
+ background: #00007d;
1718
+ }
1719
+ .olive {
1720
+ color: #606000;
1721
+ }
1722
+ .olive-background {
1723
+ background: #7d7d00;
1724
+ }
1725
+ .purple {
1726
+ color: #600060;
1727
+ }
1728
+ .purple-background {
1729
+ background: #7d007d;
1730
+ }
1731
+ .red {
1732
+ color: #bf0000;
1733
+ }
1734
+ .red-background {
1735
+ background: #fa0000;
1736
+ }
1737
+ .silver {
1738
+ color: #909090;
1739
+ }
1740
+ .silver-background {
1741
+ background: #bcbcbc;
1742
+ }
1743
+ .teal {
1744
+ color: #006060;
1745
+ }
1746
+ .teal-background {
1747
+ background: #007d7d;
1748
+ }
1749
+ .white {
1750
+ color: #bfbfbf;
1751
+ }
1752
+ .white-background {
1753
+ background: #fafafa;
1754
+ }
1755
+ .yellow {
1756
+ color: #bfbf00;
1757
+ }
1758
+ .yellow-background {
1759
+ background: #fafa00;
1760
+ }
1761
+ span.icon > .fa {
1762
+ cursor: default;
1763
+ }
1764
+ a span.icon > .fa {
1765
+ cursor: inherit;
1766
+ }
1767
+ .admonitionblock td.icon [class^='fa icon-'] {
1768
+ font-size: 2.5em;
1769
+ text-shadow: 1px 1px 2px rgba(0, 0, 0, 0.5);
1770
+ cursor: default;
1771
+ }
1772
+ .admonitionblock td.icon .icon-note::before {
1773
+ content: '\f05a';
1774
+ color: #19407c;
1775
+ }
1776
+ .admonitionblock td.icon .icon-tip::before {
1777
+ content: '\f0eb';
1778
+ text-shadow: 1px 1px 2px rgba(155, 155, 0, 0.8);
1779
+ color: #111;
1780
+ }
1781
+ .admonitionblock td.icon .icon-warning::before {
1782
+ content: '\f071';
1783
+ color: #bf6900;
1784
+ }
1785
+ .admonitionblock td.icon .icon-caution::before {
1786
+ content: '\f06d';
1787
+ color: #bf3400;
1788
+ }
1789
+ .admonitionblock td.icon .icon-important::before {
1790
+ content: '\f06a';
1791
+ color: #bf0000;
1792
+ }
1793
+ .conum[data-value] {
1794
+ display: inline-block;
1795
+ color: #fff !important;
1796
+ background: rgba(0, 0, 0, 0.8);
1797
+ border-radius: 50%;
1798
+ text-align: center;
1799
+ font-size: 0.75em;
1800
+ width: 1.67em;
1801
+ height: 1.67em;
1802
+ line-height: 1.67em;
1803
+ font-family: 'Open Sans', 'DejaVu Sans', sans-serif;
1804
+ font-style: normal;
1805
+ font-weight: bold;
1806
+ }
1807
+ .conum[data-value] * {
1808
+ color: #fff !important;
1809
+ }
1810
+ .conum[data-value] + b {
1811
+ display: none;
1812
+ }
1813
+ .conum[data-value]::after {
1814
+ content: attr(data-value);
1815
+ }
1816
+ pre .conum[data-value] {
1817
+ position: relative;
1818
+ top: -0.125em;
1819
+ }
1820
+ b.conum * {
1821
+ color: inherit !important;
1822
+ }
1823
+ .conum:not([data-value]):empty {
1824
+ display: none;
1825
+ }
1826
+ dt,
1827
+ th.tableblock,
1828
+ td.content,
1829
+ div.footnote {
1830
+ text-rendering: optimizeLegibility;
1831
+ }
1832
+ h1,
1833
+ h2,
1834
+ p,
1835
+ td.content,
1836
+ span.alt,
1837
+ summary {
1838
+ letter-spacing: -0.01em;
1839
+ }
1840
+ p strong,
1841
+ td.content strong,
1842
+ div.footnote strong {
1843
+ letter-spacing: -0.005em;
1844
+ }
1845
+ p,
1846
+ blockquote,
1847
+ dt,
1848
+ td.content,
1849
+ td.hdlist1,
1850
+ span.alt,
1851
+ summary {
1852
+ font-size: 1.0625rem;
1853
+ }
1854
+ p {
1855
+ margin-bottom: 1.25rem;
1856
+ }
1857
+ .sidebarblock p,
1858
+ .sidebarblock dt,
1859
+ .sidebarblock td.content,
1860
+ p.tableblock {
1861
+ font-size: 1em;
1862
+ }
1863
+ .exampleblock > .content {
1864
+ background: #fffef7;
1865
+ border-color: #e0e0dc;
1866
+ box-shadow: 0 1px 4px #e0e0dc;
1867
+ }
1868
+ .print-only {
1869
+ display: none !important;
1870
+ }
1871
+ @page {
1872
+ margin: 1.25cm 0.75cm;
1873
+ }
1874
+ @media print {
1875
+ * {
1876
+ box-shadow: none !important;
1877
+ text-shadow: none !important;
1878
+ }
1879
+ html {
1880
+ font-size: 80%;
1881
+ }
1882
+ a {
1883
+ color: inherit !important;
1884
+ text-decoration: underline !important;
1885
+ }
1886
+ a.bare,
1887
+ a[href^='#'],
1888
+ a[href^='mailto:'] {
1889
+ text-decoration: none !important;
1890
+ }
1891
+ a[href^='http:']:not(.bare)::after,
1892
+ a[href^='https:']:not(.bare)::after {
1893
+ content: '(' attr(href) ')';
1894
+ display: inline-block;
1895
+ font-size: 0.875em;
1896
+ padding-left: 0.25em;
1897
+ }
1898
+ abbr[title] {
1899
+ border-bottom: 1px dotted;
1900
+ }
1901
+ abbr[title]::after {
1902
+ content: ' (' attr(title) ')';
1903
+ }
1904
+ pre,
1905
+ blockquote,
1906
+ tr,
1907
+ img,
1908
+ object,
1909
+ svg {
1910
+ page-break-inside: avoid;
1911
+ }
1912
+ thead {
1913
+ display: table-header-group;
1914
+ }
1915
+ svg {
1916
+ max-width: 100%;
1917
+ }
1918
+ p,
1919
+ blockquote,
1920
+ dt,
1921
+ td.content {
1922
+ font-size: 1em;
1923
+ orphans: 3;
1924
+ widows: 3;
1925
+ }
1926
+ h2,
1927
+ h3,
1928
+ #toctitle,
1929
+ .sidebarblock > .content > .title {
1930
+ page-break-after: avoid;
1931
+ }
1932
+ #header,
1933
+ #content,
1934
+ #footnotes,
1935
+ #footer {
1936
+ max-width: none;
1937
+ }
1938
+ #toc,
1939
+ .sidebarblock,
1940
+ .exampleblock > .content {
1941
+ background: none !important;
1942
+ }
1943
+ #toc {
1944
+ border-bottom: 1px solid #dddddf !important;
1945
+ padding-bottom: 0 !important;
1946
+ }
1947
+ body.book #header {
1948
+ text-align: center;
1949
+ }
1950
+ body.book #header > h1:first-child {
1951
+ border: 0 !important;
1952
+ margin: 2.5em 0 1em;
1953
+ }
1954
+ body.book #header .details {
1955
+ border: 0 !important;
1956
+ display: block;
1957
+ padding: 0 !important;
1958
+ }
1959
+ body.book #header .details span:first-child {
1960
+ margin-left: 0 !important;
1961
+ }
1962
+ body.book #header .details br {
1963
+ display: block;
1964
+ }
1965
+ body.book #header .details br + span::before {
1966
+ content: none !important;
1967
+ }
1968
+ body.book #toc {
1969
+ border: 0 !important;
1970
+ text-align: left !important;
1971
+ padding: 0 !important;
1972
+ margin: 0 !important;
1973
+ }
1974
+ body.book #toc,
1975
+ body.book #preamble,
1976
+ body.book h1.sect0,
1977
+ body.book .sect1 > h2 {
1978
+ page-break-before: always;
1979
+ }
1980
+ .listingblock code[data-lang]::before {
1981
+ display: block;
1982
+ }
1983
+ #footer {
1984
+ padding: 0 0.9375em;
1985
+ }
1986
+ .hide-on-print {
1987
+ display: none !important;
1988
+ }
1989
+ .print-only {
1990
+ display: block !important;
1991
+ }
1992
+ .hide-for-print {
1993
+ display: none !important;
1994
+ }
1995
+ .show-for-print {
1996
+ display: inherit !important;
1997
+ }
1998
+ }
1999
+ @media amzn-kf8, print {
2000
+ #header > h1:first-child {
2001
+ margin-top: 1.25rem;
2002
+ }
2003
+ .sect1 {
2004
+ padding: 0 !important;
2005
+ }
2006
+ .sect1 + .sect1 {
2007
+ border: 0;
2008
+ }
2009
+ #footer {
2010
+ background: none;
2011
+ }
2012
+ #footer-text {
2013
+ color: rgba(0, 0, 0, 0.6);
2014
+ font-size: 0.9em;
2015
+ }
2016
+ }
2017
+ @media amzn-kf8 {
2018
+ #header,
2019
+ #content,
2020
+ #footnotes,
2021
+ #footer {
2022
+ padding: 0;
2023
+ }
2024
+ }
2025
+ </style>
2026
+ <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" />
2027
+ <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/styles/github.min.css" />
2028
+ </head>
2029
+ <body class="article toc2 toc-left">
2030
+ <div id="header">
2031
+ <h1>CoordinateHelper Reference</h1>
2032
+ <div class="details"><span id="author" class="author">== Architectural Purpose</span><br /></div>
2033
+ <div id="toc" class="toc2">
2034
+ <div id="toctitle">Table of Contents</div>
2035
+ <ul class="sectlevel1">
2036
+ <li>
2037
+ <a href="#api-reference">1. API Reference</a>
2038
+ <ul class="sectlevel2">
2039
+ <li>
2040
+ <a href="#getrelativecoordinatecoordinate-coordinate-coordinate"
2041
+ >1.1. <code>getRelativeCoordinate(coordinate: Coordinate): Coordinate</code></a
2042
+ >
2043
+ </li>
2044
+ <li>
2045
+ <a href="#getdisplayposxx-number-displaywidth-number-number"
2046
+ >1.2. <code>getDisplayPosX(x: number, displayWidth: number): number</code></a
2047
+ >
2048
+ </li>
2049
+ <li>
2050
+ <a href="#getdisplayposyy-number-displayheight-number-number"
2051
+ >1.3. <code>getDisplayPosY(y: number, displayHeight: number): number</code></a
2052
+ >
2053
+ </li>
2054
+ <li>
2055
+ <a href="#gethudposxx-number-displaywidth-number-number"
2056
+ >1.4. <code>getHudPosX(x: number, displayWidth: number): number</code></a
2057
+ >
2058
+ </li>
2059
+ <li>
2060
+ <a href="#gethudposyy-number-displayheight-number-number"
2061
+ >1.5. <code>getHudPosY(y: number, displayHeight: number): number</code></a
2062
+ >
2063
+ </li>
2064
+ </ul>
2065
+ </li>
2066
+ </ul>
2067
+ </div>
2068
+ </div>
2069
+ <div id="content">
2070
+ <div id="preamble">
2071
+ <div class="sectionbody">
2072
+ <div class="paragraph">
2073
+ <p>
2074
+ The <code>CoordinateHelper</code> acts as the engine&#8217;s translation layer between the different abstract mathematical models
2075
+ (e.g., the logical <code><a href="../modules/GameGrid.html">Game Grid</a></code> or scaling normalized values from 0.0 to 1.0) and
2076
+ the absolute physical layout on screen. It ensures consistency in calculating element sizes dynamically so interfaces remain
2077
+ strictly responsive to the runtime canvas resolution.
2078
+ </p>
2079
+ </div>
2080
+ </div>
2081
+ </div>
2082
+ <div class="sect1">
2083
+ <h2 id="api-reference"><a class="link" href="#api-reference">1. API Reference</a></h2>
2084
+ <div class="sectionbody">
2085
+ <div class="sect2">
2086
+ <h3 id="getrelativecoordinatecoordinate-coordinate-coordinate">
2087
+ <a class="link" href="#getrelativecoordinatecoordinate-coordinate-coordinate"
2088
+ >1.1.
2089
+ <code
2090
+ >getRelativeCoordinate(coordinate: <a href="../types/Coordinate.html">Coordinate</a>):
2091
+ <a href="../types/Coordinate.html">Coordinate</a></code
2092
+ ></a
2093
+ >
2094
+ </h3>
2095
+ <div class="paragraph">
2096
+ <p>Converts a pixel-based coordinate into a normalized relative coordinate (0.0 to 1.0).</p>
2097
+ </div>
2098
+ <div class="paragraph">
2099
+ <p><strong>Parameters</strong></p>
2100
+ </div>
2101
+ <table class="tableblock frame-all grid-all stretch">
2102
+ <colgroup>
2103
+ <col style="width: 20%" />
2104
+ <col style="width: 20%" />
2105
+ <col style="width: 60%" />
2106
+ </colgroup>
2107
+ <tbody>
2108
+ <tr>
2109
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
2110
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
2111
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
2112
+ </tr>
2113
+ <tr>
2114
+ <td class="tableblock halign-left valign-top">
2115
+ <p class="tableblock"><code>coordinate</code></p>
2116
+ </td>
2117
+ <td class="tableblock halign-left valign-top">
2118
+ <p class="tableblock"><a href="../types/Coordinate.html">Coordinate</a></p>
2119
+ </td>
2120
+ <td class="tableblock halign-left valign-top"><p class="tableblock">The absolute pixel coordinate.</p></td>
2121
+ </tr>
2122
+ </tbody>
2123
+ </table>
2124
+ <div class="paragraph">
2125
+ <p><strong>Returns</strong></p>
2126
+ </div>
2127
+ <div class="paragraph">
2128
+ <p>
2129
+ <code><a href="../types/Coordinate.html">Coordinate</a></code> - The new coordinate structure scaled proportionately to the
2130
+ physical base canvas width/height.
2131
+ </p>
2132
+ </div>
2133
+ <hr />
2134
+ </div>
2135
+ <div class="sect2">
2136
+ <h3 id="getdisplayposxx-number-displaywidth-number-number">
2137
+ <a class="link" href="#getdisplayposxx-number-displaywidth-number-number"
2138
+ >1.2. <code>getDisplayPosX(x: number, displayWidth: number): number</code></a
2139
+ >
2140
+ </h3>
2141
+ <div class="paragraph">
2142
+ <p>Calculates the absolute X pixel position on the main game display.</p>
2143
+ </div>
2144
+ <div class="paragraph">
2145
+ <p><strong>Parameters</strong></p>
2146
+ </div>
2147
+ <table class="tableblock frame-all grid-all stretch">
2148
+ <colgroup>
2149
+ <col style="width: 20%" />
2150
+ <col style="width: 20%" />
2151
+ <col style="width: 60%" />
2152
+ </colgroup>
2153
+ <tbody>
2154
+ <tr>
2155
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
2156
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
2157
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
2158
+ </tr>
2159
+ <tr>
2160
+ <td class="tableblock halign-left valign-top">
2161
+ <p class="tableblock"><code>x</code></p>
2162
+ </td>
2163
+ <td class="tableblock halign-left valign-top">
2164
+ <p class="tableblock"><code>number</code></p>
2165
+ </td>
2166
+ <td class="tableblock halign-left valign-top">
2167
+ <p class="tableblock">The relative or normalized input X horizontal position (0.0 to 1.0).</p>
2168
+ </td>
2169
+ </tr>
2170
+ <tr>
2171
+ <td class="tableblock halign-left valign-top">
2172
+ <p class="tableblock"><code>displayWidth</code></p>
2173
+ </td>
2174
+ <td class="tableblock halign-left valign-top">
2175
+ <p class="tableblock"><code>number</code></p>
2176
+ </td>
2177
+ <td class="tableblock halign-left valign-top">
2178
+ <p class="tableblock">The dynamically calculated width of the central display area.</p>
2179
+ </td>
2180
+ </tr>
2181
+ </tbody>
2182
+ </table>
2183
+ <div class="paragraph">
2184
+ <p><strong>Returns</strong></p>
2185
+ </div>
2186
+ <div class="paragraph">
2187
+ <p><code>number</code> - The absolute horizontal pixel position.</p>
2188
+ </div>
2189
+ <hr />
2190
+ </div>
2191
+ <div class="sect2">
2192
+ <h3 id="getdisplayposyy-number-displayheight-number-number">
2193
+ <a class="link" href="#getdisplayposyy-number-displayheight-number-number"
2194
+ >1.3. <code>getDisplayPosY(y: number, displayHeight: number): number</code></a
2195
+ >
2196
+ </h3>
2197
+ <div class="paragraph">
2198
+ <p>Calculates the absolute Y pixel position on the main game display.</p>
2199
+ </div>
2200
+ <div class="paragraph">
2201
+ <p><strong>Parameters</strong></p>
2202
+ </div>
2203
+ <table class="tableblock frame-all grid-all stretch">
2204
+ <colgroup>
2205
+ <col style="width: 20%" />
2206
+ <col style="width: 20%" />
2207
+ <col style="width: 60%" />
2208
+ </colgroup>
2209
+ <tbody>
2210
+ <tr>
2211
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
2212
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
2213
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
2214
+ </tr>
2215
+ <tr>
2216
+ <td class="tableblock halign-left valign-top">
2217
+ <p class="tableblock"><code>y</code></p>
2218
+ </td>
2219
+ <td class="tableblock halign-left valign-top">
2220
+ <p class="tableblock"><code>number</code></p>
2221
+ </td>
2222
+ <td class="tableblock halign-left valign-top">
2223
+ <p class="tableblock">The relative or normalized input Y vertical position (0.0 to 1.0).</p>
2224
+ </td>
2225
+ </tr>
2226
+ <tr>
2227
+ <td class="tableblock halign-left valign-top">
2228
+ <p class="tableblock"><code>displayHeight</code></p>
2229
+ </td>
2230
+ <td class="tableblock halign-left valign-top">
2231
+ <p class="tableblock"><code>number</code></p>
2232
+ </td>
2233
+ <td class="tableblock halign-left valign-top">
2234
+ <p class="tableblock">The dynamically calculated height of the central display area.</p>
2235
+ </td>
2236
+ </tr>
2237
+ </tbody>
2238
+ </table>
2239
+ <div class="paragraph">
2240
+ <p><strong>Returns</strong></p>
2241
+ </div>
2242
+ <div class="paragraph">
2243
+ <p><code>number</code> - The absolute vertical pixel position.</p>
2244
+ </div>
2245
+ <hr />
2246
+ </div>
2247
+ <div class="sect2">
2248
+ <h3 id="gethudposxx-number-displaywidth-number-number">
2249
+ <a class="link" href="#gethudposxx-number-displaywidth-number-number"
2250
+ >1.4. <code>getHudPosX(x: number, displayWidth: number): number</code></a
2251
+ >
2252
+ </h3>
2253
+ <div class="paragraph">
2254
+ <p>Calculates the absolute X pixel position within the HUD area.</p>
2255
+ </div>
2256
+ <div class="paragraph">
2257
+ <p><strong>Parameters</strong></p>
2258
+ </div>
2259
+ <table class="tableblock frame-all grid-all stretch">
2260
+ <colgroup>
2261
+ <col style="width: 20%" />
2262
+ <col style="width: 20%" />
2263
+ <col style="width: 60%" />
2264
+ </colgroup>
2265
+ <tbody>
2266
+ <tr>
2267
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
2268
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
2269
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
2270
+ </tr>
2271
+ <tr>
2272
+ <td class="tableblock halign-left valign-top">
2273
+ <p class="tableblock"><code>x</code></p>
2274
+ </td>
2275
+ <td class="tableblock halign-left valign-top">
2276
+ <p class="tableblock"><code>number</code></p>
2277
+ </td>
2278
+ <td class="tableblock halign-left valign-top">
2279
+ <p class="tableblock">The relative or normalized X position specifically within the bounded HUD compartment.</p>
2280
+ </td>
2281
+ </tr>
2282
+ <tr>
2283
+ <td class="tableblock halign-left valign-top">
2284
+ <p class="tableblock"><code>displayWidth</code></p>
2285
+ </td>
2286
+ <td class="tableblock halign-left valign-top">
2287
+ <p class="tableblock"><code>number</code></p>
2288
+ </td>
2289
+ <td class="tableblock halign-left valign-top">
2290
+ <p class="tableblock">
2291
+ The total real width of the central display (used for zero-point alignment offset calculation).
2292
+ </p>
2293
+ </td>
2294
+ </tr>
2295
+ </tbody>
2296
+ </table>
2297
+ <div class="paragraph">
2298
+ <p><strong>Returns</strong></p>
2299
+ </div>
2300
+ <div class="paragraph">
2301
+ <p><code>number</code> - The absolute horizontal pixel position within the HUD.</p>
2302
+ </div>
2303
+ <hr />
2304
+ </div>
2305
+ <div class="sect2">
2306
+ <h3 id="gethudposyy-number-displayheight-number-number">
2307
+ <a class="link" href="#gethudposyy-number-displayheight-number-number"
2308
+ >1.5. <code>getHudPosY(y: number, displayHeight: number): number</code></a
2309
+ >
2310
+ </h3>
2311
+ <div class="paragraph">
2312
+ <p>Calculates the absolute Y pixel position within the HUD area.</p>
2313
+ </div>
2314
+ <div class="paragraph">
2315
+ <p><strong>Parameters</strong></p>
2316
+ </div>
2317
+ <table class="tableblock frame-all grid-all stretch">
2318
+ <colgroup>
2319
+ <col style="width: 20%" />
2320
+ <col style="width: 20%" />
2321
+ <col style="width: 60%" />
2322
+ </colgroup>
2323
+ <tbody>
2324
+ <tr>
2325
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
2326
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
2327
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
2328
+ </tr>
2329
+ <tr>
2330
+ <td class="tableblock halign-left valign-top">
2331
+ <p class="tableblock"><code>y</code></p>
2332
+ </td>
2333
+ <td class="tableblock halign-left valign-top">
2334
+ <p class="tableblock"><code>number</code></p>
2335
+ </td>
2336
+ <td class="tableblock halign-left valign-top">
2337
+ <p class="tableblock">The relative or normalized Y position specifically within the bounded HUD compartment.</p>
2338
+ </td>
2339
+ </tr>
2340
+ <tr>
2341
+ <td class="tableblock halign-left valign-top">
2342
+ <p class="tableblock"><code>displayHeight</code></p>
2343
+ </td>
2344
+ <td class="tableblock halign-left valign-top">
2345
+ <p class="tableblock"><code>number</code></p>
2346
+ </td>
2347
+ <td class="tableblock halign-left valign-top">
2348
+ <p class="tableblock">
2349
+ The absolute pixel height assigned logically to the central display (used for scaled positioning bounds).
2350
+ </p>
2351
+ </td>
2352
+ </tr>
2353
+ </tbody>
2354
+ </table>
2355
+ <div class="paragraph">
2356
+ <p><strong>Returns</strong></p>
2357
+ </div>
2358
+ <div class="paragraph">
2359
+ <p><code>number</code> - The absolute vertical pixel position within the HUD.</p>
2360
+ </div>
2361
+ </div>
2362
+ </div>
2363
+ </div>
2364
+ </div>
2365
+ <div id="footer">
2366
+ <div id="footer-text"></div>
2367
+ </div>
2368
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>
2369
+ <script>
2370
+ if (!hljs.initHighlighting.called) {
2371
+ hljs.initHighlighting.called = true;
2372
+ [].slice.call(document.querySelectorAll('pre.highlight > code[data-lang]')).forEach(function (el) {
2373
+ hljs.highlightBlock(el);
2374
+ });
2375
+ }
2376
+ </script>
2377
+ </body>
2378
+ </html>