Browse Source

SceneGraph: doc++

Mention default template arguments and LinkedList usage.
pull/7/head
Vladimír Vondruš 14 years ago
parent
commit
6dc7a163cc
  1. 5
      doc/scenegraph.dox
  2. 3
      src/SceneGraph/AbstractFeature.h
  3. 2
      src/SceneGraph/AbstractObject.h
  4. 6
      src/SceneGraph/Object.h

5
doc/scenegraph.dox

@ -24,6 +24,11 @@ Transformation handles object position, rotation etc. and its basic property
is dimension count (2D or 3D) and underlying floating-point type (by default is dimension count (2D or 3D) and underlying floating-point type (by default
`float`s are used everywhere, but you can use `double`s too). `float`s are used everywhere, but you can use `double`s too).
@note All classes in SceneGraph have `GLfloat` as default underlying
floating-point type, which means that you can omit that template parameter
and write just <tt>%AbstractObject<2></tt> or <tt>%MatrixTransformation3D<></tt>
instead of <tt>%AbstractObject<2, GLfloat></tt> and <tt>%MatrixTransformation3D&lt;GLfloat&gt;</tt>.
%Scene graph has implementation of transformations in both 2D and 3D, using %Scene graph has implementation of transformations in both 2D and 3D, using
either matrices or combination of position and rotation. Each implementation either matrices or combination of position and rotation. Each implementation
has its own advantages and disadvantages -- for example when using matrices has its own advantages and disadvantages -- for example when using matrices

3
src/SceneGraph/AbstractFeature.h

@ -45,6 +45,9 @@ namespace Implementation {
Contained in Object, takes care of transformation caching. See @ref scenegraph Contained in Object, takes care of transformation caching. See @ref scenegraph
for introduction. for introduction.
Uses Corrade::Containers::LinkedList for accessing holder object and sibling
features.
@section AbstractFeature-subclassing Subclassing @section AbstractFeature-subclassing Subclassing
Feature is templated on dimension count and underlying transformation type, so Feature is templated on dimension count and underlying transformation type, so

2
src/SceneGraph/AbstractObject.h

@ -35,6 +35,8 @@ 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.
@see AbstractObject2D, AbstractObject3D @see AbstractObject2D, AbstractObject3D
*/ */
#ifndef DOXYGEN_GENERATING_OUTPUT #ifndef DOXYGEN_GENERATING_OUTPUT

6
src/SceneGraph/Object.h

@ -46,8 +46,10 @@ namespace Implementation {
@brief %Object @brief %Object
Base of scene graph. Contains specific transformation implementation, takes Base of scene graph. Contains specific transformation implementation, takes
care of parent/children relationships and contains features. See care of parent/children relationship and contains features. See @ref scenegraph
@ref scenegraph for introduction. for introduction.
Uses Corrade::Containers::LinkedList for parent/children relationship.
@section Object-explicit-specializations Explicit template specializations @section Object-explicit-specializations Explicit template specializations

Loading…
Cancel
Save