-
Notifications
You must be signed in to change notification settings - Fork 0
/
camera.html
409 lines (333 loc) · 22.6 KB
/
camera.html
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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.7.1" />
<title>pyspace.camera API documentation</title>
<meta name="description" content="" />
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>pyspace.camera</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class Camera:
def __init__(self):
self.params = {}
# Number of additional samples on each axis to average and improve image quality.
# NOTE: This will slow down rendering quadratically.
# Recommended Range: 1 to 8 (integer)
self.params['ANTIALIASING_SAMPLES'] = 1
# The strength of the ambient occlusion.
# Recommended Range: 0.0 to 0.05
self.params['AMBIENT_OCCLUSION_STRENGTH'] = 0.01
# Represents the maximum RGB color shift that can result from ambient occlusion.
# Typically use positive values for 'glow' effects and negative for 'darkness'.
# Recommended Range: All values between -1.0 and 1.0
self.params['AMBIENT_OCCLUSION_COLOR_DELTA'] = (0.8, 0.8, 0.8)
# Color of the background when the ray doesn't hit anything
# Recommended Range: All values between 0.0 and 1.0
self.params['BACKGROUND_COLOR'] = (0.6, 0.6, 0.9)
# The strength of the depth of field effect.
# NOTE: ANTIALIASING_SAMPLES must be larger than 1 to use depth of field effects.
# Recommended Range: 0.0 to 20.0
self.params['DEPTH_OF_FIELD_STRENGTH'] = 0.0
# The distance from the camera where objects will appear in focus.
# NOTE: ANTIALIASING_SAMPLES must be larger than 1 to use depth of field effects.
# Recommended Range: 0.0 to 100.0
self.params['DEPTH_OF_FIELD_DISTANCE'] = 1.0
# Determines if diffuse lighting should be enabled.
# NOTE: This flag will be ignored if DIFFUSE_ENHANCED_ENABLED is set.
# NOTE: SHADOW_DARKNESS is also used to change diffuse intensity.
self.params['DIFFUSE_ENABLED'] = False
# This is a 'less correct' but more aesthetically pleasing diffuse variant.
# NOTE: This will override the DIFFUSE_ENABLED flag.
# NOTE: SHADOW_DARKNESS is also used to change diffuse intensity.
self.params['DIFFUSE_ENHANCED_ENABLED'] = True
# Amount of light captured by the camera.
# Can be used to increase/decrease brightness in case pixels are over-saturated.
# Recommended Range: 0.1 to 10.0
self.params['EXPOSURE'] = 1.0
# Field of view of the camera in degrees
# NOTE: This will have no effect if ORTHOGONAL_PROJECTION or ODS is enabled.
# Recommended Range: 20.0 to 120.0
self.params['FIELD_OF_VIEW'] = 60.0
# When enabled, adds a distance-based fog to the scene
# NOTE: Fog strength is determined by MAX_DIST and fog color is always BACKGROUND_COLOR.
# NOTE: If enabled, you usually also want VIGNETTE_FOREGROUND=True and SUN_ENABLED=False.
self.params['FOG_ENABLED'] = False
# When enabled, adds object glow to the background layer.
self.params['GLOW_ENABLED'] = False
# Represents the maximum RGB color shift that can result from glow.
# Recommended Range: All values between -1.0 and 1.0
self.params['GLOW_COLOR_DELTA'] = (-0.2, 0.5, -0.2)
# The sharpness of the glow.
# Recommended Range: 1.0 to 100.0
self.params['GLOW_SHARPNESS'] = 4.0
# Color of the sunlight in RGB format.
# Recommended Range: All values between 0.0 and 1.0
self.params['LIGHT_COLOR'] = (1.0, 0.9, 0.6)
# Direction of the sunlight.
# NOTE: This must be a normalized quantity (magnitude = 1.0)
self.params['LIGHT_DIRECTION'] = (-0.36, 0.48, 0.80)
# Level of detail multiplier to improve speed and performance.
# When this value is large, distant objects become less detailed.
# Recommended Range: 0.0 to 100.0
self.params['LOD_MULTIPLIER'] = 10.0
# Maximum number of marches before a ray is considered a non-intersection.
# Recommended Range: 10 to 10000 (integer)
self.params['MAX_MARCHES'] = 1000
# Maximum distance before a ray is considered a non-intersection.
# Recommended Range: 0.5 to 200.0
self.params['MAX_DIST'] = 50.0
# Minimum march distance until a ray is considered intersecting.
# Recommended Range: 0.000001 to 0.01
self.params['MIN_DIST'] = 0.00001
# Number of additional renderings between frames.
# NOTE: This will slow down rendering linearly.
# Recommended Range: 0 to 10 (integer)
self.params['MOTION_BLUR_LEVEL'] = 0
# Proportion of time the shutter is open during a frame
# NOTE: Only applys when MOTION_BLUR_LEVEL is greater than 0
# Recommended Range: 0.0 to 1.0
self.params['MOTION_BLUR_RATIO'] = 1.0
# If true will render an omnidirectional stereo 360 projection.
self.params['ODS'] = False
# Determines if the projection view should be orthographic instead of perspective.
self.params['ORTHOGONAL_PROJECTION'] = False
# When ORTHOGONAL_PROJECTION is enabled, this will determine the size of the view.
# NOTE: Larger numbers mean the view will appear more zoomed out.
# Recommended Range: 0.5 to 50.0
self.params['ORTHOGONAL_ZOOM'] = 5.0
# Number of additional bounces after a ray collides with the geometry.
# Recommended Range: 0 to 8 (integer)
self.params['REFLECTION_LEVEL'] = 0
# Proportion of light lost each time a reflection occurs.
# NOTE: This will only be relevant if REFLECTION_LEVEL is greater than 0.
# Recommended Range: 0.25 to 1.0
self.params['REFLECTION_ATTENUATION'] = 0.6
# When enabled, uses an additional ray march to the light source to check for shadows.
self.params['SHADOWS_ENABLED'] = True
# Proportion of the light that is 'blocked' by the shadow or diffuse light.
# Recommended Range: 0.0 to 1.0
self.params['SHADOW_DARKNESS'] = 0.8
# How sharp the shadows should appear.
# Recommended Range: 1.0 to 100.0
self.params['SHADOW_SHARPNESS'] = 16.0
# Used to determine how sharp specular reflections are.
# NOTE: This is the 'shininess' parameter in the phong illumination model.
# NOTE: To disable specular highlights, use the value 0.
# Recommended Range: 0 to 1000 (integer)
self.params['SPECULAR_HIGHLIGHT'] = 40
# Determines if the sun should be drawn in the sky.
self.params['SUN_ENABLED'] = True
# Size of the sun to draw in the sky.
# NOTE: This only takes effect when SUN_ENABLED is enabled.
# Recommended Range: 0.0001 to 0.05
self.params['SUN_SIZE'] = 0.005
# How sharp the sun should appear in the sky.
# NOTE: This only takes effect when SUN_ENABLED is enabled.
# Recommended Range: 0.1 to 10.0
self.params['SUN_SHARPNESS'] = 2.0
# When enabled, vignetting will also effect foreground objects.
self.params['VIGNETTE_FOREGROUND'] = False
# The strength of the vignetting effect.
# Recommended Range: 0.0 to 1.5
self.params['VIGNETTE_STRENGTH'] = 0.5
def __getitem__(self, k):
return self.params[k]
def __setitem__(self, k, x):
self.params[k] = x</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="pyspace.camera.Camera"><code class="flex name class">
<span>class <span class="ident">Camera</span></span>
</code></dt>
<dd>
<section class="desc"></section>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class Camera:
def __init__(self):
self.params = {}
# Number of additional samples on each axis to average and improve image quality.
# NOTE: This will slow down rendering quadratically.
# Recommended Range: 1 to 8 (integer)
self.params['ANTIALIASING_SAMPLES'] = 1
# The strength of the ambient occlusion.
# Recommended Range: 0.0 to 0.05
self.params['AMBIENT_OCCLUSION_STRENGTH'] = 0.01
# Represents the maximum RGB color shift that can result from ambient occlusion.
# Typically use positive values for 'glow' effects and negative for 'darkness'.
# Recommended Range: All values between -1.0 and 1.0
self.params['AMBIENT_OCCLUSION_COLOR_DELTA'] = (0.8, 0.8, 0.8)
# Color of the background when the ray doesn't hit anything
# Recommended Range: All values between 0.0 and 1.0
self.params['BACKGROUND_COLOR'] = (0.6, 0.6, 0.9)
# The strength of the depth of field effect.
# NOTE: ANTIALIASING_SAMPLES must be larger than 1 to use depth of field effects.
# Recommended Range: 0.0 to 20.0
self.params['DEPTH_OF_FIELD_STRENGTH'] = 0.0
# The distance from the camera where objects will appear in focus.
# NOTE: ANTIALIASING_SAMPLES must be larger than 1 to use depth of field effects.
# Recommended Range: 0.0 to 100.0
self.params['DEPTH_OF_FIELD_DISTANCE'] = 1.0
# Determines if diffuse lighting should be enabled.
# NOTE: This flag will be ignored if DIFFUSE_ENHANCED_ENABLED is set.
# NOTE: SHADOW_DARKNESS is also used to change diffuse intensity.
self.params['DIFFUSE_ENABLED'] = False
# This is a 'less correct' but more aesthetically pleasing diffuse variant.
# NOTE: This will override the DIFFUSE_ENABLED flag.
# NOTE: SHADOW_DARKNESS is also used to change diffuse intensity.
self.params['DIFFUSE_ENHANCED_ENABLED'] = True
# Amount of light captured by the camera.
# Can be used to increase/decrease brightness in case pixels are over-saturated.
# Recommended Range: 0.1 to 10.0
self.params['EXPOSURE'] = 1.0
# Field of view of the camera in degrees
# NOTE: This will have no effect if ORTHOGONAL_PROJECTION or ODS is enabled.
# Recommended Range: 20.0 to 120.0
self.params['FIELD_OF_VIEW'] = 60.0
# When enabled, adds a distance-based fog to the scene
# NOTE: Fog strength is determined by MAX_DIST and fog color is always BACKGROUND_COLOR.
# NOTE: If enabled, you usually also want VIGNETTE_FOREGROUND=True and SUN_ENABLED=False.
self.params['FOG_ENABLED'] = False
# When enabled, adds object glow to the background layer.
self.params['GLOW_ENABLED'] = False
# Represents the maximum RGB color shift that can result from glow.
# Recommended Range: All values between -1.0 and 1.0
self.params['GLOW_COLOR_DELTA'] = (-0.2, 0.5, -0.2)
# The sharpness of the glow.
# Recommended Range: 1.0 to 100.0
self.params['GLOW_SHARPNESS'] = 4.0
# Color of the sunlight in RGB format.
# Recommended Range: All values between 0.0 and 1.0
self.params['LIGHT_COLOR'] = (1.0, 0.9, 0.6)
# Direction of the sunlight.
# NOTE: This must be a normalized quantity (magnitude = 1.0)
self.params['LIGHT_DIRECTION'] = (-0.36, 0.48, 0.80)
# Level of detail multiplier to improve speed and performance.
# When this value is large, distant objects become less detailed.
# Recommended Range: 0.0 to 100.0
self.params['LOD_MULTIPLIER'] = 10.0
# Maximum number of marches before a ray is considered a non-intersection.
# Recommended Range: 10 to 10000 (integer)
self.params['MAX_MARCHES'] = 1000
# Maximum distance before a ray is considered a non-intersection.
# Recommended Range: 0.5 to 200.0
self.params['MAX_DIST'] = 50.0
# Minimum march distance until a ray is considered intersecting.
# Recommended Range: 0.000001 to 0.01
self.params['MIN_DIST'] = 0.00001
# Number of additional renderings between frames.
# NOTE: This will slow down rendering linearly.
# Recommended Range: 0 to 10 (integer)
self.params['MOTION_BLUR_LEVEL'] = 0
# Proportion of time the shutter is open during a frame
# NOTE: Only applys when MOTION_BLUR_LEVEL is greater than 0
# Recommended Range: 0.0 to 1.0
self.params['MOTION_BLUR_RATIO'] = 1.0
# If true will render an omnidirectional stereo 360 projection.
self.params['ODS'] = False
# Determines if the projection view should be orthographic instead of perspective.
self.params['ORTHOGONAL_PROJECTION'] = False
# When ORTHOGONAL_PROJECTION is enabled, this will determine the size of the view.
# NOTE: Larger numbers mean the view will appear more zoomed out.
# Recommended Range: 0.5 to 50.0
self.params['ORTHOGONAL_ZOOM'] = 5.0
# Number of additional bounces after a ray collides with the geometry.
# Recommended Range: 0 to 8 (integer)
self.params['REFLECTION_LEVEL'] = 0
# Proportion of light lost each time a reflection occurs.
# NOTE: This will only be relevant if REFLECTION_LEVEL is greater than 0.
# Recommended Range: 0.25 to 1.0
self.params['REFLECTION_ATTENUATION'] = 0.6
# When enabled, uses an additional ray march to the light source to check for shadows.
self.params['SHADOWS_ENABLED'] = True
# Proportion of the light that is 'blocked' by the shadow or diffuse light.
# Recommended Range: 0.0 to 1.0
self.params['SHADOW_DARKNESS'] = 0.8
# How sharp the shadows should appear.
# Recommended Range: 1.0 to 100.0
self.params['SHADOW_SHARPNESS'] = 16.0
# Used to determine how sharp specular reflections are.
# NOTE: This is the 'shininess' parameter in the phong illumination model.
# NOTE: To disable specular highlights, use the value 0.
# Recommended Range: 0 to 1000 (integer)
self.params['SPECULAR_HIGHLIGHT'] = 40
# Determines if the sun should be drawn in the sky.
self.params['SUN_ENABLED'] = True
# Size of the sun to draw in the sky.
# NOTE: This only takes effect when SUN_ENABLED is enabled.
# Recommended Range: 0.0001 to 0.05
self.params['SUN_SIZE'] = 0.005
# How sharp the sun should appear in the sky.
# NOTE: This only takes effect when SUN_ENABLED is enabled.
# Recommended Range: 0.1 to 10.0
self.params['SUN_SHARPNESS'] = 2.0
# When enabled, vignetting will also effect foreground objects.
self.params['VIGNETTE_FOREGROUND'] = False
# The strength of the vignetting effect.
# Recommended Range: 0.0 to 1.5
self.params['VIGNETTE_STRENGTH'] = 0.5
def __getitem__(self, k):
return self.params[k]
def __setitem__(self, k, x):
self.params[k] = x</code></pre>
</details>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="pyspace" href="index.html">pyspace</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="pyspace.camera.Camera" href="#pyspace.camera.Camera">Camera</a></code></h4>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.1</a>.</p>
</footer>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad()</script>
</body>
</html>