Browse Source

Shapes: removed autolink-preventing % noise.

pull/77/head
Vladimír Vondruš 12 years ago
parent
commit
b19743157a
  1. 8
      src/Magnum/Shapes/AbstractShape.h
  2. 2
      src/Magnum/Shapes/AxisAlignedBox.h
  3. 6
      src/Magnum/Shapes/Capsule.h
  4. 4
      src/Magnum/Shapes/Collision.h
  5. 12
      src/Magnum/Shapes/Composition.h
  6. 4
      src/Magnum/Shapes/Cylinder.h
  7. 2
      src/Magnum/Shapes/LineSegment.h
  8. 4
      src/Magnum/Shapes/Plane.h
  9. 2
      src/Magnum/Shapes/Point.h
  10. 4
      src/Magnum/Shapes/Shape.h
  11. 22
      src/Magnum/Shapes/Sphere.h

8
src/Magnum/Shapes/AbstractShape.h

@ -58,7 +58,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHAPES_EXPORT AbstractShape: publi
Dimensions = dimensions /**< Dimension count */
};
/** @brief %Shape type */
/** @brief Shape type */
#ifdef DOXYGEN_GENERATING_OUTPUT
enum class Type {
Point, /**< Point */
@ -83,14 +83,14 @@ template<UnsignedInt dimensions> class MAGNUM_SHAPES_EXPORT AbstractShape: publi
explicit AbstractShape(SceneGraph::AbstractObject<dimensions, Float>& object, ShapeGroup<dimensions>* group = nullptr);
/**
* @brief %Shape group containing this shape
* @brief Shape group containing this shape
*
* If the shape doesn't belong to any group, returns `nullptr`.
*/
ShapeGroup<dimensions>* group();
const ShapeGroup<dimensions>* group() const; /**< @overload */
/** @brief %Shape type */
/** @brief Shape type */
Type type() const;
/**
@ -101,7 +101,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHAPES_EXPORT AbstractShape: publi
bool collides(const AbstractShape<dimensions>& other) const;
/**
* @brief %Collision with other shape
* @brief Collision with other shape
*
* Default implementation returns empty collision.
*/

2
src/Magnum/Shapes/AxisAlignedBox.h

@ -82,7 +82,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHAPES_EXPORT AxisAlignedBox {
_max = max;
}
/** @brief %Collision occurence with point */
/** @brief Collision occurence with point */
bool operator%(const Point<dimensions>& other) const;
private:

6
src/Magnum/Shapes/Capsule.h

@ -37,7 +37,7 @@
namespace Magnum { namespace Shapes {
/**
@brief %Capsule defined by cylinder start and end point and radius
@brief Capsule defined by cylinder start and end point and radius
Unlike other elements the capsule expects uniform scaling. See @ref shapes for
brief introduction.
@ -90,10 +90,10 @@ template<UnsignedInt dimensions> class MAGNUM_SHAPES_EXPORT Capsule {
/** @brief Set radius */
void setRadius(Float radius) { _radius = radius; }
/** @brief %Collision occurence with point */
/** @brief Collision occurence with point */
bool operator%(const Point<dimensions>& other) const;
/** @brief %Collision occurence with sphere */
/** @brief Collision occurence with sphere */
bool operator%(const Sphere<dimensions>& other) const;
private:

4
src/Magnum/Shapes/Collision.h

@ -36,7 +36,7 @@
namespace Magnum { namespace Shapes {
/**
@brief %Collision data
@brief Collision data
Contains information about collision between objects A and B, described by
contact position, separation normal and separation distance.
@ -80,7 +80,7 @@ template<UnsignedInt dimensions> class Collision {
*/
operator bool() const { return _separationDistance > 0.0f; }
/** @brief %Collision position */
/** @brief Collision position */
VectorTypeFor<dimensions, Float> position() const {
return _position;
}

12
src/Magnum/Shapes/Composition.h

@ -52,7 +52,7 @@ namespace Implementation {
}
}
/** @brief %Shape operation */
/** @brief Shape operation */
enum class CompositionOperation: UnsignedByte {
Not, /**< Boolean NOT */
And, /**< Boolean AND */
@ -60,7 +60,7 @@ enum class CompositionOperation: UnsignedByte {
};
/**
@brief %Composition of shapes
@brief Composition of shapes
Result of logical operations on shapes. See @ref shapes for brief introduction.
*/
@ -74,7 +74,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHAPES_EXPORT Composition {
Dimensions = dimensions /**< Dimension count */
};
/** @brief %Shape type */
/** @brief Shape type */
#ifdef DOXYGEN_GENERATING_OUTPUT
enum class Type {
Point, /**< Point */
@ -137,10 +137,10 @@ template<UnsignedInt dimensions> class MAGNUM_SHAPES_EXPORT Composition {
/** @brief Type of shape at given position */
Type type(std::size_t i) const { return _shapes[i]->type(); }
/** @brief %Shape at given position */
/** @brief Shape at given position */
template<class T> const T& get(std::size_t i) const;
/** @brief %Collision with another shape */
/** @brief Collision with another shape */
#ifdef DOXYGEN_GENERATING_OUTPUT
template<class T> bool operator%(const T& other) const {
#else
@ -199,7 +199,7 @@ template<UnsignedInt dimensions> Debug operator<<(Debug debug, typename Composit
#endif
/** @relates Composition
@brief %Collision occurence of shape with %Composition
@brief Collision occurence of shape with Composition
*/
#ifdef DOXYGEN_GENERATING_OUTPUT
template<UnsignedInt dimensions, class T> inline bool operator%(const T& a, const Composition<dimensions>& b) {

4
src/Magnum/Shapes/Cylinder.h

@ -90,10 +90,10 @@ template<UnsignedInt dimensions> class MAGNUM_SHAPES_EXPORT Cylinder {
/** @brief Set radius */
void setRadius(Float radius) { _radius = radius; }
/** @brief %Collision occurence with point */
/** @brief Collision occurence with point */
bool operator%(const Point<dimensions>& other) const;
/** @brief %Collision occurence with sphere */
/** @brief Collision occurence with sphere */
bool operator%(const Sphere<dimensions>& other) const;
private:

2
src/Magnum/Shapes/LineSegment.h

@ -34,7 +34,7 @@
namespace Magnum { namespace Shapes {
/**
@brief %Line segment, defined by starting and ending point
@brief Line segment, defined by starting and ending point
See @ref shapes for brief introduction.
@see @ref LineSegment2D, @ref LineSegment3D

4
src/Magnum/Shapes/Plane.h

@ -77,10 +77,10 @@ class MAGNUM_SHAPES_EXPORT Plane {
_normal = normal;
}
/** @brief %Collision occurence with line */
/** @brief Collision occurence with line */
bool operator%(const Line3D& other) const;
/** @brief %Collision occurence with line segment */
/** @brief Collision occurence with line segment */
bool operator%(const LineSegment3D& other) const;
private:

2
src/Magnum/Shapes/Point.h

@ -36,7 +36,7 @@
namespace Magnum { namespace Shapes {
/**
@brief %Point
@brief Point
See @ref shapes for brief introduction.
@see @ref Point2D, @ref Point3D

4
src/Magnum/Shapes/Shape.h

@ -42,7 +42,7 @@ namespace Implementation {
/**
@brief Object shape
Adds shape for collision detection to object. Each %Shape is part of
Adds shape for collision detection to object. Each Shape is part of
some @ref ShapeGroup, which essentially maintains a set of objects which can
collide with each other. See @ref shapes for brief introduction.
@ -73,7 +73,7 @@ template<class T> class Shape: public AbstractShape<T::Dimensions> {
/**
* @brief Constructor
* @param object Object holding this feature
* @param shape %Shape
* @param shape Shape
* @param group Group this shape belongs to
*/
explicit Shape(SceneGraph::AbstractObject<T::Dimensions, Float>& object, const T& shape, ShapeGroup<T::Dimensions>* group = nullptr): AbstractShape<T::Dimensions>(object, group) {

22
src/Magnum/Shapes/Sphere.h

@ -38,7 +38,7 @@
namespace Magnum { namespace Shapes {
/**
@brief %Sphere defined by position and radius
@brief Sphere defined by position and radius
Unlike other elements the sphere expects uniform scaling. See @ref shapes for
brief introduction.
@ -81,22 +81,22 @@ template<UnsignedInt dimensions> class MAGNUM_SHAPES_EXPORT Sphere {
/** @brief Set radius */
void setRadius(Float radius) { _radius = radius; }
/** @brief %Collision occurence with point */
/** @brief Collision occurence with point */
bool operator%(const Point<dimensions>& other) const;
/** @brief %Collision with point */
/** @brief Collision with point */
Collision<dimensions> operator/(const Point<dimensions>& other) const;
/** @brief %Collision occurence with line */
/** @brief Collision occurence with line */
bool operator%(const Line<dimensions>& other) const;
/** @brief %Collision occurence with line segment */
/** @brief Collision occurence with line segment */
bool operator%(const LineSegment<dimensions>& other) const;
/** @brief %Collision occurence with sphere */
/** @brief Collision occurence with sphere */
bool operator%(const Sphere<dimensions>& other) const;
/** @brief %Collision with sphere */
/** @brief Collision with sphere */
Collision<dimensions> operator/(const Sphere<dimensions>& other) const;
private:
@ -147,16 +147,16 @@ template<UnsignedInt dimensions> class MAGNUM_SHAPES_EXPORT InvertedSphere:
using Sphere<dimensions>::radius;
using Sphere<dimensions>::setRadius;
/** @brief %Collision occurence with point */
/** @brief Collision occurence with point */
bool operator%(const Point<dimensions>& other) const;
/** @brief %Collision with point */
/** @brief Collision with point */
Collision<dimensions> operator/(const Point<dimensions>& other) const;
/** @brief %Collision occurence with sphere */
/** @brief Collision occurence with sphere */
bool operator%(const Sphere<dimensions>& other) const;
/** @brief %Collision with sphere */
/** @brief Collision with sphere */
Collision<dimensions> operator/(const Sphere<dimensions>& other) const;
private:

Loading…
Cancel
Save