From 623786e1dbc917f3c7e0b42c85af9566d0961da1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sat, 4 Aug 2018 15:26:24 +0200 Subject: [PATCH] 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. --- src/Magnum/SceneGraph/Object.h | 2 ++ src/Magnum/SceneGraph/Scene.h | 10 +++++++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/src/Magnum/SceneGraph/Object.h b/src/Magnum/SceneGraph/Object.h index 2adbde0f9..63f8b85ef 100644 --- a/src/Magnum/SceneGraph/Object.h +++ b/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. diff --git a/src/Magnum/SceneGraph/Scene.h b/src/Magnum/SceneGraph/Scene.h index 2b9fb3beb..978e71bb2 100644 --- a/src/Magnum/SceneGraph/Scene.h +++ b/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 Scene: public Object { public: