doc/index.html

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