-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathprimitives.html
500 lines (373 loc) · 42.3 KB
/
primitives.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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>7. Primitives — Raysect Documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/theme.css" type="text/css" />
<link rel="shortcut icon" href="_static/RaysectLogo_web.ico"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="8. Materials" href="materials.html" />
<link rel="prev" title="6. Sampling and Observers" href="observers.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Raysect
<img src="_static/RaysectLogo_web.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.8.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption" role="heading"><span class="caption-text">Table of Contents</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">1. Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">2. License</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">3. Downloading and Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_it_works.html">4. How it works</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart_guide.html">5. Quickstart Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="observers.html">6. Sampling and Observers</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">7. Primitives</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#geometric-primitives">7.1. Geometric Primitives</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#sphere">7.1.1. Sphere</a></li>
<li class="toctree-l3"><a class="reference internal" href="#box">7.1.2. Box</a></li>
<li class="toctree-l3"><a class="reference internal" href="#cylinder">7.1.3. Cylinder</a></li>
<li class="toctree-l3"><a class="reference internal" href="#cone">7.1.4. Cone</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#csg-operations">7.2. CSG Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="#meshes">7.3. Meshes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="materials.html">8. Materials</a></li>
<li class="toctree-l1"><a class="reference internal" href="conventions.html">9. Conventions</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">10. References</a></li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">11. Glossary</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Demonstrations</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="demonstrations/demonstrations.html">1. Core Functionality</a></li>
<li class="toctree-l1"><a class="reference internal" href="demonstrations/demonstrations.html#materials">2. Materials</a></li>
<li class="toctree-l1"><a class="reference internal" href="demonstrations/demonstrations.html#observers">3. Observers</a></li>
<li class="toctree-l1"><a class="reference internal" href="demonstrations/demonstrations.html#optics">4. Optics</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api_reference/core/core.html">1. Raysect Core</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_reference/primitives/primitives.html">2. Primitives Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_reference/optical/optical.html">3. Optical Module</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Raysect</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li><span class="section-number">7. </span>Primitives</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/primitives.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="primitives">
<h1><span class="section-number">7. </span>Primitives<a class="headerlink" href="#primitives" title="Permalink to this headline">¶</a></h1>
<p>The raysect primitives: sphere; box; cylinder; and cone.</p>
<img alt="_images/raysect_primitives.png" class="align-center" src="_images/raysect_primitives.png" />
<div class="section" id="geometric-primitives">
<h2><span class="section-number">7.1. </span>Geometric Primitives<a class="headerlink" href="#geometric-primitives" title="Permalink to this headline">¶</a></h2>
<div class="section" id="sphere">
<h3><span class="section-number">7.1.1. </span>Sphere<a class="headerlink" href="#sphere" title="Permalink to this headline">¶</a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="raysect.primitive.Sphere">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">raysect.primitive.</span></span><span class="sig-name descname"><span class="pre">Sphere</span></span><a class="headerlink" href="#raysect.primitive.Sphere" title="Permalink to this definition">¶</a></dt>
<dd><p>A sphere primitive.</p>
<p>The sphere is centered at the origin of the local co-ordinate system.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>radius</strong> (<em>float</em>) – Radius of the sphere in meters (default = 0.5).</p></li>
<li><p><strong>parent</strong> (<a class="reference internal" href="api_reference/core/raysect_core_scenegraph.html#raysect.core.scenegraph.node.Node" title="raysect.core.scenegraph.node.Node"><em>Node</em></a>) – Scene-graph parent node or None (default = None).</p></li>
<li><p><strong>transform</strong> (<a class="reference internal" href="api_reference/core/affinematrix.html#raysect.core.math.affinematrix.AffineMatrix3D" title="raysect.core.math.affinematrix.AffineMatrix3D"><em>AffineMatrix3D</em></a>) – An AffineMatrix3D defining the local co-ordinate system relative to the scene-graph parent (default = identity matrix).</p></li>
<li><p><strong>material</strong> (<a class="reference internal" href="api_reference/optical/optical_material_base_classes.html#raysect.optical.material.material.Material" title="raysect.optical.material.material.Material"><em>Material</em></a>) – A Material object defining the sphere’s material (default = None).</p></li>
<li><p><strong>name</strong> (<em>str</em>) – A string specifying a user-friendly name for the sphere (default = “”).</p></li>
</ul>
</dd>
<dt class="field-even">Variables</dt>
<dd class="field-even"><p><strong>radius</strong> (<em>float</em>) – The radius of the sphere in meters.</p>
</dd>
</dl>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.core</span> <span class="kn">import</span> <span class="n">translate</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.primitive</span> <span class="kn">import</span> <span class="n">Sphere</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.optical</span> <span class="kn">import</span> <span class="n">World</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.optical.material</span> <span class="kn">import</span> <span class="n">UniformSurfaceEmitter</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.optical.library.spectra.colours</span> <span class="kn">import</span> <span class="n">orange</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="n">world</span> <span class="o">=</span> <span class="n">World</span><span class="p">()</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="n">sphere</span> <span class="o">=</span> <span class="n">Sphere</span><span class="p">(</span><span class="mf">2.5</span><span class="p">,</span> <span class="n">parent</span><span class="o">=</span><span class="n">world</span><span class="p">,</span> <span class="n">transform</span><span class="o">=</span><span class="n">translate</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
<span class="go"> material=UniformSurfaceEmitter(orange), name="orange sphere")</span>
</pre></div>
</div>
</dd></dl>
</div>
<div class="section" id="box">
<h3><span class="section-number">7.1.2. </span>Box<a class="headerlink" href="#box" title="Permalink to this headline">¶</a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="raysect.primitive.Box">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">raysect.primitive.</span></span><span class="sig-name descname"><span class="pre">Box</span></span><a class="headerlink" href="#raysect.primitive.Box" title="Permalink to this definition">¶</a></dt>
<dd><p>A box primitive.</p>
<p>The box is defined by lower and upper points in the local co-ordinate
system.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>lower</strong> (<a class="reference internal" href="api_reference/core/points_and_vectors.html#raysect.core.math.point.Point3D" title="raysect.core.math.point.Point3D"><em>Point3D</em></a>) – Lower point of the box (default = Point3D(-0.5, -0.5, -0.5)).</p></li>
<li><p><strong>upper</strong> (<a class="reference internal" href="api_reference/core/points_and_vectors.html#raysect.core.math.point.Point3D" title="raysect.core.math.point.Point3D"><em>Point3D</em></a>) – Upper point of the box (default = Point3D(0.5, 0.5, 0.5)).</p></li>
<li><p><strong>parent</strong> (<a class="reference internal" href="api_reference/core/raysect_core_scenegraph.html#raysect.core.scenegraph.node.Node" title="raysect.core.scenegraph.node.Node"><em>Node</em></a>) – Scene-graph parent node or None (default = None).</p></li>
<li><p><strong>transform</strong> (<a class="reference internal" href="api_reference/core/affinematrix.html#raysect.core.math.affinematrix.AffineMatrix3D" title="raysect.core.math.affinematrix.AffineMatrix3D"><em>AffineMatrix3D</em></a>) – An AffineMatrix3D defining the local co-ordinate system relative to the scene-graph parent (default = identity matrix).</p></li>
<li><p><strong>material</strong> (<a class="reference internal" href="api_reference/optical/optical_material_base_classes.html#raysect.optical.material.material.Material" title="raysect.optical.material.material.Material"><em>Material</em></a>) – A Material object defining the box’s material (default = None).</p></li>
<li><p><strong>name</strong> (<em>str</em>) – A string specifying a user-friendly name for the box (default = “”).</p></li>
</ul>
</dd>
</dl>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.core</span> <span class="kn">import</span> <span class="n">Point3D</span><span class="p">,</span> <span class="n">translate</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.primitive</span> <span class="kn">import</span> <span class="n">Box</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.optical</span> <span class="kn">import</span> <span class="n">World</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.optical.material</span> <span class="kn">import</span> <span class="n">UniformSurfaceEmitter</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.optical.library.spectra.colours</span> <span class="kn">import</span> <span class="n">red</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="n">world</span> <span class="o">=</span> <span class="n">World</span><span class="p">()</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="n">cube</span> <span class="o">=</span> <span class="n">Box</span><span class="p">(</span><span class="n">Point3D</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">),</span> <span class="n">Point3D</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mi">1</span><span class="p">),</span> <span class="n">parent</span><span class="o">=</span><span class="n">world</span><span class="p">,</span> <span class="n">transform</span><span class="o">=</span><span class="n">translate</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
<span class="go"> material=UniformSurfaceEmitter(red), name="red cube")</span>
</pre></div>
</div>
</dd></dl>
</div>
<div class="section" id="cylinder">
<h3><span class="section-number">7.1.3. </span>Cylinder<a class="headerlink" href="#cylinder" title="Permalink to this headline">¶</a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="raysect.primitive.Cylinder">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">raysect.primitive.</span></span><span class="sig-name descname"><span class="pre">Cylinder</span></span><a class="headerlink" href="#raysect.primitive.Cylinder" title="Permalink to this definition">¶</a></dt>
<dd><p>A cylinder primitive.</p>
<p>The cylinder is defined by a radius and height. It lies along the z-axis
and extends over the z range [0, height]. The ends of the cylinder are
capped with disks forming a closed surface.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>radius</strong> (<em>float</em>) – Radius of the cylinder in meters (default = 0.5).</p></li>
<li><p><strong>height</strong> (<em>float</em>) – Height of the cylinder in meters (default = 1.0).</p></li>
<li><p><strong>parent</strong> (<a class="reference internal" href="api_reference/core/raysect_core_scenegraph.html#raysect.core.scenegraph.node.Node" title="raysect.core.scenegraph.node.Node"><em>Node</em></a>) – Scene-graph parent node or None (default = None).</p></li>
<li><p><strong>transform</strong> (<a class="reference internal" href="api_reference/core/affinematrix.html#raysect.core.math.affinematrix.AffineMatrix3D" title="raysect.core.math.affinematrix.AffineMatrix3D"><em>AffineMatrix3D</em></a>) – An AffineMatrix3D defining the local co-ordinate
system relative to the scene-graph parent (default = identity matrix).</p></li>
<li><p><strong>material</strong> (<a class="reference internal" href="api_reference/optical/optical_material_base_classes.html#raysect.optical.material.material.Material" title="raysect.optical.material.material.Material"><em>Material</em></a>) – A Material object defining the cylinder’s material (default = None).</p></li>
<li><p><strong>name</strong> (<em>str</em>) – A string specifying a user-friendly name for the cylinder (default = “”).</p></li>
</ul>
</dd>
</dl>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.core</span> <span class="kn">import</span> <span class="n">translate</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.primitive</span> <span class="kn">import</span> <span class="n">Cylinder</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.optical</span> <span class="kn">import</span> <span class="n">World</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.optical.material</span> <span class="kn">import</span> <span class="n">UniformSurfaceEmitter</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.optical.library.spectra.colours</span> <span class="kn">import</span> <span class="n">blue</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="n">world</span> <span class="o">=</span> <span class="n">World</span><span class="p">()</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="n">cylinder</span> <span class="o">=</span> <span class="n">Cylinder</span><span class="p">(</span><span class="mf">0.5</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">,</span> <span class="n">parent</span><span class="o">=</span><span class="n">world</span><span class="p">,</span> <span class="n">transform</span><span class="o">=</span><span class="n">translate</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">),</span>
<span class="go"> material=UniformSurfaceEmitter(blue), name="blue cylinder")</span>
</pre></div>
</div>
</dd></dl>
</div>
<div class="section" id="cone">
<h3><span class="section-number">7.1.4. </span>Cone<a class="headerlink" href="#cone" title="Permalink to this headline">¶</a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="raysect.primitive.Cone">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">raysect.primitive.</span></span><span class="sig-name descname"><span class="pre">Cone</span></span><a class="headerlink" href="#raysect.primitive.Cone" title="Permalink to this definition">¶</a></dt>
<dd><p>A cone primitive.</p>
<p>The cone is defined by a radius and height. It lies along the z-axis
and extends over the z range [0, height]. The tip of the cone lies at
z = height. The base of the cone sits on the x-y plane and is capped
with a disk, forming a closed surface.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>radius</strong> (<em>float</em>) – Radius of the cone in meters in x-y plane (default = 0.5).</p></li>
<li><p><strong>height</strong> (<em>float</em>) – Height of the cone in meters (default = 1.0).</p></li>
<li><p><strong>parent</strong> (<a class="reference internal" href="api_reference/core/raysect_core_scenegraph.html#raysect.core.scenegraph.node.Node" title="raysect.core.scenegraph.node.Node"><em>Node</em></a>) – Scene-graph parent node or None (default = None).</p></li>
<li><p><strong>transform</strong> (<a class="reference internal" href="api_reference/core/affinematrix.html#raysect.core.math.affinematrix.AffineMatrix3D" title="raysect.core.math.affinematrix.AffineMatrix3D"><em>AffineMatrix3D</em></a>) – An AffineMatrix3D defining the local co-ordinate
system relative to the scene-graph parent (default = identity matrix).</p></li>
<li><p><strong>material</strong> (<a class="reference internal" href="api_reference/optical/optical_material_base_classes.html#raysect.optical.material.material.Material" title="raysect.optical.material.material.Material"><em>Material</em></a>) – A Material object defining the cone’s material (default = None).</p></li>
<li><p><strong>name</strong> (<em>str</em>) – A string specifying a user-friendly name for the cone (default = “”).</p></li>
</ul>
</dd>
</dl>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.core</span> <span class="kn">import</span> <span class="n">translate</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.primitive</span> <span class="kn">import</span> <span class="n">Box</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.optical</span> <span class="kn">import</span> <span class="n">World</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.optical.material</span> <span class="kn">import</span> <span class="n">UniformSurfaceEmitter</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.optical.library.spectra.colours</span> <span class="kn">import</span> <span class="n">green</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="n">world</span> <span class="o">=</span> <span class="n">World</span><span class="p">()</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="n">cone</span> <span class="o">=</span> <span class="n">Cone</span><span class="p">(</span><span class="mf">0.5</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">,</span> <span class="n">parent</span><span class="o">=</span><span class="n">world</span><span class="p">,</span> <span class="n">transform</span><span class="o">=</span><span class="n">translate</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">),</span>
<span class="go"> material=UniformSurfaceEmitter(green), name="green cone")</span>
</pre></div>
</div>
</dd></dl>
</div>
</div>
<div class="section" id="csg-operations">
<h2><span class="section-number">7.2. </span>CSG Operations<a class="headerlink" href="#csg-operations" title="Permalink to this headline">¶</a></h2>
<p>Operations such as union, substract, intersect on some basic glass primitives:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Making the lense in the centre</span>
<span class="n">s1</span> <span class="o">=</span> <span class="n">Sphere</span><span class="p">(</span><span class="mf">1.0</span><span class="p">,</span> <span class="n">transform</span><span class="o">=</span><span class="n">translate</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mf">1.0</span><span class="o">-</span><span class="mf">0.01</span><span class="p">))</span>
<span class="n">s2</span> <span class="o">=</span> <span class="n">Sphere</span><span class="p">(</span><span class="mf">0.5</span><span class="p">,</span> <span class="n">transform</span><span class="o">=</span><span class="n">translate</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.5</span><span class="o">+</span><span class="mf">0.01</span><span class="p">))</span>
<span class="n">Intersect</span><span class="p">(</span><span class="n">s1</span><span class="p">,</span> <span class="n">s2</span><span class="p">,</span> <span class="n">world</span><span class="p">,</span> <span class="n">translate</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="o">-</span><span class="mf">3.6</span><span class="p">)</span><span class="o">*</span><span class="n">rotate</span><span class="p">(</span><span class="mi">50</span><span class="p">,</span><span class="mi">50</span><span class="p">,</span><span class="mi">0</span><span class="p">),</span> <span class="n">glass</span><span class="p">)</span>
<span class="c1"># More complex glass structure</span>
<span class="n">cyl_x</span> <span class="o">=</span> <span class="n">Cylinder</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mf">4.2</span><span class="p">,</span> <span class="n">transform</span><span class="o">=</span><span class="n">rotate</span><span class="p">(</span><span class="mi">90</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span><span class="o">*</span><span class="n">translate</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="mf">2.1</span><span class="p">))</span>
<span class="n">cyl_y</span> <span class="o">=</span> <span class="n">Cylinder</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mf">4.2</span><span class="p">,</span> <span class="n">transform</span><span class="o">=</span><span class="n">rotate</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">90</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span><span class="o">*</span><span class="n">translate</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="mf">2.1</span><span class="p">))</span>
<span class="n">cyl_z</span> <span class="o">=</span> <span class="n">Cylinder</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mf">4.2</span><span class="p">,</span> <span class="n">transform</span><span class="o">=</span><span class="n">rotate</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span><span class="o">*</span><span class="n">translate</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="mf">2.1</span><span class="p">))</span>
<span class="n">cube</span> <span class="o">=</span> <span class="n">Box</span><span class="p">(</span><span class="n">Point3D</span><span class="p">(</span><span class="o">-</span><span class="mf">1.5</span><span class="p">,</span> <span class="o">-</span><span class="mf">1.5</span><span class="p">,</span> <span class="o">-</span><span class="mf">1.5</span><span class="p">),</span> <span class="n">Point3D</span><span class="p">(</span><span class="mf">1.5</span><span class="p">,</span> <span class="mf">1.5</span><span class="p">,</span> <span class="mf">1.5</span><span class="p">))</span>
<span class="n">sphere</span> <span class="o">=</span> <span class="n">Sphere</span><span class="p">(</span><span class="mf">2.0</span><span class="p">)</span>
<span class="n">Intersect</span><span class="p">(</span><span class="n">sphere</span><span class="p">,</span> <span class="n">Subtract</span><span class="p">(</span><span class="n">cube</span><span class="p">,</span> <span class="n">Union</span><span class="p">(</span><span class="n">Union</span><span class="p">(</span><span class="n">cyl_x</span><span class="p">,</span> <span class="n">cyl_y</span><span class="p">),</span> <span class="n">cyl_z</span><span class="p">)),</span> <span class="n">world</span><span class="p">,</span> <span class="n">translate</span><span class="p">(</span><span class="o">-</span><span class="mf">2.1</span><span class="p">,</span><span class="mf">2.1</span><span class="p">,</span><span class="mf">2.5</span><span class="p">)</span><span class="o">*</span><span class="n">rotate</span><span class="p">(</span><span class="mi">30</span><span class="p">,</span> <span class="o">-</span><span class="mi">20</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="n">glass</span><span class="p">)</span>
</pre></div>
</div>
<img alt="_images/csg_glass.png" class="align-center" src="_images/csg_glass.png" />
</div>
<div class="section" id="meshes">
<h2><span class="section-number">7.3. </span>Meshes<a class="headerlink" href="#meshes" title="Permalink to this headline">¶</a></h2>
<p>It is easiest to import meshes from existing CAD files in either obj or stl with the helper methods.</p>
<dl class="py function">
<dt class="sig sig-object py" id="raysect.primitive.mesh.obj.import_obj">
<span class="sig-prename descclassname"><span class="pre">raysect.primitive.mesh.obj.</span></span><span class="sig-name descname"><span class="pre">import_obj</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scaling</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#raysect.primitive.mesh.obj.import_obj" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a mesh instance from a Wavefront OBJ mesh file (.obj).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>filename</strong> (<em>str</em>) – Mesh file path.</p></li>
<li><p><strong>scaling</strong> (<em>double</em>) – Scale the mesh by this factor (default=1.0).</p></li>
<li><p><strong>kwargs</strong> – Accepts optional keyword arguments from the Mesh class.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="api_reference/primitives/meshes.html#raysect.primitive.mesh.mesh.Mesh" title="raysect.primitive.mesh.mesh.Mesh">Mesh</a></p>
</dd>
</dl>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.optical</span> <span class="kn">import</span> <span class="n">World</span><span class="p">,</span> <span class="n">translate</span><span class="p">,</span> <span class="n">rotate</span><span class="p">,</span> <span class="n">ConstantSF</span><span class="p">,</span> <span class="n">Sellmeier</span><span class="p">,</span> <span class="n">Dielectric</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.primitive</span> <span class="kn">import</span> <span class="n">import_obj</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="n">world</span> <span class="o">=</span> <span class="n">World</span><span class="p">()</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="n">diamond</span> <span class="o">=</span> <span class="n">Dielectric</span><span class="p">(</span><span class="n">Sellmeier</span><span class="p">(</span><span class="mf">0.3306</span><span class="p">,</span> <span class="mf">4.3356</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.1750</span><span class="o">**</span><span class="mi">2</span><span class="p">,</span> <span class="mf">0.1060</span><span class="o">**</span><span class="mi">2</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">),</span>
<span class="gp">>>> </span> <span class="n">ConstantSF</span><span class="p">(</span><span class="mf">1.0</span><span class="p">))</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="n">bunny_mesh</span> <span class="o">=</span> <span class="n">import_obj</span><span class="p">(</span><span class="s2">"resources/stanford_bunny.obj"</span><span class="p">,</span> <span class="n">scaling</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">parent</span><span class="o">=</span><span class="n">world</span><span class="p">,</span>
<span class="gp">>>> </span> <span class="n">transform</span><span class="o">=</span><span class="n">translate</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span><span class="o">*</span><span class="n">rotate</span><span class="p">(</span><span class="mi">165</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="n">material</span><span class="o">=</span><span class="n">diamond</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="raysect.primitive.mesh.stl.import_stl">
<span class="sig-prename descclassname"><span class="pre">raysect.primitive.mesh.stl.</span></span><span class="sig-name descname"><span class="pre">import_stl</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scaling</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'auto'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#raysect.primitive.mesh.stl.import_stl" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a mesh instance from a STereoLithography (STL) mesh file (.stl).</p>
<p>Some engineering meshes are exported in different units (mm for example)
whereas Raysect units are in m. Applying a scale factor of 0.001 would
convert the mesh into m for use in Raysect.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>filename</strong> (<em>str</em>) – Mesh file path.</p></li>
<li><p><strong>scaling</strong> (<em>double</em>) – Scale the mesh by this factor (default=1.0).</p></li>
<li><p><strong>mode</strong> (<em>str</em>) – The file format to load: ‘ascii’, ‘binary’, ‘auto’ (default=’auto’).</p></li>
<li><p><strong>kwargs</strong> – Accepts optional keyword arguments from the Mesh class.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="api_reference/primitives/meshes.html#raysect.primitive.mesh.mesh.Mesh" title="raysect.primitive.mesh.mesh.Mesh">Mesh</a></p>
</dd>
</dl>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.optical</span> <span class="kn">import</span> <span class="n">World</span><span class="p">,</span> <span class="n">translate</span><span class="p">,</span> <span class="n">rotate</span><span class="p">,</span> <span class="n">ConstantSF</span><span class="p">,</span> <span class="n">Sellmeier</span><span class="p">,</span> <span class="n">Dielectric</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">raysect.primitive</span> <span class="kn">import</span> <span class="n">import_stl</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="n">world</span> <span class="o">=</span> <span class="n">World</span><span class="p">()</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="n">diamond</span> <span class="o">=</span> <span class="n">Dielectric</span><span class="p">(</span><span class="n">Sellmeier</span><span class="p">(</span><span class="mf">0.3306</span><span class="p">,</span> <span class="mf">4.3356</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.1750</span><span class="o">**</span><span class="mi">2</span><span class="p">,</span> <span class="mf">0.1060</span><span class="o">**</span><span class="mi">2</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">),</span>
<span class="gp">>>> </span> <span class="n">ConstantSF</span><span class="p">(</span><span class="mf">1.0</span><span class="p">))</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="n">mesh</span> <span class="o">=</span> <span class="n">import_stl</span><span class="p">(</span><span class="s2">"my_mesh.stl"</span><span class="p">,</span> <span class="n">scaling</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s1">'binary'</span><span class="p">,</span> <span class="n">parent</span><span class="o">=</span><span class="n">world</span><span class="p">,</span>
<span class="gp">>>> </span> <span class="n">transform</span><span class="o">=</span><span class="n">translate</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span><span class="o">*</span><span class="n">rotate</span><span class="p">(</span><span class="mi">165</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="n">material</span><span class="o">=</span><span class="n">diamond</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<p>An example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">raysect.primitive.mesh</span> <span class="kn">import</span> <span class="n">import_obj</span>
<span class="n">mesh</span> <span class="o">=</span> <span class="n">import_obj</span><span class="p">(</span><span class="s2">"./resources/stanford_bunny.obj"</span><span class="p">,</span> <span class="n">scaling</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">parent</span><span class="o">=</span><span class="n">world</span><span class="p">,</span>
<span class="n">transform</span><span class="o">=</span><span class="n">translate</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span><span class="o">*</span><span class="n">rotate</span><span class="p">(</span><span class="mi">165</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="n">material</span><span class="o">=</span><span class="n">gold</span><span class="p">)</span>
</pre></div>
</div>
<img alt="_images/gold_bunny.png" class="align-center" src="_images/gold_bunny.png" />
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="materials.html" class="btn btn-neutral float-right" title="8. Materials" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="observers.html" class="btn btn-neutral float-left" title="6. Sampling and Observers" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2014-2021, Dr Alex Meakins.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>