X-Git-Url: http://www2.svjatoslav.eu/gitweb/?p=sixth-3d.git;a=blobdiff_plain;f=doc%2Findex.org;h=b164b18351be795157a6cba27c686ca2c4eb1d68;hp=2f9bba17b20156d9e85098beb499cd3469e1589f;hb=84d9d8e0f410351bf7938a33472452b799a8dc59;hpb=0456082ca4406696cb61fce46b1b3739dcb55872 diff --git a/doc/index.org b/doc/index.org index 2f9bba1..b164b18 100644 --- a/doc/index.org +++ b/doc/index.org @@ -1,42 +1,73 @@ #+TITLE: Sixth 3D - 3D engine ------ -- This is a subproject of [[http://www2.svjatoslav.eu/gitbrowse/sixth/doc/index.html][Sixth]] +* (document settings) :noexport: +** use dark style for TWBS-HTML exporter +#+HTML_HEAD: +#+HTML_HEAD: +#+HTML_HEAD: +#+HTML_HEAD: -- [[http://www2.svjatoslav.eu/gitweb/?p=sixth-3d.git;a=snapshot;h=HEAD;sf=tgz][download latest snapshot]] +* General +- This is a subproject of [[https://www3.svjatoslav.eu/projects/sixth/][Sixth]] -- This program is free software; you can redistribute it and/or modify it under - the terms of version 3 of the [[https://www.gnu.org/licenses/lgpl.html][GNU Lesser General Public License]] or later as - published by the Free Software Foundation. +- This program is free software: you can redistribute it and/or modify + it under the terms of the [[https://www.gnu.org/licenses/lgpl.html][GNU Lesser General Public License]] as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. - Program author: - Svjatoslav Agejenko - - Homepage: http://svjatoslav.eu + - Homepage: https://svjatoslav.eu - Email: mailto://svjatoslav@svjatoslav.eu -- [[http://www.svjatoslav.eu/programs.jsp][other applications hosted at svjatoslav.eu]] +- [[https://www.svjatoslav.eu/projects/][Other software projects hosted at svjatoslav.eu]] -* (document settings) :noexport: -** use dark style for TWBS-HTML exporter -#+HTML_HEAD: -#+HTML_HEAD: -#+HTML_HEAD: " -#+HTML_HEAD: +** Source code +- [[https://www2.svjatoslav.eu/gitweb/?p=sixth-3d.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]] + +- [[https://www2.svjatoslav.eu/gitweb/?p=sixth-3d.git;a=summary][Browse Git repository online]] + +- Clone Git repository using command: + : git clone https://www2.svjatoslav.eu/git/sixth-3d.git + +- See [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/][JavaDoc]]. * Project description -In-software, pure Java realtime 3D rendering engine. With the final ++ See: [[https://www3.svjatoslav.eu/projects/sixth-3d-demos/][demos of current 3D engine capabilities]] + +[[id:d03013e5-931b-40ca-bc4b-e4b3f23b9a4e][In software]], [[id:a11f7150-1b25-4ca4-a3c3-8c8bd1352bd4][pure Java]] realtime 3D rendering engine. With the final goal of becoming a platform for buildng 3D user interfaces and -interactive data visualization. +interactive data visualization for [[https://www3.svjatoslav.eu/projects/sixth/][project Sixth]]. -+ See: [[http://www2.svjatoslav.eu/gitbrowse/sixth-3d-demos/doc/index.html][demos of current 3D engine capabilities]] +Sixth 3D can be also used as standalone [[id:08f71987-90af-40dc-bb65-bac87db9e652][3D engine in your project]]. +** Justification for software rendering + :PROPERTIES: + :ID: d03013e5-931b-40ca-bc4b-e4b3f23b9a4e + :END: +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. +** Justification for Java + :PROPERTIES: + :ID: a11f7150-1b25-4ca4-a3c3-8c8bd1352bd4 + :END: - 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 going for GPU offered brute-force rendering approach). @@ -54,22 +85,19 @@ System is implemented in Java because: - As a result it is easy to run on various hardware platforms and operating systems. -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. - -Also CPU rendering allows to easily test different rendering -algorithms and retains complete control of every rendered pixel. +* API documentation +- See [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/][JavaDoc]]. +Note: due to a lack of time, there is still big room for improvement +on documentation. +So far best resource is to download and explore source code for: ++ 3D engine ([[https://www3.svjatoslav.eu/projects/sixth-3d/graphs/][generated code graphs]] (generated using [[https://www3.svjatoslav.eu/projects/javainspect/][JavaInspect]])) ++ For API usage examples, see [[https://www3.svjatoslav.eu/projects/sixth-3d-demos/][demos]] * Instructions to embed Sixth-3D in your project + :PROPERTIES: + :ID: 08f71987-90af-40dc-bb65-bac87db9e652 + :END: Maven *pom.xml* file snippet: #+BEGIN_SRC xml @@ -77,7 +105,7 @@ Maven *pom.xml* file snippet: eu.svjatoslav sixth-3d - 1.0 + 1.1 ... @@ -93,7 +121,7 @@ Maven *pom.xml* file snippet: #+END_SRC -See [[file:codeGraph/index.html][generated code graph]] using [[http://www2.svjatoslav.eu/gitbrowse/javainspect/doc/index.html][this tool]]. +For API usage examples, see [[https://www3.svjatoslav.eu/projects/sixth-3d-demos/][demos]]. * 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.