Browse Source

Doc++

pull/7/head
Vladimír Vondruš 14 years ago
parent
commit
3b3a164212
  1. 9
      src/Platform/GlutApplication.h
  2. 9
      src/SceneGraph/AbstractObject.h
  3. 7
      src/SceneGraph/Object.h

9
src/Platform/GlutApplication.h

@ -91,10 +91,11 @@ class GlutApplication {
/** /**
* @brief Draw event * @brief Draw event
* *
* Here implement your drawing functions, such as calling * Called when the screen is redrawn. You should clean the framebuffer
* SceneGraph::AbstractCamera::draw(). After drawing is finished, call * using Framebuffer::clear() and then add your own drawing functions,
* swapBuffers(). If you want to draw immediately again, call also * such as calling SceneGraph::AbstractCamera::draw(). After drawing
* redraw(). * is finished, call swapBuffers(). If you want to draw immediately
* again, call also redraw().
*/ */
virtual void drawEvent() = 0; virtual void drawEvent() = 0;

9
src/SceneGraph/AbstractObject.h

@ -35,7 +35,14 @@ Provides minimal interface for features, not depending on object transformation
implementation. This class is not directly instantiatable, use Object subclass implementation. This class is not directly instantiatable, use Object subclass
instead. See also @ref scenegraph for more information. instead. See also @ref scenegraph for more information.
Uses Corrade::Containers::LinkedList for storing features. Uses Corrade::Containers::LinkedList for storing features. Traversing through
the list is done like in the following code. It is also possible to go in
reverse order using lastFeature() and AbstractFeature::previousFeature().
@code
for(AbstractFeature* feature = o->firstFeature(); feature; feature = feature->nextFeature()) {
// ...
}
@endcode
@see AbstractObject2D, AbstractObject3D @see AbstractObject2D, AbstractObject3D
*/ */

7
src/SceneGraph/Object.h

@ -50,6 +50,13 @@ care of parent/children relationship and contains features. See @ref scenegraph
for introduction. for introduction.
Uses Corrade::Containers::LinkedList for parent/children relationship. Uses Corrade::Containers::LinkedList for parent/children relationship.
Traversing through the list is done like in the following code. It is also
possible to go in reverse order using lastChild() and previousSibling().
@code
for(Object* child = o->firstChild(); child; child = child->nextSibling()) {
// ...
}
@endcode
@section Object-explicit-specializations Explicit template specializations @section Object-explicit-specializations Explicit template specializations

Loading…
Cancel
Save