AnimaL

Tutorial

Documentation

---

Documentation

• Overview
• Modules
• Namespace List
• Class Hierarchy
• Alphabetical List
• Compound List
• File List
• Namespace Members
• Compound Members
• File Members
• Examples

---

Overview

AnimAL Engine

• animal::Engine, the abstract class to represent an animation concept
• animal::KeyFrameEngine, an interpolator (At present linear and Catmull-Rom intepolator)
• animal::MassSpringEngine, a mass-spring physical system
• animal::TetrahedronFiniteElementEngine and animal::TriangleFiniteElementEngine, finite element algorithms

X3D Input/Output format

We use the X3DToolKit library for the implementation of the X3D specification.

• X3DTK::X3D::EngineNode to represent an animal::Engine in X3DTK::X3D::Scene
• X3DTK::X3D::KeyFrameNode to represent an animal::KeyFrameEngine in X3DTK::X3D::Scene
• X3DTK::X3D::MassSpringNode to represent an animal::MassSpringEngine in X3DTK::X3D::Scene
• X3DTK::X3D::TetrahedronFiniteElementNode to represent an animal::TetrahedronFiniteElementEngine in X3DTK::X3D::Scene
• X3DTK::X3D::TriangleFiniteElementNode to represent an animal::TriangleFiniteElementEngine in X3DTK::X3D::Scene

Qt Graphic User Interface (GUI)

• MainController which is the main GUI
• X3DTK::Qt::Viewer to view the 3D scene (see QGLViewer library)
• X3DTK::Qt::X3DTreeQt to edit a X3DTK::X3D::Scene (see X3DToolKit library)
• X3DTK::Qt::X3DTransformQt to edit a X3DTK::X3D::Transform (see X3DToolKit library)
• X3DTK::Qt::KeyFrameEngineQt to control the X3DTK::X3D::KeyFrameNode
• X3DTK::Qt::MassSpringEngineQt to control the X3DTK::X3D::MassSpringNode
• X3DTK::Qt::TetrahedronFiniteElementEngineQt to control the X3DTK::X3D::TetrahedronFiniteElementNode
• X3DTK::Qt::TriangleFiniteElementEngineQt to control the X3DTK::X3D::TriangleFiniteElementNode
• ObjectGUI in order to easily create a Qt interface corresponding to an C++ object without opening Designer

OpenGL tools

• X3DTK::Qt::Viewer to view the 3D scene (see QGLViewer library)
• X3DTK::GL::MyRenderer to render the X3DTK::GL::Scene (see X3DToolKit library)
• X3DTK::GL::GLEngineNode to represent a X3DTK::X3D::EngineNode in a X3DTK::GL::Scene
• X3DTK::GL::X3DGLMapBuilder to builds a X3DGLMapBuilder
• See also ogl_tools.h, ogl_matrix.hpp, ogl_interface.hpp

Linear algebra and arrays

• Basic (fortran-like) vector and matrix operations (including linear equation solution)
• Fixed-size vectors: animal::Array. Specializations animal::Vec2, animal::Vec3 and animal::Vec4 are available. Fixed-sized matrices can be implemented using Array<Array>.
• Enhanced stl vector with range checking on operator [ ]: animal::vector
• Matrices with run-time resizing: animal::Matrix

Other mathematical tools

• animal::Quaternion, animal::Rotation2d
• Optimization tools adpapted from Numerical Recipes in c.
  Minimization of functions: brent.h, dbrent.hpp, dlinmin.hpp, linmin.hpp, frprmn.hpp, golden.h, mnbrak.hpp, powell.hpp
• Time integration methods: see animal::ExplicitIntegrator and animal::ExplicitIntegrator2

Other useful tools

• Easily parse a command line using animal::ArgumentParser

---