- Documentation updates

- Add Version.h
- Modify CMakeLists.txt
	- Add install
	- Add doxygen

CMakeLists.txt

@@ -2,12 +2,15 @@ CMAKE_MINIMUM_REQUIRED(VERSION 2.6)
 
 PROJECT(ANKI_PROJ)
 
-IF(${CMAKE_SYSTEM_NAME} STREQUAL Linux)
-	ADD_DEFINITIONS("-DPLATFORM_LINUX")
-ELSEIF(${CMAKE_SYSTEM_NAME} STREQUAL Windows)
-	ADD_DEFINITIONS("-DPLATFORM_WINDOWS")
-ENDIF()
+#
+# Install
+#
+SET(INCLUDE_INSTALL_DIR "${CMAKE_INSTALL_PREFIX}/include/" CACHE PATH "The subdirectory to the header prefix")
+SET(LIB_INSTALL_DIR "${CMAKE_INSTALL_PREFIX}/lib" CACHE PATH "Library install path")
 
+#
+# SVN
+#
 FIND_PACKAGE(Subversion)
 IF(Subversion_FOUND)
 	Subversion_WC_INFO(${CMAKE_CURRENT_SOURCE_DIR} ER)
@@ -16,6 +19,32 @@ ELSE()
 	ADD_DEFINITIONS("-DANKI_REVISION=???")
 ENDIF()
 
+# 
+# Version
+#
+SET(ANKI_VERSION 0.1)
+
+CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/anki/Version.h 
+	${CMAKE_CURRENT_BINARY_DIR}/anki/Version.h)
+
+INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/anki/Version.h 
+	DESTINATION ${INCLUDE_INSTALL_DIR}/anki)
+	
+#
+# Doxygen
+#
+FIND_PACKAGE(Doxygen)
+IF(DOXYGEN_FOUND)
+	CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/docs/doxyfile ${CMAKE_CURRENT_BINARY_DIR}/doxyfile @ONLY)
+	
+	ADD_CUSTOM_TARGET(doc
+${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/doxyfile
+WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Generating API documentation with Doxygen" VERBATIM)
+ENDIF()
+
+#
+# Defines & flags
+#
 ADD_DEFINITIONS("-DANKI_MATH_INTEL_SIMD -DGLEW_MX -pedantic-errors -pedantic -ansi -Wall -Winline -W -Wwrite-strings -Wno-unused -Wno-long-long -msse4")
 
 # Add a few compiler specific stuff 
@@ -25,6 +54,12 @@ ELSE()
 	ADD_DEFINITIONS("-fsingle-precision-constant")
 ENDIF()
 
+IF(${CMAKE_SYSTEM_NAME} STREQUAL Linux)
+	ADD_DEFINITIONS("-DPLATFORM_LINUX")
+ELSEIF(${CMAKE_SYSTEM_NAME} STREQUAL Windows)
+	ADD_DEFINITIONS("-DPLATFORM_WINDOWS")
+ENDIF()
+
 IF(CMAKE_BUILD_TYPE STREQUAL Debug)
 	ADD_DEFINITIONS("-D_GLIBCXX_DEBUG -D_GLIBXX_DEBUG_PEDANTIC")
 ELSE()
@@ -40,12 +75,33 @@ INCLUDE_DIRECTORIES(.)
 
 LINK_DIRECTORIES(${ANKI_PROJ_SOURCE_DIR}/extern/lib64)
 
-# Lib dependencied
+# Lib dependencies
 FIND_PACKAGE(Boost 1.46 REQUIRED)
 FIND_PACKAGE(PNG 1.2 REQUIRED)
 FIND_PACKAGE(JPEG 62 REQUIRED)
 FIND_PACKAGE(Freetype 2.4.4 REQUIRED)
 FIND_PACKAGE(PythonLibs 2.6 REQUIRED)
 
+#
+# libanki
+#
 ADD_SUBDIRECTORY(anki)
-ADD_SUBDIRECTORY(testapp)
+
+#
+# Unit tests
+#
+OPTION(BUILD_UNIT_TESTS "Build Unit Tests" OFF)
+
+IF(BUILD_UNIT_TESTS)
+	ENABLE_TESTING()
+	ADD_SUBDIRECTORY(unit-tests)
+ENDIF()
+
+#
+# testapp
+#
+OPTION(BUILD_TESTAPP "Build Test Application" ON)
+
+IF(BUILD_TESTAPP)
+	ADD_SUBDIRECTORY(testapp)
+ENDIF()

anki/CMakeLists.txt

@@ -10,3 +10,7 @@ TARGET_LINK_LIBRARIES(anki ${ANKI_LIBS} BulletSoftBody BulletDynamics
 	boost_system boost_python boost_filesystem boost_thread freetype)
 
 SET_TARGET_PROPERTIES(anki PROPERTIES LINKER_LANGUAGE CXX)
+
+INSTALL(TARGETS anki DESTINATION ${LIB_INSTALL_DIR})
+
+INSTALL(DIRECTORY ${ANKI_PROJECT_SOURCE_DIR}/anki DESTINATION "${INCLUDE_INSTALL_DIR}" FILES_MATCHING PATTERN "*.h" PATTERN .svn EXCLUDE)

anki/Version.h

@@ -0,0 +1,9 @@
+#ifndef ANKI_VERSION_H
+#define ANKI_VERSION_H
+
+
+#define ANKI_VERSION ${ANKI_VERSION}
+#define ANKI_REVISION ${ANKI_REVISION}
+
+
+#endif

anki/util/scanner/Scanner.cpp

@@ -782,7 +782,10 @@ void Scanner::checkNumber()
 			double dbl = (double)num + (double)(pow(10, -dad)*fnum);
 			if(exp != 0) // if we have exponent
 			{
-				if(expSign == 1) exp = -exp; // change the sign if necessary
+				if(expSign == true)
+				{
+					exp = -exp; // change the sign if necessary
+				}
 				dbl = dbl * pow(10, exp);
 			}
 

docs/doxyfile

@@ -31,7 +31,7 @@ PROJECT_NAME           = "AnKi 3D Engine"
 # This could be handy for archiving the generated documentation or 
 # if some version control system is used.
 
-PROJECT_NUMBER         = 
+PROJECT_NUMBER         = @[email protected]@ANKI_REVISION@
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
 # base path where the generated documentation will be put. 
@@ -590,7 +590,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.
 
-INPUT                  = ../anki
+INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/anki
 
 # This tag can be used to specify the character encoding of the source files 
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
@@ -1328,7 +1328,7 @@ SEARCH_INCLUDES        = YES
 # contain include files that are not input files but should be processed by 
 # the preprocessor.
 
-INCLUDE_PATH           = ../anki
+INCLUDE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@/anki
 
 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
 # patterns (like *.h and *.hpp) to filter out the header-files in the 

docs/manual.html

@@ -288,8 +288,8 @@ ul.auto-toc {
 
 
 <p><strong>AnKi 3D Engine</strong></p>
-<p>Copyright (C) 2009, 2010 Panagiotis Christopoulos-Charitos</p>
-<p><a class="reference external" href="http://www.ancient-ritual.com">http://www.ancient-ritual.com</a></p>
+<p>Copyright (C) 2009-2011 Panagiotis Christopoulos-Charitos</p>
+<p><a class="reference external" href="http://www.anki3d.org">http://www.anki3d.org</a></p>
 <p><a class="reference external" href="mailto:godlike&#64;ancient-ritual.com">godlike&#64;ancient-ritual.com</a></p>
 <div class="contents topic" id="table-of-contents">
 <p class="topic-title first">Table of Contents</p>
@@ -311,10 +311,11 @@ ul.auto-toc {
 <li><a class="reference internal" href="#order-in-class-definitions" id="id13">Order in class definitions</a></li>
 <li><a class="reference internal" href="#naming-shortcuts" id="id14">Naming shortcuts</a></li>
 <li><a class="reference internal" href="#controllers" id="id15">Controllers</a></li>
-<li><a class="reference internal" href="#submitting-patches" id="id16">Submitting patches</a></li>
+<li><a class="reference internal" href="#glsl-shaders" id="id16">GLSL shaders</a></li>
+<li><a class="reference internal" href="#submitting-patches" id="id17">Submitting patches</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#todo-list" id="id17">ToDo list</a></li>
+<li><a class="reference internal" href="#todo-list" id="id18">ToDo list</a></li>
 </ul>
 </div>
 <div class="section" id="license">
@@ -327,24 +328,27 @@ non-GPLv3 licensed software then you have to apply for a commercial license.</p>
 </div>
 <div class="section" id="building">
 <h1><a class="toc-backref" href="#id2">Building</a></h1>
-<p>AnKi build system is very Linux specific (GNU make only) at the moment. It
-also requires a few extra development libraries.</p>
+<p>AnKi build system is build over the popular CMake.</p>
 <p>To download the latest version of AnKi from the SVN repository type:</p>
-<p>$ svn checkout <a class="reference external" href="http://anki-3d-engine.googlecode.com/svn/trunk/">http://anki-3d-engine.googlecode.com/svn/trunk/</a> anki</p>
+<pre class="literal-block">
+svn checkout http://anki-3d-engine.googlecode.com/svn/trunk/ anki
+</pre>
+<p>to build:</p>
 <div class="section" id="required-external-libraries">
 <h2><a class="toc-backref" href="#id3">Required external libraries</a></h2>
 <p>AnKi requires a few up to date versions of some libraries. The libraries are:</p>
 <ul class="simple">
-<li>Bullet Physics 2.77</li>
-<li>SDL 1.3</li>
-<li>GLEW 1.5.5</li>
-<li>boost 1.4</li>
+<li>Bullet Physics 2.77 (in extern)</li>
+<li>SDL 1.3 (in extern)</li>
+<li>GLEW 1.5.5 (in extern)</li>
+<li>boost 1.46</li>
 <li>libpng 1.2</li>
 <li>libjpeg 6b</li>
 <li>libpython 2.6</li>
 </ul>
 <p>Normally, in order to build AnKi you need to have all of the above libraries.
-Some of them are not provided from the most Linux distros or they are older
+Some of them are not that common and</p>
+<p>Some of them are not provided from the most Linux distros or they are older
 versions. The libraries you have to download and build for yourself are Bullet,
 SDL and GLEW. The other are pretty common and you can find them almost anywhere.</p>
 <p>To ease the building process and to save you some time <strong>some</strong> of the above
@@ -371,10 +375,10 @@ is called gBuildSystem and you can find it in
 using SVN:</p>
 <p>$ svn checkout <a class="reference external" href="http://godlike-projects.googlecode.com/svn/trunk/gBuildSystem">http://godlike-projects.googlecode.com/svn/trunk/gBuildSystem</a></p>
 <p>gBuildSystem only purpose is to re-generate these makefiles in case you have
-made changes in code structure (renaming/moving/deleting/adding files) or in the
-includes (#include) or your have the external libs in different paths.
-gBuildSystem requires the gen.cfg.py files (something like CMakeLists.txt).
-gen.cfg.py format is pretty straightforward and minimal.</p>
+made changes in the code structure (renaming/moving/deleting/adding files) or in
+the included header files (#include) or your have the external libs in different
+paths. gBuildSystem requires the gen.cfg.py files (something like
+CMakeLists.txt). gen.cfg.py format is pretty straightforward and minimal.</p>
 <p>If you want to generate the makefile for the debug target (for example) do the
 following:</p>
 <ol class="arabic simple">
@@ -399,7 +403,7 @@ build it, the application will fail to run.</p>
 <li>Linux OS</li>
 <li>Proprietary GPU drivers</li>
 </ul>
-<p>Development rig: Ubuntu 10.04, AMD Radeon 4870 w/ Catalyst 10.04. So it should
+<p>Development rig: Ubuntu 10.10, AMD Radeon 4870 w/ Catalyst 10.10. So it should
 be working on similar systems.</p>
 </div>
 <div class="section" id="generating-source-code-documentation-doxygen">
@@ -514,8 +518,24 @@ naming convention of the controllers is:</p>
 <p>For Example:</p>
 <p>MeshSkelNodeCtrl A Mesh is controlled by a SkelNode</p>
 </div>
+<div class="section" id="glsl-shaders">
+<h2><a class="toc-backref" href="#id16">GLSL shaders</a></h2>
+<p>The same rules apply to GLSL shaders but with a few changes:</p>
+<p>All the vars you can find in a GLSL shader program are either attributes,
+uniforms or in/out vars (varyings) and everything else. The attributes and
+uniforms are mixed case. The in/out vars are mixed case as well but they have a
+prefix string that indicates their output. For example if a var is output from
+the vertex shader it will have a 'v' before its name. The In detail:</p>
+<p>v: Vertex shader
+tc: Tessellation control shader
+te: Tessellation evaluation shader
+g: Geometry shader
+f: Fragment shader</p>
+<p>All the other variables (locals and globals) inside the code are mixed case but
+with a leading and a following underscore.</p>
+</div>
 <div class="section" id="submitting-patches">
-<h2><a class="toc-backref" href="#id16">Submitting patches</a></h2>
+<h2><a class="toc-backref" href="#id17">Submitting patches</a></h2>
 <p>If you want to update/patch a file (for example Main.cpp) do:</p>
 <ul class="simple">
 <li>Make the changes on that file</li>
@@ -525,7 +545,7 @@ naming convention of the controllers is:</p>
 </div>
 </div>
 <div class="section" id="todo-list">
-<h1><a class="toc-backref" href="#id17">ToDo list</a></h1>
+<h1><a class="toc-backref" href="#id18">ToDo list</a></h1>
 <ul>
 <li><p class="first">Continue working on the new coding style in shaders</p>
 </li>

docs/manual.rst

@@ -1,6 +1,6 @@
 **AnKi 3D Engine**
 
-Copyright (C) 2009-2011 Panayiotis Christopoulos-Charitos
+Copyright (C) 2009-2011 Panagiotis Christopoulos-Charitos
 
 http://www.anki3d.org
 
@@ -25,12 +25,22 @@ non-GPLv3 licensed software then you have to apply for a commercial license.
 Building
 ========
 
-AnKi build system is very Linux specific (GNU make only) at the moment. It
-also requires a few extra development libraries.
+AnKi build system is build over the popular CMake.
 
-To download the latest version of AnKi from the SVN repository type:
+To download the latest version of AnKi from the SVN repository type: ::
 
-$ svn checkout http://anki-3d-engine.googlecode.com/svn/trunk/ anki
+	svn checkout http://anki-3d-engine.googlecode.com/svn/trunk/ anki
+
+to build (from the root directory): ::
+
+	mkdir build
+	cd build
+	cmake ..
+	make
+
+to build the doxygen documentation: ::
+
+	make doc
 
 
 Required external libraries
@@ -38,68 +48,17 @@ Required external libraries
 
 AnKi requires a few up to date versions of some libraries. The libraries are:
   
-- Bullet Physics 2.77
-- SDL 1.3
-- GLEW 1.5.5
-- boost 1.4
+- Bullet Physics 2.77 (provided)
+- SDL 1.3 (provided)
+- GLEW 1.5.5 (provided)
+- boost 1.46
 - libpng 1.2
 - libjpeg 6b
 - libpython 2.6
 
-Normally, in order to build AnKi you need to have all of the above libraries. 
-Some of them are not provided from the most Linux distros or they are older
-versions. The libraries you have to download and build for yourself are Bullet,
-SDL and GLEW. The other are pretty common and you can find them almost anywhere.
-
-
-To ease the building process and to save you some time **some** of the above
-libraries are already backed and placed inside the extern directory. The backed
-libraries are for Linux and for x86-64 architecture. If you dont trust my
-binaries and/or you want to build the libs yourselves you have to download,
-build and install the libs in the extern directory manually. The script
-*download-externs.sh* downloads the libraries (it requires SVN, mercurial,
-CMake, autoconf) and the *do-externs.sh* builds the libraries and installs them
-in the extern directory. Open the files and see how it is done.
-
-You wont find any development files for boost, libpng, libjpeg and libpython
-inside the extern dir. Get them using your Linux distribution's packet manager.
-
-
-Building AnKi and optionally generating makefiles
--------------------------------------------------
-
-Inside the build directory you can find 4 build targets containing GNU
-makefiles. If you want to build AnKi just type "make" from inside a target.
-
-**WARNING**: Sometimes I forget to update all the targets. The debug is always 
-updated though.
-
-AnKi uses a build system that generates the above makefiles. This build system
-is no longer part of AnKi and its located in a different repository. This tool
-is called gBuildSystem and you can find it in
-http://godlike-projects.googlecode.com/svn/trunk/gBuildSystem. Downloaded it
-using SVN:
-
-$ svn checkout http://godlike-projects.googlecode.com/svn/trunk/gBuildSystem
-
-
-gBuildSystem only purpose is to re-generate these makefiles in case you have
-made changes in the code structure (renaming/moving/deleting/adding files) or in
-the included header files (#include) or your have the external libs in different
-paths. gBuildSystem requires the gen.cfg.py files (something like
-CMakeLists.txt). gen.cfg.py format is pretty straightforward and minimal.
-
-If you want to generate the makefile for the debug target (for example) do the
-following:
-
-#) $ cd <path to anki>/build/debug
-#) $ <path to gBuildSystem>/gbs.py
-
-To build:
-
-$ make
-
-And the build process will begin. 
+Some of the above libraries are pretty standard and they are included in all 
+major Linux/Unix distributions. Some of them are not that standard though. The 
+non-standard are already build and located in the extern directory.
   
 
 ======
@@ -120,22 +79,8 @@ The engine requires:
 - Linux OS
 - Proprietary GPU drivers
 
-Development rig: Ubuntu 10.10, AMD Radeon 4870 w/ Catalyst 10.10. So it should
-be working on similar systems.
-
-
-==============================================
-Generating source code documentation (doxygen)
-==============================================
-
-The AnKi source code uses doxygen style comments in almost every file. To
-generate the documentation you need doxygen (http://www.doxygen.org/). From a
-terminal type:
-
-#) $ cd docs
-#) $ doxygen doxyfile
-
-Then open doxygen.html to see it.
+Development rig: Ubuntu 11.10, nVidia 560 Ti. So it should be working on 
+similar systems.
   
 
 ============