Browse Source

Shapes: adapted to the new documentation theme.

Ugh I should throw this all away.
pull/231/head
Vladimír Vondruš 8 years ago
parent
commit
8739218cda
  1. 4
      Doxyfile
  2. 4
      Doxyfile-mcss
  3. 4
      Doxyfile-public
  4. 14
      src/Magnum/Shapes/AbstractShape.h
  5. 12
      src/Magnum/Shapes/Composition.h
  6. 12
      src/Magnum/Shapes/Plane.h
  7. 3
      src/Magnum/Shapes/Shape.h
  8. 4
      src/Magnum/Shapes/ShapeGroup.h

4
Doxyfile

@ -242,8 +242,8 @@ ALIASES = \
"debugoperatorclassenum{2}=@relatesalso \1\n@brief Debug output operator @xrefitem debugoperators \"Debug output operator\" \"Debug output operators for custom types\" Allows printing @ref \2 with @ref 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 @ref \1 from and to @ref Corrade::Utility::Configuration." \
"collisionoccurenceoperator{2}=@relatesalso \1\n@brief Collision occurence of \1 and \2\n@see \2::operator%(const \1&) const" \
"collisionoperator{2}=@relatesalso \1\n@brief Collision of \1 and \2\n@see \2::operator/(const \1&) const" \
"collisionoccurenceoperator{2}=@relatesalso \1 @brief Collision occurence of @ref \1 and @ref \2 @see @ref \2::operator%(const \1&) const" \
"collisionoperator{2}=@relatesalso \1 @brief Collision of @ref \1 and @ref \2 @see @ref \2::operator/(const \1&) const" \
"todoc=@xrefitem todoc \"Documentation todo\" \"Documentation-related todo list\"" \
"fn_gl{1}=<a href=\"https://www.khronos.org/registry/OpenGL-Refpages/gl4/html/gl\1.xhtml\">gl\1()</a>" \
"fn_gl2{2}=<a href=\"https://www.khronos.org/registry/OpenGL-Refpages/gl4/html/gl\2.xhtml\">gl\1()</a>" \

4
Doxyfile-mcss

@ -21,8 +21,8 @@ ALIASES = \
"debugoperatorclassenum{2}=@relatesalso \1\n@brief Debug output operator @xrefitem debugoperators \"Debug output operator\" \"Debug output operators for custom types\" Allows printing @ref \2 with @ref 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 @ref \1 from and to @ref Corrade::Utility::Configuration." \
"collisionoccurenceoperator{2}=@relatesalso \1\n@brief Collision occurence of \1 and \2\n@see \2::operator%(const \1&) const" \
"collisionoperator{2}=@relatesalso \1\n@brief Collision of \1 and \2\n@see \2::operator/(const \1&) const" \
"collisionoccurenceoperator{2}=@relatesalso \1 @brief Collision occurence of @ref \1 and @ref \2 @see @ref \2::operator%(const \1&) const" \
"collisionoperator{2}=@relatesalso \1 @brief Collision of @ref \1 and @ref \2 @see @ref \2::operator/(const \1&) const" \
"todoc=@xrefitem todoc \"Documentation todo\" \"Documentation-related todo list\"" \
"fn_gl{1}=@m_class{m-dox-external} <a href=\"https://www.khronos.org/registry/OpenGL-Refpages/gl4/html/gl\1.xhtml\">gl\1()</a>" \
"fn_gl2{2}=@m_class{m-dox-external} <a href=\"https://www.khronos.org/registry/OpenGL-Refpages/gl4/html/gl\2.xhtml\">gl\1()</a>" \

4
Doxyfile-public

@ -18,8 +18,8 @@ ALIASES = \
"debugoperatorclassenum{2}=@relatesalso \1\n@brief Debug output operator @xrefitem debugoperators \"Debug output operator\" \"Debug output operators for custom types\" Allows printing @ref \2 with @ref 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 @ref \1 from and to @ref Corrade::Utility::Configuration." \
"collisionoccurenceoperator{2}=@relatesalso \1\n@brief Collision occurence of \1 and \2\n@see \2::operator%(const \1&) const" \
"collisionoperator{2}=@relatesalso \1\n@brief Collision of \1 and \2\n@see \2::operator/(const \1&) const" \
"collisionoccurenceoperator{2}=@relatesalso \1 @brief Collision occurence of @ref \1 and @ref \2 @see @ref \2::operator%(const \1&) const" \
"collisionoperator{2}=@relatesalso \1 @brief Collision of @ref \1 and @ref \2 @see @ref \2::operator/(const \1&) const" \
"todoc=@todo" \
"fn_gl{1}=@m_class{m-dox-external} <a href=\"https://www.khronos.org/registry/OpenGL-Refpages/gl4/html/gl\1.xhtml\">gl\1()</a>" \
"fn_gl2{2}=@m_class{m-dox-external} <a href=\"https://www.khronos.org/registry/OpenGL-Refpages/gl4/html/gl\2.xhtml\">gl\1()</a>" \

14
src/Magnum/Shapes/AbstractShape.h

@ -66,15 +66,15 @@ template<UnsignedInt dimensions> class MAGNUM_SHAPES_EXPORT AbstractShape: publi
/** @brief Shape type */
#ifdef DOXYGEN_GENERATING_OUTPUT
enum class Type {
Point, /**< Point */
Line, /**< Line */
Point, /**< @ref Point */
Line, /**< @ref Line */
LineSegment, /**< @ref LineSegment "Line segment" */
Sphere, /**< Sphere */
Capsule, /**< Capsule */
Sphere, /**< @ref Sphere */
Capsule, /**< @ref Capsule */
AxisAlignedBox, /**< @ref AxisAlignedBox "Axis aligned box" */
Box, /**< Box */
Box, /**< @ref Box */
Composition, /**< @ref Composition "Shape group" */
Plane /**< Plane (3D only) */
Plane /**< @ref Plane (3D only) */
};
#else
typedef typename Implementation::ShapeDimensionTraits<dimensions>::Type Type;
@ -90,7 +90,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHAPES_EXPORT AbstractShape: publi
/**
* @brief Shape group containing this shape
*
* If the shape doesn't belong to any group, returns `nullptr`.
* If the shape doesn't belong to any group, returns @cpp nullptr @ce.
*/
ShapeGroup<dimensions>* group();
const ShapeGroup<dimensions>* group() const; /**< @overload */

12
src/Magnum/Shapes/Composition.h

@ -77,16 +77,16 @@ template<UnsignedInt dimensions> class MAGNUM_SHAPES_EXPORT Composition {
/** @brief Shape type */
#ifdef DOXYGEN_GENERATING_OUTPUT
enum class Type {
Point, /**< Point */
Line, /**< Line */
Point, /**< @ref Point */
Line, /**< @ref Line */
LineSegment, /**< @ref LineSegment "Line segment" */
Sphere, /**< Sphere */
Sphere, /**< @ref Sphere */
InvertedSphere, /**< @ref InvertedSphere "Inverted sphere" */
Cylinder, /**< @ref Cylinder */
Capsule, /**< Capsule */
Capsule, /**< @ref Capsule */
AxisAlignedBox, /**< @ref AxisAlignedBox "Axis aligned box" */
Box, /**< Box */
Plane /**< Plane (3D only) */
Box, /**< @ref Box */
Plane /**< @ref Plane (3D only) */
};
#else
typedef typename Implementation::ShapeDimensionTraits<dimensions>::Type Type;

12
src/Magnum/Shapes/Plane.h

@ -87,10 +87,18 @@ class MAGNUM_SHAPES_EXPORT Plane {
Vector3 _position, _normal;
};
/** @collisionoccurenceoperator{Line,Plane} */
/** @relatesalso Line
@brief Collision occurence of @ref Line and @ref Plane
@see @ref Plane::operator%(const Line3D&) const
*/
inline bool operator%(const Line3D& a, const Plane& b) { return b % a; }
/** @collisionoccurenceoperator{LineSegment,Plane} */
/** @relatesalso LineSegment
@brief Collision occurence of @ref LineSegment and @ref Plane
@see @ref Plane::operator%(const LineSegment3D&) const
*/
inline bool operator%(const LineSegment3D& a, const Plane& b) { return b % a; }

3
src/Magnum/Shapes/Shape.h

@ -54,7 +54,8 @@ shape to @ref ShapeGroup, which then provides collision detection for given
group of shapes using either @ref collides(), @ref collision() or
@ref ShapeGroup::firstCollision(). You can also use @ref ShapeGroup::add() and
@ref ShapeGroup::remove() later to manage e.g. collision islands.
@code
@code{.cpp}
Shapes::ShapeGroup3D shapes;
Object3D object;

4
src/Magnum/Shapes/ShapeGroup.h

@ -82,8 +82,8 @@ template<UnsignedInt dimensions> class MAGNUM_SHAPES_EXPORT ShapeGroup: public S
* @brief First collision of given shape with other shapes in the group
*
* Returns first shape colliding with given one. If there aren't any
* collisions, returns `nullptr`. Calls @ref setClean() before the
* operation.
* collisions, returns @cpp nullptr @ce. Calls @ref setClean() before
* the operation.
*/
AbstractShape<dimensions>* firstCollision(const AbstractShape<dimensions>& shape);

Loading…
Cancel
Save