09ac75d2fbe4157d8c954bdd376387b82715861e
[sixth-3d-demos.git] / doc / index.html
1 <!doctype html>
2 <html lang="en">
3 <head>
4 <title>Sixth 3D engine demos</title>
5 <!-- 2018-06-22 Fri 02:53 -->
6 <meta charset="utf-8">
7 <meta name="viewport" content="width=device-width, initial-scale=1">
8 <meta name="generator" content="Org-mode">
9 <meta name="author" content="Svjatoslav Agejenko">
10 <link href="https://bootswatch.com/4/darkly/bootstrap.min.css" rel="stylesheet">
11 <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
12 <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.1/js/bootstrap.min.js"></script>"
13 <style type="text/css">
14 footer {background-color: #111 !important;}
15 pre {background-color: #111; color: #ccc;}
16 </style>
17 <style type="text/css">
18 /* org mode styles on top of twbs */
19
20 html {
21     position: relative;
22     min-height: 100%;
23 }
24
25 body {
26     font-size: 18px;
27     margin-bottom: 105px;
28 }
29
30 footer {
31     position: absolute;
32     bottom: 0;
33     width: 100%;
34     height: 101px;
35     background-color: #f5f5f5;
36 }
37
38 footer > div {
39     padding: 10px;
40 }
41
42 footer p {
43     margin: 0 0 5px;
44     text-align: center;
45     font-size: 16px;
46 }
47
48 #table-of-contents {
49     margin-top: 20px;
50     margin-bottom: 20px;
51 }
52
53 blockquote p {
54     font-size: 18px;
55 }
56
57 pre {
58     font-size: 16px;
59 }
60
61 .footpara {
62     display: inline-block;
63 }
64
65 figcaption {
66   font-size: 16px;
67   color: #666;
68   font-style: italic;
69   padding-bottom: 15px;
70 }
71
72 /* from twbs docs */
73
74 .bs-docs-sidebar.affix {
75     position: static;
76 }
77 @media (min-width: 768px) {
78     .bs-docs-sidebar {
79         padding-left: 20px;
80     }
81 }
82
83 /* All levels of nav */
84 .bs-docs-sidebar .nav > li > a {
85     display: block;
86     padding: 4px 20px;
87     font-size: 14px;
88     font-weight: 500;
89     color: #999;
90 }
91 .bs-docs-sidebar .nav > li > a:hover,
92 .bs-docs-sidebar .nav > li > a:focus {
93     padding-left: 19px;
94     color: #A1283B;
95     text-decoration: none;
96     background-color: transparent;
97     border-left: 1px solid #A1283B;
98 }
99 .bs-docs-sidebar .nav > .active > a,
100 .bs-docs-sidebar .nav > .active:hover > a,
101 .bs-docs-sidebar .nav > .active:focus > a {
102     padding-left: 18px;
103     font-weight: bold;
104     color: #A1283B;
105     background-color: transparent;
106     border-left: 2px solid #A1283B;
107 }
108
109 /* Nav: second level (shown on .active) */
110 .bs-docs-sidebar .nav .nav {
111     display: none; /* Hide by default, but at >768px, show it */
112     padding-bottom: 10px;
113 }
114 .bs-docs-sidebar .nav .nav > li > a {
115     padding-top: 1px;
116     padding-bottom: 1px;
117     padding-left: 30px;
118     font-size: 12px;
119     font-weight: normal;
120 }
121 .bs-docs-sidebar .nav .nav > li > a:hover,
122 .bs-docs-sidebar .nav .nav > li > a:focus {
123     padding-left: 29px;
124 }
125 .bs-docs-sidebar .nav .nav > .active > a,
126 .bs-docs-sidebar .nav .nav > .active:hover > a,
127 .bs-docs-sidebar .nav .nav > .active:focus > a {
128     padding-left: 28px;
129     font-weight: 500;
130 }
131
132 /* Nav: third level (shown on .active) */
133 .bs-docs-sidebar .nav .nav .nav {
134     padding-bottom: 10px;
135 }
136 .bs-docs-sidebar .nav .nav .nav > li > a {
137     padding-top: 1px;
138     padding-bottom: 1px;
139     padding-left: 40px;
140     font-size: 12px;
141     font-weight: normal;
142 }
143 .bs-docs-sidebar .nav .nav .nav > li > a:hover,
144 .bs-docs-sidebar .nav .nav .nav > li > a:focus {
145     padding-left: 39px;
146 }
147 .bs-docs-sidebar .nav .nav .nav > .active > a,
148 .bs-docs-sidebar .nav .nav .nav > .active:hover > a,
149 .bs-docs-sidebar .nav .nav .nav > .active:focus > a {
150     padding-left: 38px;
151     font-weight: 500;
152 }
153
154 /* Show and affix the side nav when space allows it */
155 @media (min-width: 992px) {
156     .bs-docs-sidebar .nav > .active > ul {
157         display: block;
158     }
159     /* Widen the fixed sidebar */
160     .bs-docs-sidebar.affix,
161     .bs-docs-sidebar.affix-bottom {
162         width: 213px;
163     }
164     .bs-docs-sidebar.affix {
165         position: fixed; /* Undo the static from mobile first approach */
166         top: 20px;
167     }
168     .bs-docs-sidebar.affix-bottom {
169         position: absolute; /* Undo the static from mobile first approach */
170     }
171     .bs-docs-sidebar.affix .bs-docs-sidenav,.bs-docs-sidebar.affix-bottom .bs-docs-sidenav {
172         margin-top: 0;
173         margin-bottom: 0
174     }
175 }
176 @media (min-width: 1200px) {
177     /* Widen the fixed sidebar again */
178     .bs-docs-sidebar.affix-bottom,
179     .bs-docs-sidebar.affix {
180         width: 263px;
181     }
182 }
183 </style>
184 <script type="text/javascript">
185 $(function() {
186     'use strict';
187
188     $('.bs-docs-sidebar li').first().addClass('active');
189
190     $(document.body).scrollspy({target: '.bs-docs-sidebar'});
191
192     $('.bs-docs-sidebar').affix();
193 });
194 </script>
195 </head>
196 <body>
197 <div id="content" class="container">
198 <div class="row"><div class="col-md-9"><h1 class="title">Sixth 3D engine demos</h1>
199 <hr >
200 <ul class="org-ul">
201 <li>This is a subproject of <a href="http://www3.svjatoslav.eu/projects/sixth-3d/">Sixth 3D</a> which in turn is a subproject of
202 <a href="http://www3.svjatoslav.eu/projects/sixth/">Sixth</a>.
203 </li>
204
205 <li>Clone GIT repository using command:
206 <pre class="example">
207 git clone http://www2.svjatoslav.eu/git/sixth-3d-demos.git
208 </pre>
209 </li>
210
211 <li><a href="http://www2.svjatoslav.eu/gitweb/?p=sixth-3d-demos.git;a=snapshot;h=HEAD;sf=tgz">Download latest snapshot in TAR GZ format</a>
212 </li>
213
214 <li>This program is free software: you can redistribute it and/or modify
215 it under the terms of the <a href="https://www.gnu.org/licenses/lgpl.html">GNU Lesser General Public License</a> as
216 published by the Free Software Foundation, either version 3 of the
217 License, or (at your option) any later version.
218 </li>
219
220 <li>Program author:
221 <ul class="org-ul">
222 <li>Svjatoslav Agejenko
223 </li>
224 <li>Homepage: <a href="http://svjatoslav.eu">http://svjatoslav.eu</a>
225 </li>
226 <li>Email: <a href="mailto://svjatoslav@svjatoslav.eu">mailto://svjatoslav@svjatoslav.eu</a>
227 </li>
228 </ul>
229 </li>
230
231 <li><a href="http://www.svjatoslav.eu/projects/">Other software projects hosted at svjatoslav.eu</a>
232 </li>
233 </ul>
234
235 <div id="outline-container-sec-1" class="outline-2">
236 <h2 id="sec-1"><span class="section-number-2">1</span> Overview</h2>
237 <div class="outline-text-2" id="text-1">
238 <p>
239 Goal of this project is to show off capabilities and API usage of
240 <a href="http://www3.svjatoslav.eu/projects/sixth-3d/">Sixth 3D</a> engine.
241 </p>
242
243 <p>
244 All sample scenes below are rendered at interactive framerates.
245 </p>
246 </div>
247 </div>
248 <div id="outline-container-sec-2" class="outline-2">
249 <h2 id="sec-2"><span class="section-number-2">2</span> Navigating in space</h2>
250 <div class="outline-text-2" id="text-2">
251 <table class="table table-striped table-bordered table-hover table-condensed">
252
253
254 <colgroup>
255 <col  class="left">
256
257 <col  class="left">
258 </colgroup>
259 <thead>
260 <tr>
261 <th scope="col" class="text-left">key</th>
262 <th scope="col" class="text-left">result</th>
263 </tr>
264 </thead>
265 <tbody>
266 <tr>
267 <td class="text-left">cursor keys</td>
268 <td class="text-left">move: left, right, forward, backward</td>
269 </tr>
270
271 <tr>
272 <td class="text-left">mouse scroll wheel</td>
273 <td class="text-left">move: up, down</td>
274 </tr>
275
276 <tr>
277 <td class="text-left">dragging with mouse</td>
278 <td class="text-left">look around</td>
279 </tr>
280 </tbody>
281 </table>
282 </div>
283 </div>
284
285 <div id="outline-container-sec-3" class="outline-2">
286 <h2 id="sec-3"><span class="section-number-2">3</span> Samples</h2>
287 <div class="outline-text-2" id="text-3">
288 </div><div id="outline-container-sec-3-1" class="outline-3">
289 <h3 id="sec-3-1"><span class="section-number-3">3.1</span> Raytracing through voxels</h3>
290 <div class="outline-text-3" id="text-3-1">
291
292 <figure>
293 <p><img src="screenshots/raytracing fractal in voxel polygon hybrid scene.png" class="img-responsive" alt="raytracing fractal in voxel polygon hybrid scene.png">
294 </p>
295 </figure>
296
297 <p>
298 Test scene that is generated simultaneously using:
299 </p>
300 <ul class="org-ul">
301 <li>conventional polygons
302 <ul class="org-ul">
303 <li>for realtime navigation, and
304 </li>
305 </ul>
306 </li>
307 <li>voxels
308 <ul class="org-ul">
309 <li>for on-demand raytracing
310 </li>
311 </ul>
312 </li>
313 </ul>
314
315 <p>
316 Instead of storing voxels in dumb [X * Y * Z] array, dynamically
317 partitioned <a href="https://en.wikipedia.org/wiki/Octree">octree</a> is used to compress data. Press "r" key anywhere in
318 the scene to raytrace current view through compressed voxel
319 datastructure.
320 </p>
321 </div>
322 </div>
323
324 <div id="outline-container-sec-3-2" class="outline-3">
325 <h3 id="sec-3-2"><span class="section-number-3">3.2</span> Conway's Game of Life</h3>
326 <div class="outline-text-3" id="text-3-2">
327 <p>
328 The Game of Life, also known simply as Life, is a cellular automaton
329 devised by the British mathematician John Horton Conway in 1970.
330 </p>
331
332 <ul class="org-ul">
333 <li><a href="https://en.wikipedia.org/wiki/Conway's_Game_of_Life">https://en.wikipedia.org/wiki/Conway's_Game_of_Life</a>
334 <ul class="org-ul">
335 <li>Game rules:
336 <ul class="org-ul">
337 <li>2 cell states: alive / dead
338 </li>
339 <li>Each cell sees 8 neighboring cells.
340 </li>
341 <li>If alive cell neighbors count is 2 or 3, then cell survives,
342 otherwise it dies.
343 </li>
344 <li>Dead cell becomes alive if neighbors count is exactly 3.
345 </li>
346 </ul>
347 </li>
348 </ul>
349 </li>
350 </ul>
351
352
353 <figure>
354 <p><img src="screenshots/life.png" class="img-responsive" alt="life.png">
355 </p>
356 </figure>
357
358 <p>
359 Current application projects 2D game grid/matrix onto three
360 dimensional space. Extra dimension (height) is used to visualize
361 history (previous iterations) using glowing dots suspended in space.
362 </p>
363
364 <p>
365 Usage:
366 </p>
367 <table class="table table-striped table-bordered table-hover table-condensed">
368
369
370 <colgroup>
371 <col  class="left">
372
373 <col  class="left">
374 </colgroup>
375 <thead>
376 <tr>
377 <th scope="col" class="text-left">key</th>
378 <th scope="col" class="text-left">result</th>
379 </tr>
380 </thead>
381 <tbody>
382 <tr>
383 <td class="text-left">mouse click on the cell (cell)</td>
384 <td class="text-left">toggles cell state</td>
385 </tr>
386
387 <tr>
388 <td class="text-left">&lt;space&gt;</td>
389 <td class="text-left">next iteration</td>
390 </tr>
391
392 <tr>
393 <td class="text-left">ENTER</td>
394 <td class="text-left">next iteeration with the history</td>
395 </tr>
396
397 <tr>
398 <td class="text-left">"c"</td>
399 <td class="text-left">clear the matrix</td>
400 </tr>
401 </tbody>
402 </table>
403 </div>
404 </div>
405
406 <div id="outline-container-sec-3-3" class="outline-3">
407 <h3 id="sec-3-3"><span class="section-number-3">3.3</span> Text editors</h3>
408 <div class="outline-text-3" id="text-3-3">
409
410 <figure>
411 <p><img src="screenshots/text editors.png" class="img-responsive" alt="text editors.png">
412 </p>
413 </figure>
414
415 <p>
416 Initial test for creating user interfaces in 3D and:
417 </p>
418 <ul class="org-ul">
419 <li>window focus handling
420 </li>
421 <li>picking objecs using mouse
422 </li>
423 <li>redirecting keyboard input to focused window
424 </li>
425 </ul>
426
427
428 <p>
429 Window focus acts like a stack.
430 </p>
431
432 <p>
433 When window is clicked with the mouse, previously focused window (if
434 any) is pushed to the focus stack and new window receives focus. Red
435 frame appears around the window to indicate this.
436 </p>
437
438 <p>
439 When ESC key is pressed, window focus is returned to previous window
440 (if any).
441 </p>
442
443 <p>
444 When any window is focused, all keyboard input is redirected to that
445 window, including cursor keys. To be able to navigate around the world
446 again, window must be unfocused first using ESC key.
447 </p>
448
449
450 <ul class="org-ul">
451 <li>TODO:
452 <ul class="org-ul">
453 <li>Improve focus handling:
454 <ul class="org-ul">
455 <li>Perhaps add shortcut to navigate world without exiting entire
456 stack of focus.
457 </li>
458 <li>Possibility to retain and reuse recently focused elements.
459 </li>
460 <li>Store user location in the world and view direction with the
461 focused window. So that when returning focus to far away object,
462 user is redirected also to proper location in the world.
463 </li>
464 </ul>
465 </li>
466 <li>Possibility to store recently visited locations in the world and
467 return to them.
468 </li>
469 </ul>
470 </li>
471 </ul>
472 </div>
473 </div>
474 <div id="outline-container-sec-3-4" class="outline-3">
475 <h3 id="sec-3-4"><span class="section-number-3">3.4</span> Mathematical formulas</h3>
476 <div class="outline-text-3" id="text-3-4">
477
478 <figure>
479 <p><img src="screenshots/mathematical formulas.png" class="img-responsive" alt="mathematical formulas.png">
480 </p>
481 </figure>
482
483 <ul class="org-ul">
484 <li>TODO: instead of projecting 2D visualizations onto 3D space,
485 visualize some formula using all 3 dimensions avaliable.
486 </li>
487 </ul>
488 </div>
489 </div>
490 <div id="outline-container-sec-3-5" class="outline-3">
491 <h3 id="sec-3-5"><span class="section-number-3">3.5</span> Sinus heightmaps and sphere</h3>
492 <div class="outline-text-3" id="text-3-5">
493
494 <figure>
495 <p><img src="screenshots/sinus heightmaps and sphere.png" class="img-responsive" alt="sinus heightmaps and sphere.png">
496 </p>
497 </figure>
498
499 <p>
500 Simple test scene. Easy to implement and looks nice.
501 </p>
502 </div>
503 </div>
504 </div>
505 </div><div class="col-md-3"><nav id="table-of-contents">
506 <div id="text-table-of-contents" class="bs-docs-sidebar">
507 <ul class="nav">
508 <li><a href="#sec-1">1. Overview</a></li>
509 <li><a href="#sec-2">2. Navigating in space</a></li>
510 <li><a href="#sec-3">3. Samples</a>
511 <ul class="nav">
512 <li><a href="#sec-3-1">3.1. Raytracing through voxels</a></li>
513 <li><a href="#sec-3-2">3.2. Conway's Game of Life</a></li>
514 <li><a href="#sec-3-3">3.3. Text editors</a></li>
515 <li><a href="#sec-3-4">3.4. Mathematical formulas</a></li>
516 <li><a href="#sec-3-5">3.5. Sinus heightmaps and sphere</a></li>
517 </ul>
518 </li>
519 </ul>
520 </div>
521 </nav>
522 </div></div></div>
523 <footer id="postamble" class="">
524 <div><p class="author">Author: Svjatoslav Agejenko</p>
525 <p class="date">Created: 2018-06-22 Fri 02:53</p>
526 <p class="creator"><a href="http://www.gnu.org/software/emacs/">Emacs</a> 25.1.1 (<a href="http://orgmode.org">Org-mode</a> 8.2.10)</p>
527 </div>
528 </footer>
529 </body>
530 </html>