From 8935d8c721135a8fb8336d86b4650e5bbe53c9f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Wed, 4 Sep 2013 12:35:32 +0200 Subject: [PATCH] Shapes: preparation for non-boolean collision queries. --- Doxyfile | 2 +- doc/coding-style.dox | 6 +++--- src/Shapes/AxisAlignedBox.h | 4 ++-- src/Shapes/Capsule.h | 8 ++++---- src/Shapes/Cylinder.h | 8 ++++---- src/Shapes/Plane.h | 8 ++++---- src/Shapes/Sphere.h | 14 +++++++------- 7 files changed, 25 insertions(+), 25 deletions(-) diff --git a/Doxyfile b/Doxyfile index 9bb7567bd..18a8b85e8 100644 --- a/Doxyfile +++ b/Doxyfile @@ -203,7 +203,7 @@ ALIASES = \ "debugoperator{1}=@relates \1\n@brief Debug output operator @xrefitem debugoperators \"Debug output operator\" \"Debug output operators for custom types\" Allows printing \1 with Corrade::Utility::Debug and friends." \ "configurationvalueref{1}=@see @ref configurationvalues \"Corrade::Utility::ConfigurationValue<\1>\"" \ "configurationvalue{1}=@brief %Configuration value parser and writer @xrefitem configurationvalues \"Configuration value parser and writer\" \"Configuration value parsers and writers for custom types\" Allows parsing and writing \1 from and to Corrade::Utility::Configuration." \ - "collisionoperator{2}=@relates \1\n@brief Collision of %\1 and %\2\n@see \2::operator%(const \1&) const" \ + "collisionoccurenceoperator{2}=@relates \1\n@brief %Collision occurence of %\1 and %\2\n@see \2::operator%(const \1&) const" \ "todoc=@xrefitem todoc \"Documentation todo\" \"Documentation-related todo list\"" \ "fn_gl{1}=gl\1()" \ "fn_gl_extension{3}=gl\1\2()" \ diff --git a/doc/coding-style.dox b/doc/coding-style.dox index 8c686005d..d520b14cf 100644 --- a/doc/coding-style.dox +++ b/doc/coding-style.dox @@ -102,10 +102,10 @@ Additionally to @c \@todoc, @c \@debugoperator @c \@configurationvalue and @subsubsection documentation-commands-collisionoperator Shape collision operators -Out-of-class operators for collision in Shapes namespace should be marked with -@c \@collisionoperator, e.g.: +Out-of-class operators for collision occurence in Shapes namespace should be +marked with @c \@collisionoccurenceoperator, e.g.: @code -// @collisionoperator{Point,Sphere} +// @collisionoccurenceoperator{Point,Sphere} inline bool operator%(const Point& a, const Sphere& b) { return b % a; } @endcode They will appear as related functions within documentation of class for which diff --git a/src/Shapes/AxisAlignedBox.h b/src/Shapes/AxisAlignedBox.h index 750689828..50aa7210f 100644 --- a/src/Shapes/AxisAlignedBox.h +++ b/src/Shapes/AxisAlignedBox.h @@ -81,7 +81,7 @@ template class MAGNUM_SHAPES_EXPORT AxisAlignedBox { _max = max; } - /** @brief Collision with point */ + /** @brief %Collision occurence with point */ bool operator%(const Point& other) const; private: @@ -94,7 +94,7 @@ typedef AxisAlignedBox<2> AxisAlignedBox2D; /** @brief Three-dimensional axis-aligned box */ typedef AxisAlignedBox<3> AxisAlignedBox3D; -/** @collisionoperator{Point,AxisAlignedBox} */ +/** @collisionoccurenceoperator{Point,AxisAlignedBox} */ template inline bool operator%(const Point& a, const AxisAlignedBox& b) { return b % a; } }} diff --git a/src/Shapes/Capsule.h b/src/Shapes/Capsule.h index c0f0d4bbc..d73f506d1 100644 --- a/src/Shapes/Capsule.h +++ b/src/Shapes/Capsule.h @@ -89,10 +89,10 @@ template class MAGNUM_SHAPES_EXPORT Capsule { /** @brief Set radius */ void setRadius(Float radius) { _radius = radius; } - /** @brief Collision with point */ + /** @brief %Collision occurence with point */ bool operator%(const Point& other) const; - /** @brief Collision with sphere */ + /** @brief %Collision occurence with sphere */ bool operator%(const Sphere& other) const; private: @@ -106,10 +106,10 @@ typedef Capsule<2> Capsule2D; /** @brief Three-dimensional capsule */ typedef Capsule<3> Capsule3D; -/** @collisionoperator{Point,Capsule} */ +/** @collisionoccurenceoperator{Point,Capsule} */ template inline bool operator%(const Point& a, const Capsule& b) { return b % a; } -/** @collisionoperator{Sphere,Capsule} */ +/** @collisionoccurenceoperator{Sphere,Capsule} */ template inline bool operator%(const Sphere& a, const Capsule& b) { return b % a; } }} diff --git a/src/Shapes/Cylinder.h b/src/Shapes/Cylinder.h index e9a04d33b..22ff553a1 100644 --- a/src/Shapes/Cylinder.h +++ b/src/Shapes/Cylinder.h @@ -89,10 +89,10 @@ template class MAGNUM_SHAPES_EXPORT Cylinder { /** @brief Set radius */ void setRadius(Float radius) { _radius = radius; } - /** @brief Collision with point */ + /** @brief %Collision occurence with point */ bool operator%(const Point& other) const; - /** @brief Collision with sphere */ + /** @brief %Collision occurence with sphere */ bool operator%(const Sphere& other) const; private: @@ -106,10 +106,10 @@ typedef Cylinder<2> Cylinder2D; /** @brief Infinite three-dimensional cylinder */ typedef Cylinder<3> Cylinder3D; -/** @collisionoperator{Point,Cylinder} */ +/** @collisionoccurenceoperator{Point,Cylinder} */ template inline bool operator%(const Point& a, const Cylinder& b) { return b % a; } -/** @collisionoperator{Sphere,Cylinder} */ +/** @collisionoccurenceoperator{Sphere,Cylinder} */ template inline bool operator%(const Sphere& a, const Cylinder& b) { return b % a; } }} diff --git a/src/Shapes/Plane.h b/src/Shapes/Plane.h index 81f1608e5..c3a4d6a7c 100644 --- a/src/Shapes/Plane.h +++ b/src/Shapes/Plane.h @@ -76,20 +76,20 @@ class MAGNUM_SHAPES_EXPORT Plane { _normal = normal; } - /** @brief Collision with line */ + /** @brief %Collision occurence with line */ bool operator%(const Line3D& other) const; - /** @brief Collision with line segment */ + /** @brief %Collision occurence with line segment */ bool operator%(const LineSegment3D& other) const; private: Vector3 _position, _normal; }; -/** @collisionoperator{Line,Plane} */ +/** @collisionoccurenceoperator{Line,Plane} */ inline bool operator%(const Line3D& a, const Plane& b) { return b % a; } -/** @collisionoperator{LineSegment,Plane} */ +/** @collisionoccurenceoperator{LineSegment,Plane} */ inline bool operator%(const LineSegment3D& a, const Plane& b) { return b % a; } diff --git a/src/Shapes/Sphere.h b/src/Shapes/Sphere.h index 17d27bdd0..e402f9c9e 100644 --- a/src/Shapes/Sphere.h +++ b/src/Shapes/Sphere.h @@ -79,16 +79,16 @@ template class MAGNUM_SHAPES_EXPORT Sphere { /** @brief Set radius */ void setRadius(Float radius) { _radius = radius; } - /** @brief Collision with point */ + /** @brief %Collision occurence with point */ bool operator%(const Point& other) const; - /** @brief Collision with line */ + /** @brief %Collision occurence with line */ bool operator%(const Line& other) const; - /** @brief Collision with line segment */ + /** @brief %Collision occurence with line segment */ bool operator%(const LineSegment& other) const; - /** @brief Collision with sphere */ + /** @brief %Collision occurence with sphere */ bool operator%(const Sphere& other) const; private: @@ -102,13 +102,13 @@ typedef Sphere<2> Sphere2D; /** @brief Three-dimensional sphere */ typedef Sphere<3> Sphere3D; -/** @collisionoperator{Point,Sphere} */ +/** @collisionoccurenceoperator{Point,Sphere} */ template inline bool operator%(const Point& a, const Sphere& b) { return b % a; } -/** @collisionoperator{Line,Sphere} */ +/** @collisionoccurenceoperator{Line,Sphere} */ template inline bool operator%(const Line& a, const Sphere& b) { return b % a; } -/** @collisionoperator{LineSegment,Sphere} */ +/** @collisionoccurenceoperator{LineSegment,Sphere} */ template inline bool operator%(const LineSegment& a, const Sphere& b) { return b % a; } }}