start to rewrite the Bullet manual and check-in the Latex source

This commit is contained in:
erwin.coumans
2012-10-03 19:34:43 +00:00
parent 74db95d827
commit 416b8477b3
5 changed files with 1987 additions and 0 deletions

1815
docs/bullet_logo_2010_9.eps Normal file

File diff suppressed because it is too large Load Diff

BIN
docs/bullet_manual.pdf Normal file

Binary file not shown.

59
docs/bullet_manual.tex Normal file
View File

@@ -0,0 +1,59 @@
% Bullet Physics manual
% http://bulletphysics.org
% Written by Erwin Coumans
% Preamble or the global definitions of the book/manual
% Use openany to avoid empty page after TOC
\documentclass[openany]{book}
% The english package can help breaking words
\usepackage[english]{babel}
% Titlepic allows us to use a picture on the frontpage
\usepackage{titlepic}
\usepackage{graphicx}
\usepackage[a4paper, top=3cm, bottom=3cm]{geometry}
\usepackage[latin1]{inputenc}
% If using \doublespacing include the setspace package
% \usepackage{setspace}
\usepackage{fancyhdr}
\usepackage{tocloft}
% The hyperref package already include package url
\usepackage[colorlinks=true]{hyperref}
% \setcounter{secnumdepth}{4}
\usepackage{makeidx}\makeindex
% Set the tolerance so TeX really breaks the line
% and don't run into the right margin (avoid overfull boxes)
\tolerance=5000
\begin{document}
% \pagestyle{fancy}
\pagenumbering{arabic}
\title{\textbf{Bullet 2.81 Physics SDK Manual}}
\titlepic{\includegraphics[width=0.7\textwidth]{bullet_logo_2010_9.eps}}
\author{Erwin Coumans}
\maketitle
\renewcommand{\cftchapdotsep}{\cftdotsep}
\tableofcontents
% \fancyhf{}
% \doublespacing
% include all the chapters as separate tex files
% on Mac OSX it is really nice to use the Texpad application for automatic navigation
\include{intro}
\clearpage
\addcontentsline{toc}{chapter}{Index}
\printindex
\end{document}

45
docs/intro.tex Normal file
View File

@@ -0,0 +1,45 @@
%Use the \path{Demos/MyDemo} instead of \texttt{Demos/MyDemo} otherwise text doesn't wrap
%and runs into the right margin
\chapter{Introduction to Bullet}
%\section{blablaIntroduction}
Bullet Physics is a professional open source collision detection, rigid body and soft body dynamics library. The library is free for commercial use under the \index{zlib license} \href{http://opensource.org/licenses/zlib-license.php}{zlib license}.
\section{Main Features}
\begin{itemize}
\item Open source C++ code under zlib license and free for any commercial use on all platforms including PLAYSTATION 3, XBox 360, Wii, PC, Linux, Mac OSX, Android and iPhone
\item Discrete and continuous collision detection including ray and convex sweep test. Collision shapes include concave and convex meshes and all basic primitives
\item Fast and stable rigid body dynamics constraint solver, vehicle dynamics, character controller and slider, hinge, generic 6DOF and cone twist constraint for ragdolls
\item Soft Body dynamics for cloth, rope and deformable volumes with two-way interaction with rigid bodies, including constraint support
\item Maya Dynamica plugin, Blender integration, COLLADA physics import/export support
\end{itemize}
\section{Contact and Support}
\begin{itemize}
\item Public forum for support and feedback is available at \url{http://bulletphysics.org}
\item PLAYSTATION 3 licensed developers can download an optimized version for Cell SPU through Sony \href{https://ps3.scedev.net/projects/spubullet}{PS3 Devnet}.
\end{itemize}
\section{What's new}
\subsection{New in Bullet 2.81}
\begin{itemize}
\item SIMD and Neon optimizations for iOS and Mac OSX, thanks to a contribution from Apple
\item Rolling Friction using a constraint, thanks to Erin Catto for the idea. \\See \path{Demos/RollingFrictionDemo/RollingFrictionDemo.cpp}
\item XML serialization\\See \path{Bullet/Demos/BulletXmlImportDemo} and \path{Bullet/Demos/SerializeDemo}
\item Gear constraint\\See \path{Bullet/Demos/ConstraintDemo}.
\item Improved continuous collision response, feeding speculative contacts to the constraint solver. See \path{Bullet/Demos/CcdPhysicsDemo}
\item Improved premake4 build system including support for Mac OSX, Linux and iOS
\item Refactoring of collision detection pipeline using stack allocation instead of modifying the collision object. This will allow better future multithreading optimizations.
\end{itemize}
\section{Building the Bullet SDK and demos}
Windows developers can download the zipped sources of Bullet from \url{http://bullet.googlecode.com}. Mac OS X, Linux and other developers should download the gzipped tar archive.
\subsection{Using premake with Visual Studio}
After unzipping the source code, you can open the \path{Bullet/build} directory and double click on \path{vs2010.bat} to generate Visual Studio 2010 project files and solution. Just open \path{Bullet/build/vs2010/0BulletSolution.sln}
\subsection{Using premake with Xcode for Mac OSX or iOS}
\subsection{Using cmake}
\subsection{Using autotools}

68
docs/titlepic.sty Normal file
View File

@@ -0,0 +1,68 @@
% titlepic.sty is a LaTeX package to show a picture on the cover produced by \maketitle.
% By Thomas ten Cate <ttencate@gmail.com>. Free software, no warranty of any kind.
%
% Version history:
% 1.1: now more self-contained, comes with a PDF manual
% 1.0: first release
%
% -----------------------------------------------------------------------------
% No idea whether it works on older LaTeXes.
\NeedsTeXFormat{LaTeX2e}
% Package identification and version number.
\ProvidesPackage{titlepic}[2009/08/03 1.1 Package to display a picture on the title page]
% Declare the options.
\DeclareOption{tt}{\gdef\@tptopspace{}\gdef\@tpsepspace{\vskip 3em}}
\DeclareOption{tc}{\gdef\@tptopspace{}\gdef\@tpsepspace{\vfil}}
\DeclareOption{cc}{\gdef\@tptopspace{\null\vfil}\gdef\@tpsepspace{\vskip 3em}}
\ExecuteOptions{cc}
\ProcessOptions
% Define the sole command introduced by this package.
% Very similar to the definition of \title, etc.
\def\titlepic#1{\gdef\@titlepic{#1}}
\def\@titlepic{\@empty} % default: no picture
% If a title page was requested from the document class (article/report/book),
% override \maketitle to show our picture.
\if@titlepage
\renewcommand\maketitle{
\begin{titlepage}%
\let\footnotesize\small
\let\footnoterule\relax
\let \footnote \thanks
\@tptopspace%
\begin{center}%
{\LARGE \@title \par}%
\vskip 3em%
{\large
\lineskip .75em%
\begin{tabular}[t]{c}%
\@author
\end{tabular}\par%
}%
\vskip 1.5em%
{\large \@date \par}% % Set date in \large size.
\end{center}\par
\@tpsepspace%
{\centering\@titlepic\par}
\vfil
\@thanks
\end{titlepage}%
\setcounter{footnote}{0}%
\global\let\thanks\relax
\global\let\maketitle\relax
\global\let\@thanks\@empty
\global\let\@author\@empty
\global\let\@date\@empty
\global\let\@title\@empty
\global\let\@titlepic\@empty
\global\let\title\relax
\global\let\author\relax
\global\let\date\relax
\global\let\and\relax
\global\let\titlepic\relax
}
\fi