docs/content/main-page.h

   1 /*! \mainpage
   2  *
   3  * \section mainintro_sec Introduction
   4  *
   5  * It is a quick and easy way of allowing developers to create Rich UI Applications like Home
   6  * screen, Gallery, Music player, Games, Maps...
   7  *
   8  * DALI is based on OpenGL ES 2.0, however it hides the complexity of
   9  * the OpenGL API from developers and provides a clean cross-platform C++ framework.
  10  *
  11  * \section Introduction Introduction
  12  * - \link fundamentals Dali Fundamentals \endlink
  13  * - \link dali-application Dali Application and Adaptor \endlink
  14  * - \link hello-world Hello World - explained \endlink
  15  *
  16  * \section Actors Actors
  17  * - \link image-text-mesh-actor Image, Text and Mesh actors \endlink
  18  * - \link event-system Event Handling \endlink
  19  * - \link custom-actor Custom Actor \endlink
  20  *
  21  * \section ShaderEffects Shader Effects
  22  * - \link shader-intro Shader Effects\endlink
  23  *
  24  * \section Animation Animation
  25  * - \link animation-example Example and Usage\endlink
  26  * - \link animation-rotation Rotation with quaternions \endlink
  27  * - \link animation-shader Shader Animation \endlink
  28  * - \link animation-multi-threading-notes Multi-threading Notes \endlink
  29  *
  30  * \section Constraints
  31  * - \link constraints-intro Introduction to Constraints \endlink
  32  *
  33  * \section UIControls UI Controls
  34  * - \link item-view Item View \endlink
  35  * - \link text-view Text View \endlink
  36  * - \link text-input Text Input \endlink
  37  * - \link scroll-view Scroll View \endlink
  38  * - \link markup-processor Markup Processor \endlink
  39  * - \link size-negotiation Size Negotiation \endlink
  40  * - \link type-registration Type Registration \endlink
  41  * - \link properties Properties \endlink
  42  * - \link background Background \endlink
  43  *
  44  * \section Dynamics Dynamics
  45  * - \link dynamics-intro Introduction to Dynamics\endlink
  46  * - \link dynamics-initialization Initializing the Simulation\endlink
  47  * - \link dynamics-bodies Bodies - adding and controlling dynamic objects \endlink
  48  * - \link dynamics-joints Joints - linking objects\endlink
  49  * - \link dynamics-collisions Collision Detection and Filtering\endlink
  50  *
  51  * \section Scripting
  52  * - \link script-overview Overview \endlink
  53  * - \link script-howto How to Add a Custom Control \endlink
  54  * - \link script-hello Hello World in script \endlink
  55  *
  56  * - \link handle-body-idiom Handle – body idiom \endlink
  57  * - \link boost-library Boost Library \endlink
  58  * - \link boost-function Boost function usage \endlink
  59  *
  60  * \section Rendering
  61  * - \link viewing-modes Viewing modes \endlink
  62  *
  63  * \section Profiling
  64  * - \link resource-tracking Resource Tracking \endlink
  65  * - \link performance-profiling Performance Profiling \endlink
  66  *
  67  * \section Performance
  68  * - \link performance-tips Performance Tips \endlink
  69  * - \link texture-atlases Texture Atlases  \endlink
  70  * - \link Texture_Compression Compressing Textures \endlink
  71  *
  72  */
  73
  74 /*! \page scene-graph
  75  *
  76  * \section scene_intro What is a scene graph?
  77  * From wikipedia...
  78  * A scene graph is a collection of nodes in a graph or tree structure.
  79  * A node may have many children but often only a single parent,
  80  * with the effect of a parent applied to all its child nodes;
  81  * an operation performed on a group automatically propagates
  82  * its effect to all of its members. In many programs, associating
  83  * a geometrical transformation matrix (see also transformation and matrix)
  84  * at each group level and concatenating such matrices together is an
  85  * efficient and natural way to process such operations. A common feature,
  86  * for instance, is the ability to group related shapes/objects into a
  87  * compound object that can then be moved, transformed, selected,
  88  * etc. as easily as a single object.
  89  *
  90  * \section scene_dali How does this relate to the Dali public API?
  91  *
  92  * Actors are effectively nodes that receive input (touch events) and act as a
  93  * container for draw-able elements (which are also nodes) and other actors.
  94  *
  95  * For example a Button actor will be an actor with several elements such as button background,
  96  * text label and button face. When the actor is moved around, it's child elements will move with it.
  97  * When the button is pressed, the actor will receive an event and adjust the color of its button face
  98  * element.
  99  *
 100  * \section scene_dali Why does Dali internally have a second scene graph?
 101  * Actors and elements are contained in a scene graph which deals with input, layout and some animation
 102  * it doesn't perform any drawing.
 103  *
 104  * All the drawing is done via the Render Manager which has it's own render scene graph, where it's nodes
 105  * are just for drawing things like image/text and moving them around. So when you create an Image element
 106  * it will ask the RenderManager to create an Image node. The separation allows the RenderManager to
 107  * run in a separate thread to maintain a high frame rate, without being slowed down by any logic
 108  * performed on the actor/element side.
 109  *
 110  */