doc/index.html

   1 <!doctype html>
   2 <html lang="en">
   3 <head>
   4 <title>Sixth 3D engine demos</title>
   5 <!-- 2018-06-24 Sun 02:37 -->
   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/3/darkly/bootstrap.min.css" rel="stylesheet">
  11 <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
  12 <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.5/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
 200 <div id="outline-container-sec-1" class="outline-2">
 201 <h2 id="sec-1"><span class="section-number-2">1</span> General</h2>
 202 <div class="outline-text-2" id="text-1">
 203 <ul class="org-ul">
 204 <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
 205 <a href="http://www3.svjatoslav.eu/projects/sixth/">Sixth</a>.
 206 </li>
 207
 208 <li>This program is free software: you can redistribute it and/or modify
 209 it under the terms of the <a href="https://www.gnu.org/licenses/lgpl.html">GNU Lesser General Public License</a> as
 210 published by the Free Software Foundation, either version 3 of the
 211 License, or (at your option) any later version.
 212 </li>
 213
 214 <li>Program author:
 215 <ul class="org-ul">
 216 <li>Svjatoslav Agejenko
 217 </li>
 218 <li>Homepage: <a href="http://svjatoslav.eu">http://svjatoslav.eu</a>
 219 </li>
 220 <li>Email: <a href="mailto://svjatoslav@svjatoslav.eu">mailto://svjatoslav@svjatoslav.eu</a>
 221 </li>
 222 </ul>
 223 </li>
 224
 225 <li><a href="http://www.svjatoslav.eu/projects/">Other software projects hosted at svjatoslav.eu</a>
 226 </li>
 227 </ul>
 228 </div>
 229
 230 <div id="outline-container-sec-1-1" class="outline-3">
 231 <h3 id="sec-1-1"><span class="section-number-3">1.1</span> Source code</h3>
 232 <div class="outline-text-3" id="text-1-1">
 233 <ul class="org-ul">
 234 <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>
 235 </li>
 236
 237 <li><a href="http://www2.svjatoslav.eu/gitweb/?p=sixth-3d-demos.git;a=summary">Browse Git repository online</a>
 238 </li>
 239
 240 <li>Clone Git repository using command:
 241 <pre class="example">
 242 git clone http://www2.svjatoslav.eu/git/sixth-3d-demos.git
 243 </pre>
 244 </li>
 245 </ul>
 246 </div>
 247 </div>
 248 </div>
 249
 250 <div id="outline-container-sec-2" class="outline-2">
 251 <h2 id="sec-2"><span class="section-number-2">2</span> Overview</h2>
 252 <div class="outline-text-2" id="text-2">
 253 <p>
 254 Goal of this project is to show off capabilities and API usage of
 255 <a href="http://www3.svjatoslav.eu/projects/sixth-3d/">Sixth 3D</a> engine.
 256 </p>
 257
 258 <p>
 259 All sample scenes below are rendered at interactive framerates.
 260 </p>
 261 </div>
 262 </div>
 263 <div id="outline-container-sec-3" class="outline-2">
 264 <h2 id="sec-3"><span class="section-number-2">3</span> Navigating in space</h2>
 265 <div class="outline-text-2" id="text-3">
 266 <table class="table table-striped table-bordered table-hover table-condensed">
 267
 268
 269 <colgroup>
 270 <col  class="left">
 271
 272 <col  class="left">
 273 </colgroup>
 274 <thead>
 275 <tr>
 276 <th scope="col" class="text-left">key</th>
 277 <th scope="col" class="text-left">result</th>
 278 </tr>
 279 </thead>
 280 <tbody>
 281 <tr>
 282 <td class="text-left">cursor keys</td>
 283 <td class="text-left">move: left, right, forward, backward</td>
 284 </tr>
 285
 286 <tr>
 287 <td class="text-left">mouse scroll wheel</td>
 288 <td class="text-left">move: up, down</td>
 289 </tr>
 290
 291 <tr>
 292 <td class="text-left">dragging with mouse</td>
 293 <td class="text-left">look around</td>
 294 </tr>
 295 </tbody>
 296 </table>
 297 </div>
 298 </div>
 299
 300 <div id="outline-container-sec-4" class="outline-2">
 301 <h2 id="sec-4"><span class="section-number-2">4</span> Samples</h2>
 302 <div class="outline-text-2" id="text-4">
 303 </div><div id="outline-container-sec-4-1" class="outline-3">
 304 <h3 id="sec-4-1"><span class="section-number-3">4.1</span> Raytracing through voxels</h3>
 305 <div class="outline-text-3" id="text-4-1">
 306
 307 <figure>
 308 <p><img src="screenshots/raytracing fractal in voxel polygon hybrid scene.png" class="img-responsive" alt="raytracing fractal in voxel polygon hybrid scene.png">
 309 </p>
 310 </figure>
 311
 312 <p>
 313 Test scene that is generated simultaneously using:
 314 </p>
 315 <ul class="org-ul">
 316 <li>conventional polygons
 317 <ul class="org-ul">
 318 <li>for realtime navigation, and
 319 </li>
 320 </ul>
 321 </li>
 322 <li>voxels
 323 <ul class="org-ul">
 324 <li>for on-demand raytracing
 325 </li>
 326 </ul>
 327 </li>
 328 </ul>
 329
 330 <p>
 331 Instead of storing voxels in dumb [X * Y * Z] array, dynamically
 332 partitioned <a href="https://en.wikipedia.org/wiki/Octree">octree</a> is used to compress data. Press "r" key anywhere in
 333 the scene to raytrace current view through compressed voxel
 334 datastructure.
 335 </p>
 336 </div>
 337 </div>
 338
 339 <div id="outline-container-sec-4-2" class="outline-3">
 340 <h3 id="sec-4-2"><span class="section-number-3">4.2</span> Conway's Game of Life</h3>
 341 <div class="outline-text-3" id="text-4-2">
 342 <p>
 343 The Game of Life, also known simply as Life, is a cellular automaton
 344 devised by the British mathematician John Horton Conway in 1970.
 345 </p>
 346
 347 <ul class="org-ul">
 348 <li><a href="https://en.wikipedia.org/wiki/Conway's_Game_of_Life">https://en.wikipedia.org/wiki/Conway's_Game_of_Life</a>
 349 <ul class="org-ul">
 350 <li>Game rules:
 351 <ul class="org-ul">
 352 <li>2 cell states: alive / dead
 353 </li>
 354 <li>Each cell sees 8 neighboring cells.
 355 </li>
 356 <li>If alive cell neighbors count is 2 or 3, then cell survives,
 357 otherwise it dies.
 358 </li>
 359 <li>Dead cell becomes alive if neighbors count is exactly 3.
 360 </li>
 361 </ul>
 362 </li>
 363 </ul>
 364 </li>
 365 </ul>
 366
 367
 368 <figure>
 369 <p><img src="screenshots/life.png" class="img-responsive" alt="life.png">
 370 </p>
 371 </figure>
 372
 373 <p>
 374 Current application projects 2D game grid/matrix onto three
 375 dimensional space. Extra dimension (height) is used to visualize
 376 history (previous iterations) using glowing dots suspended in space.
 377 </p>
 378
 379 <p>
 380 Usage:
 381 </p>
 382 <table class="table table-striped table-bordered table-hover table-condensed">
 383
 384
 385 <colgroup>
 386 <col  class="left">
 387
 388 <col  class="left">
 389 </colgroup>
 390 <thead>
 391 <tr>
 392 <th scope="col" class="text-left">key</th>
 393 <th scope="col" class="text-left">result</th>
 394 </tr>
 395 </thead>
 396 <tbody>
 397 <tr>
 398 <td class="text-left">mouse click on the cell (cell)</td>
 399 <td class="text-left">toggles cell state</td>
 400 </tr>
 401
 402 <tr>
 403 <td class="text-left">&lt;space&gt;</td>
 404 <td class="text-left">next iteration</td>
 405 </tr>
 406
 407 <tr>
 408 <td class="text-left">ENTER</td>
 409 <td class="text-left">next iteeration with the history</td>
 410 </tr>
 411
 412 <tr>
 413 <td class="text-left">"c"</td>
 414 <td class="text-left">clear the matrix</td>
 415 </tr>
 416 </tbody>
 417 </table>
 418 </div>
 419 </div>
 420
 421 <div id="outline-container-sec-4-3" class="outline-3">
 422 <h3 id="sec-4-3"><span class="section-number-3">4.3</span> Text editors</h3>
 423 <div class="outline-text-3" id="text-4-3">
 424
 425 <figure>
 426 <p><img src="screenshots/text editors.png" class="img-responsive" alt="text editors.png">
 427 </p>
 428 </figure>
 429
 430 <p>
 431 Initial test for creating user interfaces in 3D and:
 432 </p>
 433 <ul class="org-ul">
 434 <li>window focus handling
 435 </li>
 436 <li>picking objecs using mouse
 437 </li>
 438 <li>redirecting keyboard input to focused window
 439 </li>
 440 </ul>
 441
 442
 443 <p>
 444 Window focus acts like a stack.
 445 </p>
 446
 447 <p>
 448 When window is clicked with the mouse, previously focused window (if
 449 any) is pushed to the focus stack and new window receives focus. Red
 450 frame appears around the window to indicate this.
 451 </p>
 452
 453 <p>
 454 When ESC key is pressed, window focus is returned to previous window
 455 (if any).
 456 </p>
 457
 458 <p>
 459 When any window is focused, all keyboard input is redirected to that
 460 window, including cursor keys. To be able to navigate around the world
 461 again, window must be unfocused first using ESC key.
 462 </p>
 463
 464
 465 <ul class="org-ul">
 466 <li>TODO:
 467 <ul class="org-ul">
 468 <li>Improve focus handling:
 469 <ul class="org-ul">
 470 <li>Perhaps add shortcut to navigate world without exiting entire
 471 stack of focus.
 472 </li>
 473 <li>Possibility to retain and reuse recently focused elements.
 474 </li>
 475 <li>Store user location in the world and view direction with the
 476 focused window. So that when returning focus to far away object,
 477 user is redirected also to proper location in the world.
 478 </li>
 479 </ul>
 480 </li>
 481 <li>Possibility to store recently visited locations in the world and
 482 return to them.
 483 </li>
 484 </ul>
 485 </li>
 486 </ul>
 487 </div>
 488 </div>
 489 <div id="outline-container-sec-4-4" class="outline-3">
 490 <h3 id="sec-4-4"><span class="section-number-3">4.4</span> Mathematical formulas</h3>
 491 <div class="outline-text-3" id="text-4-4">
 492
 493 <figure>
 494 <p><img src="screenshots/mathematical formulas.png" class="img-responsive" alt="mathematical formulas.png">
 495 </p>
 496 </figure>
 497
 498 <ul class="org-ul">
 499 <li>TODO: instead of projecting 2D visualizations onto 3D space,
 500 visualize some formula using all 3 dimensions avaliable.
 501 </li>
 502 </ul>
 503 </div>
 504 </div>
 505 <div id="outline-container-sec-4-5" class="outline-3">
 506 <h3 id="sec-4-5"><span class="section-number-3">4.5</span> Sinus heightmaps and sphere</h3>
 507 <div class="outline-text-3" id="text-4-5">
 508
 509 <figure>
 510 <p><img src="screenshots/sinus heightmaps and sphere.png" class="img-responsive" alt="sinus heightmaps and sphere.png">
 511 </p>
 512 </figure>
 513
 514 <p>
 515 Simple test scene. Easy to implement and looks nice.
 516 </p>
 517 </div>
 518 </div>
 519 </div>
 520 </div><div class="col-md-3"><nav id="table-of-contents">
 521 <div id="text-table-of-contents" class="bs-docs-sidebar">
 522 <ul class="nav">
 523 <li><a href="#sec-1">1. General</a>
 524 <ul class="nav">
 525 <li><a href="#sec-1-1">1.1. Source code</a></li>
 526 </ul>
 527 </li>
 528 <li><a href="#sec-2">2. Overview</a></li>
 529 <li><a href="#sec-3">3. Navigating in space</a></li>
 530 <li><a href="#sec-4">4. Samples</a>
 531 <ul class="nav">
 532 <li><a href="#sec-4-1">4.1. Raytracing through voxels</a></li>
 533 <li><a href="#sec-4-2">4.2. Conway's Game of Life</a></li>
 534 <li><a href="#sec-4-3">4.3. Text editors</a></li>
 535 <li><a href="#sec-4-4">4.4. Mathematical formulas</a></li>
 536 <li><a href="#sec-4-5">4.5. Sinus heightmaps and sphere</a></li>
 537 </ul>
 538 </li>
 539 </ul>
 540 </div>
 541 </nav>
 542 </div></div></div>
 543 <footer id="postamble" class="">
 544 <div><p class="author">Author: Svjatoslav Agejenko</p>
 545 <p class="date">Created: 2018-06-24 Sun 02:37</p>
 546 <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>
 547 </div>
 548 </footer>
 549 </body>
 550 </html>