4 <title>Sixth 3D - 3D engine</title>
5 <!-- 2018-06-22 Fri 02:26 -->
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;}
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>
201 <li>This is a subproject of <a href="http://www3.svjatoslav.eu/projects/sixth/">Sixth</a>
204 <li>Clone GIT repository using commanad:
205 <pre class="example">
206 git clone http://www2.svjatoslav.eu/git/sixth-3d.git
210 <li><a href="http://www2.svjatoslav.eu/gitweb/?p=sixth-3d.git;a=snapshot;h=HEAD;sf=tgz">Download latest snapshot in TAR GZ format</a>
213 <li>This program is free software: you can redistribute it and/or modify
214 it under the terms of the <a href="https://www.gnu.org/licenses/lgpl.html">GNU Lesser General Public License</a> as
215 published by the Free Software Foundation, either version 3 of the
216 License, or (at your option) any later version.
221 <li>Svjatoslav Agejenko
223 <li>Homepage: <a href="http://svjatoslav.eu">http://svjatoslav.eu</a>
225 <li>Email: <a href="mailto://svjatoslav@svjatoslav.eu">mailto://svjatoslav@svjatoslav.eu</a>
230 <li><a href="http://www.svjatoslav.eu/projects/">Other software projects hosted at svjatoslav.eu</a>
234 <div id="outline-container-sec-1" class="outline-2">
235 <h2 id="sec-1"><span class="section-number-2">1</span> Project description</h2>
236 <div class="outline-text-2" id="text-1">
238 <li>See: <a href="http://www3.svjatoslav.eu/projects/sixth-3d-demos/">demos of current 3D engine capabilities</a>
243 <a href="#sec-1-1">In software</a>, <a href="#sec-1-2">pure Java</a> realtime 3D rendering engine. With the final
244 goal of becoming a platform for buildng 3D user interfaces and
245 interactive data visualization for <a href="http://www3.svjatoslav.eu/projects/sixth/">project Sixth</a>.
249 Sixth 3D can be also used as standalone <a href="#sec-3">3D engine in your project</a>.
253 <div id="outline-container-sec-1-1" class="outline-3">
254 <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>
255 <div class="outline-text-3" id="text-1-1">
257 3D rendering is done in software, 100% pure Java on CPU. At least for
258 now. Modern CPU cores count keeps growing and therefore rendering by
259 CPU is not as expensive as it used to be for the old single core
264 CPU rendering performance is already good enough to implement usable
265 3D UI at sufficient detail level, resolution and frame rate.
269 Also CPU rendering allows to freely test different rendering and
270 optimization algorithms and retains complete control of every rendered
275 <div id="outline-container-sec-1-2" class="outline-3">
276 <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>
277 <div class="outline-text-3" id="text-1-2">
279 <li>It is easy to refactor and experiment with.
282 <li>Easy portability and installation. No need to deal with platform
283 specific dependencies.
286 <li>It scales well to handle great complexity.
288 <li>Allows to implement clever performance optimizations (instead of
289 going for GPU offered brute-force rendering approach).
294 <li>No limitations imposed by:
296 <li>requirement for decent GPU
298 <li>GPU missing features
300 <li>GPU missing/incomplete/buggy drivers
302 <li>OpenGL specification
307 <li>It is fast enough thanks to:
309 <li>Java virtual machine just-in-time compiler.
311 <li>Growing CPU cores count.
316 <li>As a result it is easy to run on various hardware platforms and
324 <div id="outline-container-sec-2" class="outline-2">
325 <h2 id="sec-2"><span class="section-number-2">2</span> <span class="label label-primary TODO">TODO</span> API documentation</h2>
326 <div class="outline-text-2" id="text-2">
328 Documentation currently missing for the lack of time.
332 So far best resource is to download and explore source code for:
335 <li>3D engine (<a href="http://www3.svjatoslav.eu/projects/sixth-3d/graphs/">generated code graphs</a> (generated using <a href="http://www3.svjatoslav.eu/projects/javainspect/">JavaInspect</a>))
337 <li>For API usage examples, see <a href="http://www3.svjatoslav.eu/projects/sixth-3d-demos/">demos</a>
342 <div id="outline-container-sec-3" class="outline-2">
343 <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>
344 <div class="outline-text-2" id="text-3">
346 Maven *pom.xml* file snippet:
348 <div class="org-src-container">
350 <pre class="src src-xml"><dependencies>
353 <groupId>eu.svjatoslav</groupId>
354 <artifactId>sixth-3d</artifactId>
355 <version>1.1</version>
358 </dependencies>
363 <id>svjatoslav.eu</id>
364 <name>Svjatoslav repository</name>
365 <url>http://www2.svjatoslav.eu/maven/</url>
368 </repositories>
373 For API usage examples, see <a href="http://www3.svjatoslav.eu/projects/sixth-3d-demos/">demos</a>.
377 <div id="outline-container-sec-4" class="outline-2">
378 <h2 id="sec-4"><span class="section-number-2">4</span> <span class="label label-primary TODO">TODO</span> features to add</h2>
379 <div class="outline-text-2" id="text-4">
381 <li>Partial region/frame repaint: when only one small object changed on
382 the scene, it would be faster to re-render that specific area.
385 <li>Once partial rendering works, in would be easy to add multi-core
386 rendering support. So that each core renders it's own region of the
390 <li>Antialiazing. Would improve text readability. If antialiazing is too
391 expensive for every frame, it could be used only for last frame
392 before animations become still and waiting for user input starts.
395 <li>Render only visible polygons.
397 <li>This would significantly reduce RAM <-> CPU traffic.
400 <li>General algorithm description:
402 <li>For each horizontal scanline:
404 <li>sort polygon edges from left to right
406 <li>while iterating and drawing pixels over screen X axis (left to
407 right) track next appearing/disappearing polygons.
409 <li>For each polygon edge update Z sorted active polygons list.
411 <li>Only draw pixel from the top-most polygon.
413 <li>Only if polygon area is transparent/half-transparent add
414 colors from the polygons below.
425 <li>As a bonus, this would allow to track which polygons are really
426 visible in the final scene for each frame.
429 <li>Such information allows further optimizations:
432 <li>Dynamic geometry simplification:
434 <li>Dynamically detect and replace invisible objects from the
435 scene with simplified bounding box.
438 <li>Dynamically replace boudnig box with actual object once it
444 <li>Dynamically unload unused textures from RAM.
455 </div><div class="col-md-3"><nav id="table-of-contents">
456 <div id="text-table-of-contents" class="bs-docs-sidebar">
458 <li><a href="#sec-1">1. Project description</a>
460 <li><a href="#sec-1-1">1.1. Justification for software rendering</a></li>
461 <li><a href="#sec-1-2">1.2. Justification for Java</a></li>
464 <li><a href="#sec-2">2. API documentation</a></li>
465 <li><a href="#sec-3">3. Instructions to embed Sixth-3D in your project</a></li>
466 <li><a href="#sec-4">4. features to add</a></li>
471 <footer id="postamble" class="">
472 <div><p class="author">Author: Svjatoslav Agejenko</p>
473 <p class="date">Created: 2018-06-22 Fri 02:26</p>
474 <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>