X-Git-Url: http://www2.svjatoslav.eu/gitweb/?p=sixth-3d.git;a=blobdiff_plain;f=doc%2Findex.html;h=0a04257c17f80a2fe195ad6d20f216fd39de2be3;hp=a80e8d05939d8479cf579b7831c0fc3638dc8755;hb=28aff57371061764b5c01fcc535f621824a62c2d;hpb=746baf8325af6a3a2d104af274c0632c82dbafa2 diff --git a/doc/index.html b/doc/index.html index a80e8d0..0a04257 100644 --- a/doc/index.html +++ b/doc/index.html @@ -2,7 +2,7 @@ Sixth 3D - 3D engine - + @@ -227,25 +227,55 @@ published by the Free Software Foundation.

1 Project description

-

-In-software, pure Java realtime 3D rendering engine. With the final -goal of becoming a platform for buildng 3D user interfaces and -interactive data visualization. -

- +

+In software, pure Java realtime 3D rendering engine. With the final +goal of becoming a platform for buildng 3D user interfaces and +interactive data visualization for project Sixth. +

+ +

+Sixth 3D can be also used as standalone 3D engine in your project. +

+
+ +
+

1.1 Justification for software rendering

+
+

+3D rendering is done in software, 100% pure Java on CPU. At least for +now. Modern CPU cores count keeps growing and therefore rendering by +CPU is not as expensive as it used to be for the old single core +systems. +

+ +

+CPU rendering performance is already good enough to implement usable +3D UI at sufficient detail level, resolution and frame rate. +

-System is implemented in Java because: +Also CPU rendering allows to freely test different rendering and +optimization algorithms and retains complete control of every rendered +pixel.

+
+
+
+

1.2 Justification for Java

+
  • It is easy to refactor and experiment with.
    • +
  • Easy portability and installation. No need to deal with platform +specific dependencies. +
    • +
  • It scales well to handle great complexity.
    • Allows to implement clever performance optimizations (instead of @@ -280,35 +310,31 @@ going for GPU offered brute-force rendering approach). operating systems.
    +
+
+
+
+

2 TODO API documentation

+

-3D rendering is done in software, 100% pure Java on CPU. At least for -now. Modern CPU cores count keeps growing and therefore rendering by -CPU is not as expensive as it used to be for the old single core -systems. -

- -

-CPU rendering performance is already good enough to implement usable -3D UI at sufficient detail level, resolution and frame rate. -

- -

-Pure Java also means easy portability and installation. No need to -deal with platform specific dependencies. +Documentation currently missing for the lack of time.

-Also CPU rendering allows to easily test different rendering -algorithms and retains complete control of every rendered pixel. +So far best resource is to download and explore source code for:

+
- - -
-

2 Instructions to embed Sixth-3D in your project

-
+
+

3 Instructions to embed Sixth-3D in your project

+

Maven *pom.xml* file snippet:

@@ -319,7 +345,7 @@ Maven *pom.xml* file snippet: <dependency> <groupId>eu.svjatoslav</groupId> <artifactId>sixth-3d</artifactId> - <version>1.0</version> + <version>1.1</version> </dependency> ... </dependencies> @@ -337,13 +363,13 @@ Maven *pom.xml* file snippet:

-See generated code graph using this tool. +For API usage examples, see demos.

-
-

3 TODO features to add

-
+
+

4 TODO features to add

+
  • Partial region/frame repaint: when only one small object changed on the scene, it would be faster to re-render that specific area. @@ -422,16 +448,22 @@ becomes visible.