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,540 @@
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::Lens
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::Lens";
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 (L)</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">Lens</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::Lens
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::Lens</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/lens.rb</dd>
100
+ </dl>
101
+
102
+ </div>
103
+
104
+ <h2>Overview</h2><div class="docstring">
105
+ <div class="discussion">
106
+
107
+ <p>A lens 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="#focal_length-instance_method" title="#focal_length (instance method)">#<strong>focal_length</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 focal_length.</p>
146
+ </div></span>
147
+
148
+ </li>
149
+
150
+
151
+ <li class="public ">
152
+ <span class="summary_signature">
153
+
154
+ <a href="#model-instance_method" title="#model (instance method)">#<strong>model</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 model.</p>
175
+ </div></span>
176
+
177
+ </li>
178
+
179
+
180
+ <li class="public ">
181
+ <span class="summary_signature">
182
+
183
+ <a href="#tag-instance_method" title="#tag (instance method)">#<strong>tag</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>A user-created ID.</p>
204
+ </div></span>
205
+
206
+ </li>
207
+
208
+
209
+ </ul>
210
+
211
+
212
+
213
+
214
+
215
+ <h2>
216
+ Instance Method Summary
217
+ <small><a href="#" class="summary_toggle">collapse</a></small>
218
+ </h2>
219
+
220
+ <ul class="summary">
221
+
222
+ <li class="public ">
223
+ <span class="summary_signature">
224
+
225
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(yaml) &#x21d2; Lens </a>
226
+
227
+
228
+
229
+ </span>
230
+
231
+
232
+ <span class="note title constructor">constructor</span>
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+ <span class="summary_desc"><div class='inline'>
242
+ <p>A new instance of Lens.</p>
243
+ </div></span>
244
+
245
+ </li>
246
+
247
+
248
+ <li class="public ">
249
+ <span class="summary_signature">
250
+
251
+ <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> &#x21d2; String </a>
252
+
253
+
254
+
255
+ </span>
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+ <span class="summary_desc"><div class='inline'></div></span>
266
+
267
+ </li>
268
+
269
+
270
+ </ul>
271
+
272
+
273
+ <div id="constructor_details" class="method_details_list">
274
+ <h2>Constructor Details</h2>
275
+
276
+ <div class="method_details first">
277
+ <h3 class="signature first" id="initialize-instance_method">
278
+
279
+ #<strong>initialize</strong>(yaml) &#x21d2; <tt><span class='object_link'><a href="" title="Halation::Config::Lens (class)">Lens</a></span></tt>
280
+
281
+
282
+
283
+
284
+
285
+ </h3><div class="docstring">
286
+ <div class="discussion">
287
+
288
+ <p>Returns a new instance of Lens</p>
289
+
290
+
291
+ </div>
292
+ </div>
293
+ <div class="tags">
294
+
295
+
296
+ </div><table class="source_code">
297
+ <tr>
298
+ <td>
299
+ <pre class="lines">
300
+
301
+
302
+ 12
303
+ 13
304
+ 14
305
+ 15
306
+ 16</pre>
307
+ </td>
308
+ <td>
309
+ <pre class="code"><span class="info file"># File 'lib/halation/config/lens.rb', line 12</span>
310
+
311
+ <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>
312
+ <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>
313
+ <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>
314
+ <span class='ivar'>@focal_length</span> <span class='op'>=</span> <span class='const'>Coerce</span><span class='period'>.</span><span class='id identifier rubyid_integer'>integer</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'>focal_length</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
315
+ <span class='kw'>end</span></pre>
316
+ </td>
317
+ </tr>
318
+ </table>
319
+ </div>
320
+
321
+ </div>
322
+
323
+ <div id="instance_attr_details" class="attr_details">
324
+ <h2>Instance Attribute Details</h2>
325
+
326
+
327
+ <span id=""></span>
328
+ <div class="method_details first">
329
+ <h3 class="signature first" id="focal_length-instance_method">
330
+
331
+ #<strong>focal_length</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
332
+
333
+
334
+
335
+
336
+
337
+ </h3><div class="docstring">
338
+ <div class="discussion">
339
+
340
+ <p>Returns the value of attribute focal_length</p>
341
+
342
+
343
+ </div>
344
+ </div>
345
+ <div class="tags">
346
+
347
+
348
+ </div><table class="source_code">
349
+ <tr>
350
+ <td>
351
+ <pre class="lines">
352
+
353
+
354
+ 10
355
+ 11
356
+ 12</pre>
357
+ </td>
358
+ <td>
359
+ <pre class="code"><span class="info file"># File 'lib/halation/config/lens.rb', line 10</span>
360
+
361
+ <span class='kw'>def</span> <span class='id identifier rubyid_focal_length'>focal_length</span>
362
+ <span class='ivar'>@focal_length</span>
363
+ <span class='kw'>end</span></pre>
364
+ </td>
365
+ </tr>
366
+ </table>
367
+ </div>
368
+
369
+
370
+ <span id=""></span>
371
+ <div class="method_details ">
372
+ <h3 class="signature " id="model-instance_method">
373
+
374
+ #<strong>model</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
375
+
376
+
377
+
378
+
379
+
380
+ </h3><div class="docstring">
381
+ <div class="discussion">
382
+
383
+ <p>Returns the value of attribute model</p>
384
+
385
+
386
+ </div>
387
+ </div>
388
+ <div class="tags">
389
+
390
+
391
+ </div><table class="source_code">
392
+ <tr>
393
+ <td>
394
+ <pre class="lines">
395
+
396
+
397
+ 9
398
+ 10
399
+ 11</pre>
400
+ </td>
401
+ <td>
402
+ <pre class="code"><span class="info file"># File 'lib/halation/config/lens.rb', line 9</span>
403
+
404
+ <span class='kw'>def</span> <span class='id identifier rubyid_model'>model</span>
405
+ <span class='ivar'>@model</span>
406
+ <span class='kw'>end</span></pre>
407
+ </td>
408
+ </tr>
409
+ </table>
410
+ </div>
411
+
412
+
413
+ <span id=""></span>
414
+ <div class="method_details ">
415
+ <h3 class="signature " id="tag-instance_method">
416
+
417
+ #<strong>tag</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
418
+
419
+
420
+
421
+
422
+
423
+ </h3><div class="docstring">
424
+ <div class="discussion">
425
+
426
+ <p>A user-created ID.</p>
427
+
428
+
429
+ </div>
430
+ </div>
431
+ <div class="tags">
432
+
433
+
434
+ </div><table class="source_code">
435
+ <tr>
436
+ <td>
437
+ <pre class="lines">
438
+
439
+
440
+ 8
441
+ 9
442
+ 10</pre>
443
+ </td>
444
+ <td>
445
+ <pre class="code"><span class="info file"># File 'lib/halation/config/lens.rb', line 8</span>
446
+
447
+ <span class='kw'>def</span> <span class='id identifier rubyid_tag'>tag</span>
448
+ <span class='ivar'>@tag</span>
449
+ <span class='kw'>end</span></pre>
450
+ </td>
451
+ </tr>
452
+ </table>
453
+ </div>
454
+
455
+ </div>
456
+
457
+
458
+ <div id="instance_method_details" class="method_details_list">
459
+ <h2>Instance Method Details</h2>
460
+
461
+
462
+ <div class="method_details first">
463
+ <h3 class="signature first" id="to_s-instance_method">
464
+
465
+ #<strong>to_s</strong> &#x21d2; <tt>String</tt>
466
+
467
+
468
+
469
+
470
+
471
+ </h3><div class="docstring">
472
+ <div class="discussion">
473
+
474
+
475
+ </div>
476
+ </div>
477
+ <div class="tags">
478
+
479
+ <p class="tag_title">Returns:</p>
480
+ <ul class="return">
481
+
482
+ <li>
483
+
484
+
485
+ <span class='type'>(<tt>String</tt>)</span>
486
+
487
+
488
+
489
+ </li>
490
+
491
+ </ul>
492
+
493
+ </div><table class="source_code">
494
+ <tr>
495
+ <td>
496
+ <pre class="lines">
497
+
498
+
499
+ 19
500
+ 20
501
+ 21
502
+ 22
503
+ 23
504
+ 24
505
+ 25
506
+ 26
507
+ 27
508
+ 28</pre>
509
+ </td>
510
+ <td>
511
+ <pre class="code"><span class="info file"># File 'lib/halation/config/lens.rb', line 19</span>
512
+
513
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
514
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Lens\n</span><span class='tstring_end'>&quot;</span></span> <span class='op'>&lt;&lt;</span>
515
+ <span class='lbracket'>[</span>
516
+ <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>
517
+ <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>
518
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Focal Length: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_focal_length'>focal_length</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
519
+ <span class='rbracket'>]</span><span class='period'>
520
+ </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'>
521
+ </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>
522
+ <span class='kw'>end</span></pre>
523
+ </td>
524
+ </tr>
525
+ </table>
526
+ </div>
527
+
528
+ </div>
529
+
530
+ </div>
531
+
532
+ <div id="footer">
533
+ Generated on Sat May 28 22:28:56 2016 by
534
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
535
+ 0.8.7.6 (ruby-2.1.7).
536
+ </div>
537
+
538
+ </div>
539
+ </body>
540
+ </html>