doc/index.html

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