Browse Source

doc: compiling Debug Tools page code snippets.

pull/233/head
Vladimír Vondruš 8 years ago
parent
commit
6f4e6ef2e6
  1. 16
      doc/debug-tools.dox
  2. 7
      doc/snippets/CMakeLists.txt
  3. 52
      doc/snippets/MagnumDebugTools.cpp

16
doc/debug-tools.dox

@ -59,21 +59,7 @@ given key doesn't exist, default fallback is used.
Example usage: visualizing object position, rotation and scaling using Example usage: visualizing object position, rotation and scaling using
@ref DebugTools::ObjectRenderer : @ref DebugTools::ObjectRenderer :
@code{.cpp} @snippet MagnumDebugTools.cpp debug-tools-renderers
// Global instance of debug resource manager, drawable group for the renderers
DebugTools::ResourceManager manager;
SceneGraph::DrawableGroup3D debugDrawables;
// Create renderer options which will be referenced later by "my" resource key
DebugTools::ResourceManager::instance().set("my",
DebugTools::ObjectRendererOptions().setSize(0.3f));
// Create debug renderer for given object, use "my" options for it. The
// renderer is automatically added to the object features and also to
// specified drawable group.
Object3D* object;
new DebugTools::ObjectRenderer2D(*object, "my", debugDrawables);
@endcode
See @ref DebugTools::ObjectRenderer and @ref DebugTools::ShapeRenderer for more See @ref DebugTools::ObjectRenderer and @ref DebugTools::ShapeRenderer for more
information. information.

7
doc/snippets/CMakeLists.txt

@ -45,6 +45,13 @@ set_target_properties(snippets PROPERTIES FOLDER "Magnum/doc/snippets")
find_package(Corrade COMPONENTS TestSuite) find_package(Corrade COMPONENTS TestSuite)
if(WITH_DEBUGTOOLS)
add_library(snippets-MagnumDebugTools STATIC
MagnumDebugTools.cpp)
target_link_libraries(snippets-MagnumDebugTools PRIVATE MagnumDebugTools)
set_target_properties(snippets-MagnumDebugTools PROPERTIES FOLDER "Magnum/doc/snippets")
endif()
# TODO: causes spurious linker errors on Travis iOS build, so I'm disabling it # TODO: causes spurious linker errors on Travis iOS build, so I'm disabling it
if(WITH_DEBUGTOOLS AND Corrade_TestSuite_FOUND AND NOT CORRADE_TARGET_IOS) if(WITH_DEBUGTOOLS AND Corrade_TestSuite_FOUND AND NOT CORRADE_TARGET_IOS)
set(SNIPPETS_DIR ${CMAKE_CURRENT_SOURCE_DIR}) set(SNIPPETS_DIR ${CMAKE_CURRENT_SOURCE_DIR})

52
doc/snippets/MagnumDebugTools.cpp

@ -0,0 +1,52 @@
/*
This file is part of Magnum.
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018
Vladimír Vondruš <mosra@centrum.cz>
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
*/
#include <Magnum/DebugTools/ResourceManager.h>
#include <Magnum/DebugTools/ObjectRenderer.h>
#include <Magnum/SceneGraph/Drawable.h>
#include <Magnum/SceneGraph/Object.h>
#include <Magnum/SceneGraph/MatrixTransformation3D.h>
using namespace Magnum;
int main() {
{
SceneGraph::Object<SceneGraph::MatrixTransformation3D>* object{};
/* [debug-tools-renderers] */
// Global instance of debug resource manager, drawable group for the renderers
DebugTools::ResourceManager manager;
SceneGraph::DrawableGroup3D debugDrawables;
// Create renderer options which will be referenced later by "my" resource key
DebugTools::ResourceManager::instance().set("my",
DebugTools::ObjectRendererOptions{}.setSize(0.3f));
// Create debug renderer for given object, use "my" options for it. The
// renderer is automatically added to the object features and also to
// specified drawable group.
new DebugTools::ObjectRenderer3D{*object, "my", &debugDrawables};
/* [debug-tools-renderers] */
}
}
Loading…
Cancel
Save