blob: d184cbad826c2c329f43aa100892526ffbab64cc (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
<h1>SDLStreamingVideoScaleManager Class Reference</h1>
<h3>Section Contents</h3>
<ul>
<li><a href="#section-scale">scale</a></li>
<li><a href="#section-displayViewportResolution">displayViewportResolution</a></li>
<li><a href="#section-appViewportFrame">appViewportFrame</a></li>
<li><a href="#section--init">-init</a></li>
<li><a href="#section--initWithScale:displayViewportResolution:">-initWithScale:displayViewportResolution:</a></li>
<li><a href="#section--scaleTouchEventCoordinates:">-scaleTouchEventCoordinates:</a></li>
<li><a href="#section--scaleHapticRect:">-scaleHapticRect:</a></li>
<li><a href="#section--makeScaledResolution">-makeScaledResolution</a></li>
<li><a href="#section--stop">-stop</a></li>
<li><a href="#section-+scale:size:">+scale:size:</a></li>
</ul>
<h3>Overview</h3>
<p>This class consolidates the logic of scaling between the view controller’s coordinate system and the display’s coordinate system.</p>
<p>The main goal of using scaling is to align different screens and use a common range of “points per inch”. This allows showing assets with a similar size on different screen resolutions.</p>
<section class="section task-group-section">
<h3 id="section-scale">
scale
</h3>
<p>The scaling factor the app should use to change the size of the projecting view.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">)</span> <span class="kt">float</span> <span class="n">scale</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">scale</span><span class="p">:</span> <span class="kt">Float</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-displayViewportResolution">
displayViewportResolution
</h3>
<p>The screen resolution of the connected display. The units are pixels.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">)</span> <span class="n">CGSize</span> <span class="n">displayViewportResolution</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">displayViewportResolution</span><span class="p">:</span> <span class="kt">CGSize</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-appViewportFrame">
appViewportFrame
</h3>
<p>The frame of the app’s projecting view. This is calculated by dividing the display’s viewport resolution by the scale. The units are points.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">CGRect</span> <span class="n">appViewportFrame</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">appViewportFrame</span><span class="p">:</span> <span class="kt">CGRect</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<h3 id="section--init">
-init
</h3>
<p>Creates a default streaming video scale manager.
The scale value will be set to 1.0 and the displayViewportResolution will be set to {0, 0}.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="n">init</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="nf">init</span><span class="p">()</span></code></pre>
<div>
<h4>Return Value</h4>
<p>A SDLStreamingVideoScaleManager object</p>
</div>
<h3 id="section--initWithScale:displayViewportResolution:">
-initWithScale:displayViewportResolution:
</h3>
<p>Convenience init for creating the manager with a scale and connected display viewport resolution.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithScale</span><span class="p">:(</span><span class="kt">float</span><span class="p">)</span><span class="nv">scale</span>
<span class="nf">displayViewportResolution</span><span class="p">:(</span><span class="n">CGSize</span><span class="p">)</span><span class="nv">displayViewportResolution</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">scale</span><span class="p">:</span> <span class="kt">Float</span><span class="p">,</span> <span class="nv">displayViewportResolution</span><span class="p">:</span> <span class="kt">CGSize</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>scale</dt>
<dd><p>The scaling factor the app should use to change the size of the projecting view</p></dd>
<dt>displayViewportResolution</dt>
<dd><p>The current screen resolution of the connected display</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>A SDLStreamingVideoScaleManager object</p>
</div>
<h3 id="section--scaleTouchEventCoordinates:">
-scaleTouchEventCoordinates:
</h3>
<p>Scales the coordinates of an <code>OnTouchEvent</code> from the display’s coordinate system to the app’s viewport coordinate system. If the scale value is less than 1.0, the touch events will be returned without being scaled.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLOnTouchEvent.html">SDLOnTouchEvent</a></span> <span class="o">*</span><span class="p">)</span><span class="nf">scaleTouchEventCoordinates</span><span class="p">:</span>
<span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLOnTouchEvent.html">SDLOnTouchEvent</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">onTouchEvent</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">scaleTouchEventCoordinates</span><span class="p">(</span><span class="n">_</span> <span class="nv">onTouchEvent</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOnTouchEvent.html">SDLOnTouchEvent</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Classes/SDLOnTouchEvent.html">SDLOnTouchEvent</a></span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>onTouchEvent</dt>
<dd><p>A touch event with coordinates</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>The touch event coordinates in the app’s viewport coordinate system</p>
</div>
<h3 id="section--scaleHapticRect:">
-scaleHapticRect:
</h3>
<p>Scales a haptic rectangle from the app’s viewport coordinate system to the display’s coordinate system. If the scale value is less than 1.0, the haptic rectangle will be returned without being scaled.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLHapticRect.html">SDLHapticRect</a></span> <span class="o">*</span><span class="p">)</span><span class="nf">scaleHapticRect</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLHapticRect.html">SDLHapticRect</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">hapticRect</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">scale</span><span class="p">(</span><span class="n">_</span> <span class="nv">hapticRect</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLHapticRect.html">SDLHapticRect</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Classes/SDLHapticRect.html">SDLHapticRect</a></span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>hapticRect</dt>
<dd><p>A haptic rectangle</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>The position of the haptic rectangle in the display’s coordinate system</p>
</div>
<h3 id="section--makeScaledResolution">
-makeScaledResolution
</h3>
<p>Create and return the current display resolution respecting the scale factor</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="p">)</span><span class="n">makeScaledResolution</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">makeScaledResolution</span><span class="p">()</span> <span class="o">-></span> <span class="kt"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span></code></pre>
<div>
<h4>Return Value</h4>
<p>A new created object of type SDLImageResolution</p>
</div>
<h3 id="section--stop">
-stop
</h3>
<p>Stops the manager. This method is used internally.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">stop</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">stop</span><span class="p">()</span></code></pre>
<h3 id="section-+scale:size:">
+scale:size:
</h3>
<p>Calculate a new size based on the given size and the scale factor</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">CGSize</span><span class="p">)</span><span class="nf">scale</span><span class="p">:(</span><span class="kt">float</span><span class="p">)</span><span class="nv">scale</span> <span class="nf">size</span><span class="p">:(</span><span class="n">CGSize</span><span class="p">)</span><span class="nv">size</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">scale</span><span class="p">(</span><span class="n">_</span> <span class="nv">scale</span><span class="p">:</span> <span class="kt">Float</span><span class="p">,</span> <span class="nv">size</span><span class="p">:</span> <span class="kt">CGSize</span><span class="p">)</span> <span class="o">-></span> <span class="kt">CGSize</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>scale</dt>
<dd><p>The scale factor to apply</p></dd>
<dt>size</dt>
<dd><p>The size struct to apply the scale to</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>A new created and inited struct of type CGSize</p>
</div>
</section>
|
