From 6cbf3439c8611e19edffb0271be42748743d0d77 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Fri, 25 Jan 2013 15:02:07 +0100 Subject: [PATCH] Doc++ --- src/DebugTools/Implementation/BoxRenderer.cpp | 1 + src/DebugTools/ObjectRenderer.h | 4 ++++ src/DebugTools/ShapeRenderer.h | 7 ++++++- src/Primitives/Capsule.h | 2 +- src/Primitives/Cube.h | 4 ++-- src/Primitives/Cylinder.h | 6 +++--- src/Primitives/Icosphere.h | 4 ++-- src/Primitives/Plane.h | 2 +- src/Primitives/UVSphere.h | 3 ++- 9 files changed, 22 insertions(+), 11 deletions(-) diff --git a/src/DebugTools/Implementation/BoxRenderer.cpp b/src/DebugTools/Implementation/BoxRenderer.cpp index 57d7bf51c..291019d2d 100644 --- a/src/DebugTools/Implementation/BoxRenderer.cpp +++ b/src/DebugTools/Implementation/BoxRenderer.cpp @@ -25,6 +25,7 @@ namespace Magnum { namespace DebugTools { namespace Implementation { template BoxRenderer::BoxRenderer(Physics::Box& box): box(box) {} template void BoxRenderer::draw(Resource& options, const typename DimensionTraits::MatrixType& projectionMatrix) { + /* Half scale, because the box is 2x2(x2) */ this->shader->setTransformationProjectionMatrix(projectionMatrix*box.transformedTransformation()* DimensionTraits::MatrixType::scaling(typename DimensionTraits::VectorType(0.5f))) ->setColor(options->color()) diff --git a/src/DebugTools/ObjectRenderer.h b/src/DebugTools/ObjectRenderer.h index 4dadf32af..8aab17f1d 100644 --- a/src/DebugTools/ObjectRenderer.h +++ b/src/DebugTools/ObjectRenderer.h @@ -15,6 +15,10 @@ GNU Lesser General Public License version 3 for more details. */ +/** @file + * @brief Class Magnum::DebugTools::ObjectRenderer, Magnum::DebugTools::ObjectRendererOptions, typedef Magnum::DebugTools::ObjectRenderer2D, Magnum::DebugTools::ObjectRenderer3D + */ + #include "Resource.h" #include "SceneGraph/Drawable.h" #include "Shaders/Shaders.h" diff --git a/src/DebugTools/ShapeRenderer.h b/src/DebugTools/ShapeRenderer.h index 5223dbafc..b863d32fd 100644 --- a/src/DebugTools/ShapeRenderer.h +++ b/src/DebugTools/ShapeRenderer.h @@ -15,6 +15,10 @@ GNU Lesser General Public License version 3 for more details. */ +/** @file + * @brief Class Magnum::DebugTools::ShapeRenderer, Magnum::DebugTools::ShapeRendererOptions, typedef Magnum::DebugTools::ShapeRenderer2D, Magnum::DebugTools::ShapeRenderer3D + */ + #include "Color.h" #include "Resource.h" #include "SceneGraph/Drawable.h" @@ -65,7 +69,8 @@ class ShapeRendererOptions { /** @brief Shape renderer -Visualizes collision shape. See @ref debug-tools-renderers for more information. +Visualizes collision shapes using wireframe primitives. See +@ref debug-tools-renderers for more information. @section ShapeRenderer-usage Basic usage diff --git a/src/Primitives/Capsule.h b/src/Primitives/Capsule.h index 94650a039..dc00e9272 100644 --- a/src/Primitives/Capsule.h +++ b/src/Primitives/Capsule.h @@ -26,7 +26,7 @@ namespace Magnum { namespace Primitives { /** @brief 3D capsule primitive -%Cylinder along Y axis with hemispheres instead of caps. Indexed triangle mesh +%Cylinder along Y axis with hemispheres instead of caps. Indexed @ref Mesh::Primitive "Triangles" with normals and optional 2D texture coordinates. */ class Capsule: public Trade::MeshData3D { diff --git a/src/Primitives/Cube.h b/src/Primitives/Cube.h index 734471e52..c46899fb7 100644 --- a/src/Primitives/Cube.h +++ b/src/Primitives/Cube.h @@ -33,14 +33,14 @@ class Cube { /** * @brief Solid cube * - * Indexed triangle mesh with flat normals. + * Indexed @ref Mesh::Primitive "Triangles" with flat normals. */ static Trade::MeshData3D solid(); /** * @brief Wireframe cube * - * Indexed line mesh. + * Indexed @ref Mesh::Primitive "Lines". */ static Trade::MeshData3D wireframe(); diff --git a/src/Primitives/Cylinder.h b/src/Primitives/Cylinder.h index 542d3c8c5..b1063de92 100644 --- a/src/Primitives/Cylinder.h +++ b/src/Primitives/Cylinder.h @@ -16,7 +16,7 @@ */ /** @file - * @brief Class Magnum::Primitives::UVSphere + * @brief Class Magnum::Primitives::Cylinder */ #include @@ -28,8 +28,8 @@ namespace Magnum { namespace Primitives { /** @brief 3D cylinder primitive -Indexed triangle mesh with normals, optional 2D texture coordinates and -optional capped ends. +Indexed @ref Mesh::Primitive "Triangles" with normals, optional 2D texture +coordinates and optional capped ends. */ class Cylinder: public Capsule { public: diff --git a/src/Primitives/Icosphere.h b/src/Primitives/Icosphere.h index e5aa7ea42..08760c1f2 100644 --- a/src/Primitives/Icosphere.h +++ b/src/Primitives/Icosphere.h @@ -34,7 +34,7 @@ template class Icosphere; /** @brief 3D icosphere primitive with zero subdivisions -Indexed triangle mesh with normals. +Indexed @ref Mesh::Primitive "Triangles" with normals. */ template<> class Icosphere<0>: public Trade::MeshData3D { public: @@ -46,7 +46,7 @@ template<> class Icosphere<0>: public Trade::MeshData3D { @brief 3D icosphere primitive @tparam subdivisions Number of subdivisions -Indexed triangle mesh with normals. +Indexed @ref Mesh::Primitive "Triangles" with normals. */ #ifndef DOXYGEN_GENERATING_OUTPUT template class Icosphere: public Icosphere<0> { diff --git a/src/Primitives/Plane.h b/src/Primitives/Plane.h index b19ef792a..59f22bdf5 100644 --- a/src/Primitives/Plane.h +++ b/src/Primitives/Plane.h @@ -26,7 +26,7 @@ namespace Magnum { namespace Primitives { /** @brief 3D plane primitive -2x2 plane as triangle strip, non-indexed with normals in positive Z direction. +2x2 plane. */ class Plane { public: diff --git a/src/Primitives/UVSphere.h b/src/Primitives/UVSphere.h index 5a55cda1d..d2e77c4d6 100644 --- a/src/Primitives/UVSphere.h +++ b/src/Primitives/UVSphere.h @@ -26,7 +26,8 @@ namespace Magnum { namespace Primitives { /** @brief 3D UV sphere primitive -Indexed triangle mesh with normals and optional 2D texture coordinates. +Indexed @ref Mesh::Primitive "Triangles" with normals and optional 2D texture +coordinates. */ class UVSphere: public Capsule { public: