doc/index.html

   1 <!doctype html>
   2 <html lang="en">
   3 <head>
   4 <title>Sixth 3D - 3D engine</title>
   5 <!-- 2019-01-19 Sat 01:21 -->
   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 - 3D engine</h1>
 199 <hr >
 200 <ul class="org-ul">
 201 <li>This is a subproject of <a href="https://www3.svjatoslav.eu/projects/sixth/">Sixth</a>
 202 </li>
 203
 204 <li>Clone GIT repository using command:
 205 <pre class="example">
 206 git clone https://www2.svjatoslav.eu/git/sixth-3d.git
 207
 208 </pre>
 209 </li>
 210
 211 <li><a href="https://www2.svjatoslav.eu/gitweb/?p=sixth-3d.git;a=snapshot;h=HEAD;sf=tgz">Download latest snapshot in TAR GZ format</a>
 212 </li>
 213
 214 <li>See <a href="https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/">JavaDoc</a>.
 215 </li>
 216
 217 <li>This program is free software: you can redistribute it and/or modify
 218 it under the terms of the <a href="https://www.gnu.org/licenses/lgpl.html">GNU Lesser General Public License</a> as
 219 published by the Free Software Foundation, either version 3 of the
 220 License, or (at your option) any later version.
 221 </li>
 222
 223 <li>Program author:
 224 <ul class="org-ul">
 225 <li>Svjatoslav Agejenko
 226 </li>
 227 <li>Homepage: <a href="https://svjatoslav.eu">https://svjatoslav.eu</a>
 228 </li>
 229 <li>Email: <a href="mailto://svjatoslav@svjatoslav.eu">mailto://svjatoslav@svjatoslav.eu</a>
 230 </li>
 231 </ul>
 232 </li>
 233
 234 <li><a href="https://www.svjatoslav.eu/projects/">Other software projects hosted at svjatoslav.eu</a>
 235 </li>
 236 </ul>
 237
 238 <div id="outline-container-sec-1" class="outline-2">
 239 <h2 id="sec-1"><span class="section-number-2">1</span> Project description</h2>
 240 <div class="outline-text-2" id="text-1">
 241 <ul class="org-ul">
 242 <li>See: <a href="https://www3.svjatoslav.eu/projects/sixth-3d-demos/">demos of current 3D engine capabilities</a>
 243 </li>
 244 </ul>
 245
 246 <p>
 247 <a href="#sec-1-1">In software</a>, <a href="#sec-1-2">pure Java</a> realtime 3D rendering engine. With the final
 248 goal of becoming a platform for buildng 3D user interfaces and
 249 interactive data visualization for <a href="https://www3.svjatoslav.eu/projects/sixth/">project Sixth</a>.
 250 </p>
 251
 252 <p>
 253 Sixth 3D can be also used as standalone <a href="#sec-3">3D engine in your project</a>.
 254 </p>
 255 </div>
 256
 257 <div id="outline-container-sec-1-1" class="outline-3">
 258 <h3 id="sec-1-1"><a id="ID-d03013e5-931b-40ca-bc4b-e4b3f23b9a4e" name="ID-d03013e5-931b-40ca-bc4b-e4b3f23b9a4e"></a><span class="section-number-3">1.1</span> Justification for software rendering</h3>
 259 <div class="outline-text-3" id="text-1-1">
 260 <p>
 261 3D rendering is done in software, 100% pure Java on CPU. At least for
 262 now. Modern CPU cores count keeps growing and therefore rendering by
 263 CPU is not as expensive as it used to be for the old single core
 264 systems.
 265 </p>
 266
 267 <p>
 268 CPU rendering performance is already good enough to implement usable
 269 3D UI at sufficient detail level, resolution and frame rate.
 270 </p>
 271
 272 <p>
 273 Also CPU rendering allows to freely test different rendering and
 274 optimization algorithms and retains complete control of every rendered
 275 pixel.
 276 </p>
 277 </div>
 278 </div>
 279 <div id="outline-container-sec-1-2" class="outline-3">
 280 <h3 id="sec-1-2"><a id="ID-a11f7150-1b25-4ca4-a3c3-8c8bd1352bd4" name="ID-a11f7150-1b25-4ca4-a3c3-8c8bd1352bd4"></a><span class="section-number-3">1.2</span> Justification for Java</h3>
 281 <div class="outline-text-3" id="text-1-2">
 282 <ul class="org-ul">
 283 <li>It is easy to refactor and experiment with.
 284 </li>
 285
 286 <li>Easy portability and installation. No need to deal with platform
 287 specific dependencies.
 288 </li>
 289
 290 <li>It scales well to handle great complexity.
 291 <ul class="org-ul">
 292 <li>Allows to implement clever performance optimizations (instead of
 293 going for GPU offered brute-force rendering approach).
 294 </li>
 295 </ul>
 296 </li>
 297
 298 <li>No limitations imposed by:
 299 <ul class="org-ul">
 300 <li>requirement for decent GPU
 301 </li>
 302 <li>GPU missing features
 303 </li>
 304 <li>GPU missing/incomplete/buggy drivers
 305 </li>
 306 <li>OpenGL specification
 307 </li>
 308 </ul>
 309 </li>
 310
 311 <li>It is fast enough thanks to:
 312 <ul class="org-ul">
 313 <li>Java virtual machine just-in-time compiler.
 314 </li>
 315 <li>Growing CPU cores count.
 316 </li>
 317 </ul>
 318 </li>
 319
 320 <li>As a result it is easy to run on various hardware platforms and
 321 operating systems.
 322 </li>
 323 </ul>
 324 </div>
 325 </div>
 326 </div>
 327
 328 <div id="outline-container-sec-2" class="outline-2">
 329 <h2 id="sec-2"><span class="section-number-2">2</span> API documentation</h2>
 330 <div class="outline-text-2" id="text-2">
 331 <ul class="org-ul">
 332 <li>See <a href="https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/">JavaDoc</a>.
 333 </li>
 334 </ul>
 335
 336 <p>
 337 Note: due to a lack of time, there is still big room for improvement
 338 on documentation.
 339 </p>
 340
 341 <p>
 342 So far best resource is to download and explore source code for:
 343 </p>
 344 <ul class="org-ul">
 345 <li>3D engine (<a href="https://www3.svjatoslav.eu/projects/sixth-3d/graphs/">generated code graphs</a> (generated using <a href="https://www3.svjatoslav.eu/projects/javainspect/">JavaInspect</a>))
 346 </li>
 347 <li>For API usage examples, see <a href="https://www3.svjatoslav.eu/projects/sixth-3d-demos/">demos</a>
 348 </li>
 349 </ul>
 350 </div>
 351 </div>
 352 <div id="outline-container-sec-3" class="outline-2">
 353 <h2 id="sec-3"><a id="ID-08f71987-90af-40dc-bb65-bac87db9e652" name="ID-08f71987-90af-40dc-bb65-bac87db9e652"></a><span class="section-number-2">3</span> Instructions to embed Sixth-3D in your project</h2>
 354 <div class="outline-text-2" id="text-3">
 355 <p>
 356 Maven *pom.xml* file snippet:
 357 </p>
 358 <div class="org-src-container">
 359
 360 <pre class="src src-xml">&lt;dependencies&gt;
 361     ...
 362     &lt;dependency&gt;
 363         &lt;groupId&gt;eu.svjatoslav&lt;/groupId&gt;
 364         &lt;artifactId&gt;sixth-3d&lt;/artifactId&gt;
 365         &lt;version&gt;1.1&lt;/version&gt;
 366     &lt;/dependency&gt;
 367     ...
 368 &lt;/dependencies&gt;
 369
 370 &lt;repositories&gt;
 371     ...
 372     &lt;repository&gt;
 373         &lt;id&gt;svjatoslav.eu&lt;/id&gt;
 374         &lt;name&gt;Svjatoslav repository&lt;/name&gt;
 375         &lt;url&gt;http://www2.svjatoslav.eu/maven/&lt;/url&gt;
 376     &lt;/repository&gt;
 377     ...
 378 &lt;/repositories&gt;
 379 </pre>
 380 </div>
 381
 382 <p>
 383 For API usage examples, see <a href="https://www3.svjatoslav.eu/projects/sixth-3d-demos/">demos</a>.
 384 </p>
 385 </div>
 386 </div>
 387 <div id="outline-container-sec-4" class="outline-2">
 388 <h2 id="sec-4"><span class="section-number-2">4</span> <span class="label label-primary TODO">TODO</span> features to add</h2>
 389 <div class="outline-text-2" id="text-4">
 390 <ul class="org-ul">
 391 <li>Partial region/frame repaint: when only one small object changed on
 392 the scene, it would be faster to re-render that specific area.
 393 </li>
 394
 395 <li>Once partial rendering works, in would be easy to add multi-core
 396 rendering support. So that each core renders it's own region of the
 397 screen.
 398 </li>
 399
 400 <li>Antialiazing. Would improve text readability. If antialiazing is too
 401 expensive for every frame, it could be used only for last frame
 402 before animations become still and waiting for user input starts.
 403 </li>
 404
 405 <li>Render only visible polygons.
 406 <ul class="org-ul">
 407 <li>This would significantly reduce RAM &lt;-&gt; CPU traffic.
 408 </li>
 409
 410 <li>General algorithm description:
 411 <ul class="org-ul">
 412 <li>For each horizontal scanline:
 413 <ul class="org-ul">
 414 <li>sort polygon edges from left to right
 415 </li>
 416 <li>while iterating and drawing pixels over screen X axis (left to
 417 right) track next appearing/disappearing polygons.
 418 <ul class="org-ul">
 419 <li>For each polygon edge update Z sorted active polygons list.
 420 </li>
 421 <li>Only draw pixel from the top-most polygon.
 422 <ul class="org-ul">
 423 <li>Only if polygon area is transparent/half-transparent add
 424 colors from the polygons below.
 425 </li>
 426 </ul>
 427 </li>
 428 </ul>
 429 </li>
 430 </ul>
 431 </li>
 432 </ul>
 433 </li>
 434
 435 <li>As a bonus, this would allow to track which polygons are really
 436 visible in the final scene for each frame.
 437
 438 <ul class="org-ul">
 439 <li>Such information allows further optimizations:
 440
 441 <ul class="org-ul">
 442 <li>Dynamic geometry simplification:
 443 <ul class="org-ul">
 444 <li>Dynamically detect and replace invisible objects from the
 445 scene with simplified bounding box.
 446 </li>
 447
 448 <li>Dynamically replace boudnig box with actual object once it
 449 becomes visible.
 450 </li>
 451 </ul>
 452 </li>
 453
 454 <li>Dynamically unload unused textures from RAM.
 455 </li>
 456 </ul>
 457 </li>
 458 </ul>
 459 </li>
 460 </ul>
 461 </li>
 462 </ul>
 463 </div>
 464 </div>
 465 </div><div class="col-md-3"><nav id="table-of-contents">
 466 <div id="text-table-of-contents" class="bs-docs-sidebar">
 467 <ul class="nav">
 468 <li><a href="#sec-1">1. Project description</a>
 469 <ul class="nav">
 470 <li><a href="#sec-1-1">1.1. Justification for software rendering</a></li>
 471 <li><a href="#sec-1-2">1.2. Justification for Java</a></li>
 472 </ul>
 473 </li>
 474 <li><a href="#sec-2">2. API documentation</a></li>
 475 <li><a href="#sec-3">3. Instructions to embed Sixth-3D in your project</a></li>
 476 <li><a href="#sec-4">4. features to add</a></li>
 477 </ul>
 478 </div>
 479 </nav>
 480 </div></div></div>
 481 <footer id="postamble" class="">
 482 <div><p class="author">Author: Svjatoslav Agejenko</p>
 483 <p class="date">Created: 2019-01-19 Sat 01:21</p>
 484 <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>
 485 </div>
 486 </footer>
 487 </body>
 488 </html>