4 <title>Sixth 3D - 3D engine</title>
5 <!-- 2020-04-20 Mon 22:24 -->
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;}
17 <style type="text/css">
18 /* org mode styles on top of twbs */
35 background-color: #f5f5f5;
62 display: inline-block;
74 .bs-docs-sidebar.affix {
77 @media (min-width: 768px) {
83 /* All levels of nav */
84 .bs-docs-sidebar .nav > li > a {
91 .bs-docs-sidebar .nav > li > a:hover,
92 .bs-docs-sidebar .nav > li > a:focus {
95 text-decoration: none;
96 background-color: transparent;
97 border-left: 1px solid #A1283B;
99 .bs-docs-sidebar .nav > .active > a,
100 .bs-docs-sidebar .nav > .active:hover > a,
101 .bs-docs-sidebar .nav > .active:focus > a {
105 background-color: transparent;
106 border-left: 2px solid #A1283B;
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;
114 .bs-docs-sidebar .nav .nav > li > a {
121 .bs-docs-sidebar .nav .nav > li > a:hover,
122 .bs-docs-sidebar .nav .nav > li > a:focus {
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 {
132 /* Nav: third level (shown on .active) */
133 .bs-docs-sidebar .nav .nav .nav {
134 padding-bottom: 10px;
136 .bs-docs-sidebar .nav .nav .nav > li > a {
143 .bs-docs-sidebar .nav .nav .nav > li > a:hover,
144 .bs-docs-sidebar .nav .nav .nav > li > a:focus {
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 {
154 /* Show and affix the side nav when space allows it */
155 @media (min-width: 992px) {
156 .bs-docs-sidebar .nav > .active > ul {
159 /* Widen the fixed sidebar */
160 .bs-docs-sidebar.affix,
161 .bs-docs-sidebar.affix-bottom {
164 .bs-docs-sidebar.affix {
165 position: fixed; /* Undo the static from mobile first approach */
168 .bs-docs-sidebar.affix-bottom {
169 position: absolute; /* Undo the static from mobile first approach */
171 .bs-docs-sidebar.affix .bs-docs-sidenav,.bs-docs-sidebar.affix-bottom .bs-docs-sidenav {
176 @media (min-width: 1200px) {
177 /* Widen the fixed sidebar again */
178 .bs-docs-sidebar.affix-bottom,
179 .bs-docs-sidebar.affix {
184 <script type="text/javascript">
188 $('.bs-docs-sidebar li').first().addClass('active');
190 $(document.body).scrollspy({target: '.bs-docs-sidebar'});
192 $('.bs-docs-sidebar').affix();
197 <div id="content" class="container">
198 <div class="row"><div class="col-md-9"><h1 class="title">Sixth 3D - 3D engine</h1>
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">
204 <li>This program is free software: released under Creative Commons Zero
210 <li>Svjatoslav Agejenko
212 <li>Homepage: <a href="https://svjatoslav.eu">https://svjatoslav.eu</a>
214 <li>Email: <a href="mailto://svjatoslav@svjatoslav.eu">mailto://svjatoslav@svjatoslav.eu</a>
219 <li><a href="https://www.svjatoslav.eu/projects/">Other software projects hosted at svjatoslav.eu</a>
224 <div id="outline-container-sec-1-1" class="outline-3">
225 <h3 id="sec-1-1"><span class="section-number-3">1.1</span> Source code</h3>
226 <div class="outline-text-3" id="text-1-1">
228 <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>
231 <li><a href="https://www2.svjatoslav.eu/gitweb/?p=sixth-3d.git;a=summary">Browse Git repository online</a>
234 <li>Clone Git repository using command:
235 <pre class="example">
236 git clone https://www2.svjatoslav.eu/git/sixth-3d.git
241 <li>See <a href="https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/">JavaDoc</a>.
248 <div id="outline-container-sec-2" class="outline-2">
249 <h2 id="sec-2"><span class="section-number-2">2</span> Project description</h2>
250 <div class="outline-text-2" id="text-2">
252 <li>See: <a href="https://www3.svjatoslav.eu/projects/sixth-3d-demos/">demos of current 3D engine capabilities</a>
257 <a href="#sec-2-1">In software</a>, <a href="#sec-2-2">pure Java</a> realtime 3D rendering engine. With the final
258 goal of becoming a platform for buildng 3D user interfaces and
259 interactive data visualization for <a href="https://www3.svjatoslav.eu/projects/sixth/">project Sixth</a>.
263 Sixth 3D can be also used as standalone <a href="#sec-4">3D engine in your project</a>.
267 <div id="outline-container-sec-2-1" class="outline-3">
268 <h3 id="sec-2-1"><a id="ID-d03013e5-931b-40ca-bc4b-e4b3f23b9a4e" name="ID-d03013e5-931b-40ca-bc4b-e4b3f23b9a4e"></a><span class="section-number-3">2.1</span> Justification for software rendering</h3>
269 <div class="outline-text-3" id="text-2-1">
271 3D rendering is done in software, 100% pure Java on CPU. At least for
272 now. Modern CPU cores count keeps growing and therefore rendering by
273 CPU is not as expensive as it used to be for the old single core
278 CPU rendering performance is already good enough to implement usable
279 3D UI at sufficient detail level, resolution and frame rate.
283 Also CPU rendering allows to freely test different rendering and
284 optimization algorithms and retains complete control of every rendered
289 <div id="outline-container-sec-2-2" class="outline-3">
290 <h3 id="sec-2-2"><a id="ID-a11f7150-1b25-4ca4-a3c3-8c8bd1352bd4" name="ID-a11f7150-1b25-4ca4-a3c3-8c8bd1352bd4"></a><span class="section-number-3">2.2</span> Justification for Java</h3>
291 <div class="outline-text-3" id="text-2-2">
293 <li>It is easy to refactor and experiment with.
296 <li>Easy portability and installation. No need to deal with platform
297 specific dependencies.
300 <li>It scales well to handle great complexity.
302 <li>Allows to implement clever performance optimizations (instead of
303 going for GPU offered brute-force rendering approach).
308 <li>No limitations imposed by:
310 <li>requirement for decent GPU
312 <li>GPU missing features
314 <li>GPU missing/incomplete/buggy drivers
316 <li>OpenGL specification
321 <li>It is fast enough thanks to:
323 <li>Java virtual machine just-in-time compiler.
325 <li>Growing CPU cores count.
330 <li>As a result it is easy to run on various hardware platforms and
338 <div id="outline-container-sec-3" class="outline-2">
339 <h2 id="sec-3"><span class="section-number-2">3</span> API documentation</h2>
340 <div class="outline-text-2" id="text-3">
342 <li>See <a href="https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/">JavaDoc</a>.
347 Note: due to a lack of time, there is still big room for improvement
352 So far best resource is to download and explore source code for:
355 <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>))
357 <li>For API usage examples, see <a href="https://www3.svjatoslav.eu/projects/sixth-3d-demos/">demos</a>
362 <div id="outline-container-sec-4" class="outline-2">
363 <h2 id="sec-4"><a id="ID-08f71987-90af-40dc-bb65-bac87db9e652" name="ID-08f71987-90af-40dc-bb65-bac87db9e652"></a><span class="section-number-2">4</span> Instructions to embed Sixth-3D in your project</h2>
364 <div class="outline-text-2" id="text-4">
366 Maven *pom.xml* file snippet:
368 <div class="org-src-container">
370 <pre class="src src-xml"><<span style="color: #A6E22E;">dependencies</span>>
372 <<span style="color: #A6E22E;">dependency</span>>
373 <<span style="color: #A6E22E;">groupId</span>>eu.svjatoslav</<span style="color: #A6E22E;">groupId</span>>
374 <<span style="color: #A6E22E;">artifactId</span>>sixth-3d</<span style="color: #A6E22E;">artifactId</span>>
375 <<span style="color: #A6E22E;">version</span>>1.1</<span style="color: #A6E22E;">version</span>>
376 </<span style="color: #A6E22E;">dependency</span>>
378 </<span style="color: #A6E22E;">dependencies</span>>
380 <<span style="color: #A6E22E;">repositories</span>>
382 <<span style="color: #A6E22E;">repository</span>>
383 <<span style="color: #A6E22E;">id</span>>svjatoslav.eu</<span style="color: #A6E22E;">id</span>>
384 <<span style="color: #A6E22E;">name</span>>Svjatoslav repository</<span style="color: #A6E22E;">name</span>>
385 <<span style="color: #A6E22E;">url</span>>http://www2.svjatoslav.eu/maven/</<span style="color: #A6E22E;">url</span>>
386 </<span style="color: #A6E22E;">repository</span>>
388 </<span style="color: #A6E22E;">repositories</span>>
393 For API usage examples, see <a href="https://www3.svjatoslav.eu/projects/sixth-3d-demos/">demos</a>.
397 <div id="outline-container-sec-5" class="outline-2">
398 <h2 id="sec-5"><span class="section-number-2">5</span> <span class="label label-primary TODO">TODO</span> features to add</h2>
399 <div class="outline-text-2" id="text-5">
401 <li>read this as example, and apply improvements/fixes where applicable:
402 <a href="http://blog.rogach.org/2015/08/how-to-create-your-own-simple-3d-render.html">http://blog.rogach.org/2015/08/how-to-create-your-own-simple-3d-render.html</a>
405 <li>Partial region/frame repaint: when only one small object changed on
406 the scene, it would be faster to re-render that specific area.
409 <li>Once partial rendering works, in would be easy to add multi-core
410 rendering support. So that each core renders it's own region of the
414 <li>Antialiazing. Would improve text readability. If antialiazing is too
415 expensive for every frame, it could be used only for last frame
416 before animations become still and waiting for user input starts.
420 <div id="outline-container-sec-5-1" class="outline-3">
421 <h3 id="sec-5-1"><span class="section-number-3">5.1</span> Render only visible polygons</h3>
422 <div class="outline-text-3" id="text-5-1">
424 <li>This would significantly reduce RAM <-> CPU traffic.
427 <li>General algorithm description:
429 <li>For each horizontal scanline:
431 <li>sort polygon edges from left to right
433 <li>while iterating and drawing pixels over screen X axis (left to
434 right) track next appearing/disappearing polygons.
436 <li>For each polygon edge update Z sorted active polygons list.
438 <li>Only draw pixel from the top-most polygon.
440 <li>Only if polygon area is transparent/half-transparent add
441 colors from the polygons below.
452 <li>As a bonus, this would allow to track which polygons are really
453 visible in the final scene for each frame.
456 <li>Such information allows further optimizations:
459 <li>Dynamic geometry simplification:
461 <li>Dynamically detect and replace invisible objects from the
462 scene with simplified bounding box.
465 <li>Dynamically replace boudnig box with actual object once it
471 <li>Dynamically unload unused textures from RAM.
481 </div><div class="col-md-3"><nav id="table-of-contents">
482 <div id="text-table-of-contents" class="bs-docs-sidebar">
484 <li><a href="#sec-1">1. General</a>
486 <li><a href="#sec-1-1">1.1. Source code</a></li>
489 <li><a href="#sec-2">2. Project description</a>
491 <li><a href="#sec-2-1">2.1. Justification for software rendering</a></li>
492 <li><a href="#sec-2-2">2.2. Justification for Java</a></li>
495 <li><a href="#sec-3">3. API documentation</a></li>
496 <li><a href="#sec-4">4. Instructions to embed Sixth-3D in your project</a></li>
497 <li><a href="#sec-5">5. features to add</a>
499 <li><a href="#sec-5-1">5.1. Render only visible polygons</a></li>
506 <footer id="postamble" class="">
507 <div><p class="author">Author: Svjatoslav Agejenko</p>
508 <p class="date">Created: 2020-04-20 Mon 22:24</p>
509 <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>