Browse Source

SceneGraph: make it possible to search for the Object*D/Scene*D typedefs.

Use code is full of these things and this makes it easier to discover.
pull/268/head
Vladimír Vondruš 8 years ago
parent
commit
623786e1db
  1. 2
      src/Magnum/SceneGraph/Object.h
  2. 10
      src/Magnum/SceneGraph/Scene.h

2
src/Magnum/SceneGraph/Object.h

@ -52,6 +52,8 @@ namespace Implementation {
/**
@brief Object
@m_keywords{Object2D Object3D}
Base of scene graph. Contains specific transformation implementation, takes
care of parent/children relationship and contains features. See @ref scenegraph
for introduction.

10
src/Magnum/SceneGraph/Scene.h

@ -36,8 +36,16 @@ namespace Magnum { namespace SceneGraph {
/**
@brief Scene
@m_keywords{Scene2D Scene3D}
Basically @ref Object which cannot have parent or non-default transformation.
See @ref scenegraph for introduction.
Common usage is to typedef @ref Scene with desired transformation type to save
unnecessary typing later, along with @ref Object and possibly other types,
e.g.:
@snippet MagnumSceneGraph.cpp Object-typedef
See @ref scenegraph for an introduction.
*/
template<class Transformation> class Scene: public Object<Transformation> {
public:

Loading…
Cancel
Save