From 4a79d24e9e24ae254076dcb50f622921d455dd4b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Thu, 26 Sep 2013 16:49:35 +0200 Subject: [PATCH] Shapes: mention inverted shapes in the introductory docs. --- doc/shapes.dox | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/shapes.dox b/doc/shapes.dox index 1e5772d56..f89f9c46d 100644 --- a/doc/shapes.dox +++ b/doc/shapes.dox @@ -35,6 +35,12 @@ together using various operations. @section shapes-collection Available shapes +%Magnum provides a set of simple shapes for collision detection, similarly to +what is found in many other collision detection libraries. Additionally some +shapes are provided in inverted form -- e.g. inverted box detects collisions on +outside instead of inside, which might be useful for example to create bounds +around platformer game level. + @subsection shapes-1D One-dimensional shapes - @ref Shapes::Point "Shapes::Point*D" -- @copybrief Shapes::Point @@ -51,6 +57,7 @@ line and point. Collision of two lines can be detected only in 2D. @subsection shapes-3D Three-dimensional shapes - @ref Shapes::Sphere "Shapes::Sphere*D" -- @copybrief Shapes::Sphere +- @ref Shapes::InvertedSphere "Shapes::InvertedSphere*D" -- @copybrief Shapes::InvertedSphere - @ref Shapes::Cylinder "Shapes::Cylinder*D" -- @copybrief Shapes::Cylinder - @ref Shapes::Capsule "Shapes::Capsule*D" -- @copybrief Shapes::Capsule - @ref Shapes::AxisAlignedBox "Shapes::AxisAlignedBox*D" -- @copybrief Shapes::AxisAlignedBox