halation 0.1.0 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,628 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Halation::Config::Camera
8
+
9
+ &mdash; Documentation by YARD 0.8.7.6
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "Halation::Config::Camera";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (C)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../Halation.html" title="Halation (module)">Halation</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Config.html" title="Halation::Config (class)">Config</a></span></span>
41
+ &raquo;
42
+ <span class="title">Camera</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <iframe id="search_frame" src="../../class_list.html"></iframe>
63
+
64
+ <div id="content"><h1>Class: Halation::Config::Camera
65
+
66
+
67
+
68
+ </h1>
69
+ <div class="box_info">
70
+
71
+ <dl>
72
+ <dt>Inherits:</dt>
73
+ <dd>
74
+ <span class="inheritName">Object</span>
75
+
76
+ <ul class="fullTree">
77
+ <li>Object</li>
78
+
79
+ <li class="next">Halation::Config::Camera</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ <dl>
98
+ <dt>Defined in:</dt>
99
+ <dd>lib/halation/config/camera.rb</dd>
100
+ </dl>
101
+
102
+ </div>
103
+
104
+ <h2>Overview</h2><div class="docstring">
105
+ <div class="discussion">
106
+
107
+ <p>A camera profile.</p>
108
+
109
+
110
+ </div>
111
+ </div>
112
+ <div class="tags">
113
+
114
+
115
+ </div>
116
+
117
+
118
+
119
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
120
+ <ul class="summary">
121
+
122
+ <li class="public ">
123
+ <span class="summary_signature">
124
+
125
+ <a href="#lenses-instance_method" title="#lenses (instance method)">#<strong>lenses</strong> &#x21d2; Object </a>
126
+
127
+
128
+
129
+ </span>
130
+
131
+
132
+
133
+
134
+ <span class="note title readonly">readonly</span>
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+ <span class="summary_desc"><div class='inline'>
145
+ <p>Returns the value of attribute lenses.</p>
146
+ </div></span>
147
+
148
+ </li>
149
+
150
+
151
+ <li class="public ">
152
+ <span class="summary_signature">
153
+
154
+ <a href="#make-instance_method" title="#make (instance method)">#<strong>make</strong> &#x21d2; Object </a>
155
+
156
+
157
+
158
+ </span>
159
+
160
+
161
+
162
+
163
+ <span class="note title readonly">readonly</span>
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+ <span class="summary_desc"><div class='inline'>
174
+ <p>Returns the value of attribute make.</p>
175
+ </div></span>
176
+
177
+ </li>
178
+
179
+
180
+ <li class="public ">
181
+ <span class="summary_signature">
182
+
183
+ <a href="#model-instance_method" title="#model (instance method)">#<strong>model</strong> &#x21d2; Object </a>
184
+
185
+
186
+
187
+ </span>
188
+
189
+
190
+
191
+
192
+ <span class="note title readonly">readonly</span>
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+ <span class="summary_desc"><div class='inline'>
203
+ <p>Returns the value of attribute model.</p>
204
+ </div></span>
205
+
206
+ </li>
207
+
208
+
209
+ <li class="public ">
210
+ <span class="summary_signature">
211
+
212
+ <a href="#tag-instance_method" title="#tag (instance method)">#<strong>tag</strong> &#x21d2; Object </a>
213
+
214
+
215
+
216
+ </span>
217
+
218
+
219
+
220
+
221
+ <span class="note title readonly">readonly</span>
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+ <span class="summary_desc"><div class='inline'>
232
+ <p>A user-created ID.</p>
233
+ </div></span>
234
+
235
+ </li>
236
+
237
+
238
+ </ul>
239
+
240
+
241
+
242
+
243
+
244
+ <h2>
245
+ Instance Method Summary
246
+ <small><a href="#" class="summary_toggle">collapse</a></small>
247
+ </h2>
248
+
249
+ <ul class="summary">
250
+
251
+ <li class="public ">
252
+ <span class="summary_signature">
253
+
254
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(yaml) &#x21d2; Camera </a>
255
+
256
+
257
+
258
+ </span>
259
+
260
+
261
+ <span class="note title constructor">constructor</span>
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+ <span class="summary_desc"><div class='inline'>
271
+ <p>A new instance of Camera.</p>
272
+ </div></span>
273
+
274
+ </li>
275
+
276
+
277
+ <li class="public ">
278
+ <span class="summary_signature">
279
+
280
+ <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> &#x21d2; String </a>
281
+
282
+
283
+
284
+ </span>
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+ <span class="summary_desc"><div class='inline'></div></span>
295
+
296
+ </li>
297
+
298
+
299
+ </ul>
300
+
301
+
302
+ <div id="constructor_details" class="method_details_list">
303
+ <h2>Constructor Details</h2>
304
+
305
+ <div class="method_details first">
306
+ <h3 class="signature first" id="initialize-instance_method">
307
+
308
+ #<strong>initialize</strong>(yaml) &#x21d2; <tt><span class='object_link'><a href="" title="Halation::Config::Camera (class)">Camera</a></span></tt>
309
+
310
+
311
+
312
+
313
+
314
+ </h3><div class="docstring">
315
+ <div class="discussion">
316
+
317
+ <p>Returns a new instance of Camera</p>
318
+
319
+
320
+ </div>
321
+ </div>
322
+ <div class="tags">
323
+
324
+
325
+ </div><table class="source_code">
326
+ <tr>
327
+ <td>
328
+ <pre class="lines">
329
+
330
+
331
+ 14
332
+ 15
333
+ 16
334
+ 17
335
+ 18
336
+ 19
337
+ 20
338
+ 21
339
+ 22
340
+ 23</pre>
341
+ </td>
342
+ <td>
343
+ <pre class="code"><span class="info file"># File 'lib/halation/config/camera.rb', line 14</span>
344
+
345
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_yaml'>yaml</span><span class='rparen'>)</span>
346
+ <span class='ivar'>@tag</span> <span class='op'>=</span> <span class='const'>Coerce</span><span class='period'>.</span><span class='id identifier rubyid_string'>string</span><span class='lparen'>(</span><span class='id identifier rubyid_yaml'>yaml</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>tag</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
347
+ <span class='ivar'>@make</span> <span class='op'>=</span> <span class='const'>Coerce</span><span class='period'>.</span><span class='id identifier rubyid_string'>string</span><span class='lparen'>(</span><span class='id identifier rubyid_yaml'>yaml</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>make</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
348
+ <span class='ivar'>@model</span> <span class='op'>=</span> <span class='const'>Coerce</span><span class='period'>.</span><span class='id identifier rubyid_string'>string</span><span class='lparen'>(</span><span class='id identifier rubyid_yaml'>yaml</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>model</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
349
+ <span class='ivar'>@lenses</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
350
+
351
+ <span class='id identifier rubyid_yaml'>yaml</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>lenses</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_lens'>lens</span><span class='op'>|</span>
352
+ <span class='ivar'>@lenses</span> <span class='op'>&lt;&lt;</span> <span class='const'>Lens</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_lens'>lens</span><span class='rparen'>)</span>
353
+ <span class='kw'>end</span>
354
+ <span class='kw'>end</span></pre>
355
+ </td>
356
+ </tr>
357
+ </table>
358
+ </div>
359
+
360
+ </div>
361
+
362
+ <div id="instance_attr_details" class="attr_details">
363
+ <h2>Instance Attribute Details</h2>
364
+
365
+
366
+ <span id=""></span>
367
+ <div class="method_details first">
368
+ <h3 class="signature first" id="lenses-instance_method">
369
+
370
+ #<strong>lenses</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
371
+
372
+
373
+
374
+
375
+
376
+ </h3><div class="docstring">
377
+ <div class="discussion">
378
+
379
+ <p>Returns the value of attribute lenses</p>
380
+
381
+
382
+ </div>
383
+ </div>
384
+ <div class="tags">
385
+
386
+
387
+ </div><table class="source_code">
388
+ <tr>
389
+ <td>
390
+ <pre class="lines">
391
+
392
+
393
+ 12
394
+ 13
395
+ 14</pre>
396
+ </td>
397
+ <td>
398
+ <pre class="code"><span class="info file"># File 'lib/halation/config/camera.rb', line 12</span>
399
+
400
+ <span class='kw'>def</span> <span class='id identifier rubyid_lenses'>lenses</span>
401
+ <span class='ivar'>@lenses</span>
402
+ <span class='kw'>end</span></pre>
403
+ </td>
404
+ </tr>
405
+ </table>
406
+ </div>
407
+
408
+
409
+ <span id=""></span>
410
+ <div class="method_details ">
411
+ <h3 class="signature " id="make-instance_method">
412
+
413
+ #<strong>make</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
414
+
415
+
416
+
417
+
418
+
419
+ </h3><div class="docstring">
420
+ <div class="discussion">
421
+
422
+ <p>Returns the value of attribute make</p>
423
+
424
+
425
+ </div>
426
+ </div>
427
+ <div class="tags">
428
+
429
+
430
+ </div><table class="source_code">
431
+ <tr>
432
+ <td>
433
+ <pre class="lines">
434
+
435
+
436
+ 10
437
+ 11
438
+ 12</pre>
439
+ </td>
440
+ <td>
441
+ <pre class="code"><span class="info file"># File 'lib/halation/config/camera.rb', line 10</span>
442
+
443
+ <span class='kw'>def</span> <span class='id identifier rubyid_make'>make</span>
444
+ <span class='ivar'>@make</span>
445
+ <span class='kw'>end</span></pre>
446
+ </td>
447
+ </tr>
448
+ </table>
449
+ </div>
450
+
451
+
452
+ <span id=""></span>
453
+ <div class="method_details ">
454
+ <h3 class="signature " id="model-instance_method">
455
+
456
+ #<strong>model</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
457
+
458
+
459
+
460
+
461
+
462
+ </h3><div class="docstring">
463
+ <div class="discussion">
464
+
465
+ <p>Returns the value of attribute model</p>
466
+
467
+
468
+ </div>
469
+ </div>
470
+ <div class="tags">
471
+
472
+
473
+ </div><table class="source_code">
474
+ <tr>
475
+ <td>
476
+ <pre class="lines">
477
+
478
+
479
+ 11
480
+ 12
481
+ 13</pre>
482
+ </td>
483
+ <td>
484
+ <pre class="code"><span class="info file"># File 'lib/halation/config/camera.rb', line 11</span>
485
+
486
+ <span class='kw'>def</span> <span class='id identifier rubyid_model'>model</span>
487
+ <span class='ivar'>@model</span>
488
+ <span class='kw'>end</span></pre>
489
+ </td>
490
+ </tr>
491
+ </table>
492
+ </div>
493
+
494
+
495
+ <span id=""></span>
496
+ <div class="method_details ">
497
+ <h3 class="signature " id="tag-instance_method">
498
+
499
+ #<strong>tag</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
500
+
501
+
502
+
503
+
504
+
505
+ </h3><div class="docstring">
506
+ <div class="discussion">
507
+
508
+ <p>A user-created ID.</p>
509
+
510
+
511
+ </div>
512
+ </div>
513
+ <div class="tags">
514
+
515
+
516
+ </div><table class="source_code">
517
+ <tr>
518
+ <td>
519
+ <pre class="lines">
520
+
521
+
522
+ 9
523
+ 10
524
+ 11</pre>
525
+ </td>
526
+ <td>
527
+ <pre class="code"><span class="info file"># File 'lib/halation/config/camera.rb', line 9</span>
528
+
529
+ <span class='kw'>def</span> <span class='id identifier rubyid_tag'>tag</span>
530
+ <span class='ivar'>@tag</span>
531
+ <span class='kw'>end</span></pre>
532
+ </td>
533
+ </tr>
534
+ </table>
535
+ </div>
536
+
537
+ </div>
538
+
539
+
540
+ <div id="instance_method_details" class="method_details_list">
541
+ <h2>Instance Method Details</h2>
542
+
543
+
544
+ <div class="method_details first">
545
+ <h3 class="signature first" id="to_s-instance_method">
546
+
547
+ #<strong>to_s</strong> &#x21d2; <tt>String</tt>
548
+
549
+
550
+
551
+
552
+
553
+ </h3><div class="docstring">
554
+ <div class="discussion">
555
+
556
+
557
+ </div>
558
+ </div>
559
+ <div class="tags">
560
+
561
+ <p class="tag_title">Returns:</p>
562
+ <ul class="return">
563
+
564
+ <li>
565
+
566
+
567
+ <span class='type'>(<tt>String</tt>)</span>
568
+
569
+
570
+
571
+ </li>
572
+
573
+ </ul>
574
+
575
+ </div><table class="source_code">
576
+ <tr>
577
+ <td>
578
+ <pre class="lines">
579
+
580
+
581
+ 26
582
+ 27
583
+ 28
584
+ 29
585
+ 30
586
+ 31
587
+ 32
588
+ 33
589
+ 34
590
+ 35
591
+ 36
592
+ 37
593
+ 38</pre>
594
+ </td>
595
+ <td>
596
+ <pre class="code"><span class="info file"># File 'lib/halation/config/camera.rb', line 26</span>
597
+
598
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
599
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Camera\n</span><span class='tstring_end'>&quot;</span></span> <span class='op'>&lt;&lt;</span>
600
+ <span class='lbracket'>[</span>
601
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Tag: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_tag'>tag</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
602
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Make: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_make'>make</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
603
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Model: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_model'>model</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
604
+ <span class='ivar'>@lenses</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:to_s</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
605
+ <span class='rbracket'>]</span><span class='period'>
606
+ </span><span class='id identifier rubyid_ .join'> .join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>
607
+ </span><span class='id identifier rubyid_ .lines'> .lines</span><span class='period'>
608
+ </span><span class='id identifier rubyid_ .map'> .map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_line'>line</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_line'>line</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span><span class='period'>
609
+ </span><span class='id identifier rubyid_ .join'> .join</span>
610
+ <span class='kw'>end</span></pre>
611
+ </td>
612
+ </tr>
613
+ </table>
614
+ </div>
615
+
616
+ </div>
617
+
618
+ </div>
619
+
620
+ <div id="footer">
621
+ Generated on Sat May 28 22:28:56 2016 by
622
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
623
+ 0.8.7.6 (ruby-2.1.7).
624
+ </div>
625
+
626
+ </div>
627
+ </body>
628
+ </html>