Browse Source

SceneGraph: removed autolink-preventing % noise, removed unneeded HTML.

pull/77/head
Vladimír Vondruš 12 years ago
parent
commit
5433271506
  1. 6
      src/Magnum/SceneGraph/AbstractCamera.h
  2. 8
      src/Magnum/SceneGraph/AbstractFeature.h
  3. 10
      src/Magnum/SceneGraph/AbstractGroupedFeature.h
  4. 8
      src/Magnum/SceneGraph/AbstractObject.h
  5. 4
      src/Magnum/SceneGraph/AbstractTransformation.h
  6. 4
      src/Magnum/SceneGraph/AbstractTranslation.h
  7. 6
      src/Magnum/SceneGraph/AbstractTranslationRotation3D.h
  8. 18
      src/Magnum/SceneGraph/Animable.h
  9. 12
      src/Magnum/SceneGraph/AnimableGroup.h
  10. 2
      src/Magnum/SceneGraph/Camera2D.h
  11. 2
      src/Magnum/SceneGraph/Camera3D.h
  12. 24
      src/Magnum/SceneGraph/Drawable.h
  13. 2
      src/Magnum/SceneGraph/DualComplexTransformation.h
  14. 2
      src/Magnum/SceneGraph/DualQuaternionTransformation.h
  15. 8
      src/Magnum/SceneGraph/FeatureGroup.h
  16. 2
      src/Magnum/SceneGraph/MatrixTransformation2D.h
  17. 2
      src/Magnum/SceneGraph/MatrixTransformation3D.h
  18. 2
      src/Magnum/SceneGraph/Object.h
  19. 2
      src/Magnum/SceneGraph/RigidMatrixTransformation2D.h
  20. 2
      src/Magnum/SceneGraph/RigidMatrixTransformation3D.h
  21. 2
      src/Magnum/SceneGraph/Scene.h
  22. 6
      src/Magnum/SceneGraph/TranslationTransformation.h

6
src/Magnum/SceneGraph/AbstractCamera.h

@ -137,7 +137,7 @@ template<UnsignedInt dimensions, class T> class AbstractCamera: public AbstractF
protected: protected:
/** /**
* @brief Constructor * @brief Constructor
* @param object %Object holding the camera * @param object Object holding the camera
*/ */
explicit AbstractCamera(AbstractObject<dimensions, T>& object); explicit AbstractCamera(AbstractObject<dimensions, T>& object);
@ -167,7 +167,7 @@ template<UnsignedInt dimensions, class T> class AbstractCamera: public AbstractF
/** /**
@brief Base camera for two-dimensional scenes @brief Base camera for two-dimensional scenes
Convenience alternative to <tt>%AbstractCamera<2, T></tt>. See Convenience alternative to `AbstractCamera<2, T>`. See
@ref AbstractCamera for more information. @ref AbstractCamera for more information.
@see @ref AbstractCamera2D, @ref AbstractBasicCamera3D @see @ref AbstractCamera2D, @ref AbstractBasicCamera3D
*/ */
@ -183,7 +183,7 @@ typedef AbstractBasicCamera2D<Float> AbstractCamera2D;
/** /**
@brief Base camera for three-dimensional scenes @brief Base camera for three-dimensional scenes
Convenience alternative to <tt>%AbstractCamera<3, T></tt>. See Convenience alternative to `AbstractCamera<3, T>`. See
@ref AbstractCamera for more information. @ref AbstractCamera for more information.
@see @ref AbstractCamera3D, @ref AbstractBasicCamera2D @see @ref AbstractCamera3D, @ref AbstractBasicCamera2D
*/ */

8
src/Magnum/SceneGraph/AbstractFeature.h

@ -176,7 +176,7 @@ template<UnsignedInt dimensions, class T> class AbstractFeature
public: public:
/** /**
* @brief Constructor * @brief Constructor
* @param object %Object holding this feature * @param object Object holding this feature
*/ */
explicit AbstractFeature(AbstractObject<dimensions, T>& object); explicit AbstractFeature(AbstractObject<dimensions, T>& object);
@ -189,7 +189,7 @@ template<UnsignedInt dimensions, class T> class AbstractFeature
virtual ~AbstractFeature() = 0; virtual ~AbstractFeature() = 0;
/** @brief %Object holding this feature */ /** @brief Object holding this feature */
AbstractObject<dimensions, T>& object() { AbstractObject<dimensions, T>& object() {
return *Containers::LinkedListItem<AbstractFeature<dimensions, T>, AbstractObject<dimensions, T>>::list(); return *Containers::LinkedListItem<AbstractFeature<dimensions, T>, AbstractObject<dimensions, T>>::list();
} }
@ -295,7 +295,7 @@ template<UnsignedInt dimensions, class T> class AbstractFeature
/** /**
@brief Base feature for two-dimensional scenes @brief Base feature for two-dimensional scenes
Convenience alternative to <tt>%AbstractFeature<2, T></tt>. See Convenience alternative to `AbstractFeature<2, T>`. See
@ref AbstractFeature for more information. @ref AbstractFeature for more information.
@see @ref AbstractFeature2D, @ref AbstractBasicFeature3D @see @ref AbstractFeature2D, @ref AbstractBasicFeature3D
*/ */
@ -311,7 +311,7 @@ typedef AbstractBasicFeature2D<Float> AbstractFeature2D;
/** /**
@brief Base feature for three-dimensional scenes @brief Base feature for three-dimensional scenes
Convenience alternative to <tt>%AbstractFeature<3, T></tt>. See Convenience alternative to `AbstractFeature<3, T>`. See
@ref AbstractFeature for more information. @ref AbstractFeature for more information.
@see @ref AbstractFeature3D, @ref AbstractBasicFeature2D @see @ref AbstractFeature3D, @ref AbstractBasicFeature2D
*/ */

10
src/Magnum/SceneGraph/AbstractGroupedFeature.h

@ -73,7 +73,7 @@ template<UnsignedInt dimensions, class Derived, class T> class AbstractGroupedFe
public: public:
/** /**
* @brief Constructor * @brief Constructor
* @param object %Object this feature belongs to * @param object Object this feature belongs to
* @param group Group this feature belongs to * @param group Group this feature belongs to
* *
* Adds the feature to the object and to group, if specified. * Adds the feature to the object and to group, if specified.
@ -110,7 +110,7 @@ template<UnsignedInt dimensions, class Derived, class T> class AbstractGroupedFe
/** /**
@brief Base grouped feature for two-dimensional scenes @brief Base grouped feature for two-dimensional scenes
Convenience alternative to <tt>%AbstractGroupedFeature<2, Derived, T></tt>. See Convenience alternative to `AbstractGroupedFeature<2, Derived, T>`. See
@ref AbstractGroupedFeature for more information. @ref AbstractGroupedFeature for more information.
@see @ref AbstractGroupedFeature2D, @ref AbstractBasicGroupedFeature3D @see @ref AbstractGroupedFeature2D, @ref AbstractBasicGroupedFeature3D
*/ */
@ -119,7 +119,7 @@ template<class Derived, class T> using AbstractBasicGroupedFeature2D = AbstractG
/** /**
@brief Base grouped feature for two-dimensional float scenes @brief Base grouped feature for two-dimensional float scenes
Convenience alternative to <tt>%AbstractBasicGroupedFeature2D<Derived, Float></tt>. Convenience alternative to `AbstractBasicGroupedFeature2D<Derived, Float>`.
See @ref AbstractGroupedFeature for more information. See @ref AbstractGroupedFeature for more information.
@see @ref AbstractGroupedFeature3D @see @ref AbstractGroupedFeature3D
*/ */
@ -128,7 +128,7 @@ template<class Derived> using AbstractGroupedFeature2D = AbstractBasicGroupedFea
/** /**
@brief Base grouped feature for three-dimensional scenes @brief Base grouped feature for three-dimensional scenes
Convenience alternative to <tt>%AbstractGroupedFeature<3, Derived, T></tt>. See Convenience alternative to `AbstractGroupedFeature<3, Derived, T>`. See
@ref AbstractGroupedFeature for more information. @ref AbstractGroupedFeature for more information.
@see @ref AbstractGroupedFeature3D, @ref AbstractBasicGroupedFeature2D @see @ref AbstractGroupedFeature3D, @ref AbstractBasicGroupedFeature2D
*/ */
@ -137,7 +137,7 @@ template<class Derived, class T> using AbstractBasicGroupedFeature3D = AbstractG
/** /**
@brief Base grouped feature for three-dimensional float scenes @brief Base grouped feature for three-dimensional float scenes
Convenience alternative to <tt>%AbstractBasicGroupedFeature3D<Derived, Float></tt>. Convenience alternative to `AbstractBasicGroupedFeature3D<Derived, Float>`.
See @ref AbstractGroupedFeature for more information. See @ref AbstractGroupedFeature for more information.
@see @ref AbstractGroupedFeature2D @see @ref AbstractGroupedFeature2D
*/ */

8
src/Magnum/SceneGraph/AbstractObject.h

@ -118,8 +118,8 @@ template<UnsignedInt dimensions, class T> class AbstractObject
} }
/** /**
* @brief %Scene * @brief Scene
* @return %Scene or `nullptr`, if the object is not part of any scene. * @return Scene or `nullptr`, if the object is not part of any scene.
*/ */
AbstractObject<dimensions, T>* scene() { return doScene(); } AbstractObject<dimensions, T>* scene() { return doScene(); }
@ -270,7 +270,7 @@ template<UnsignedInt dimensions, class T> class AbstractObject
/** /**
@brief Base object for two-dimensional scenes @brief Base object for two-dimensional scenes
Convenience alternative to <tt>%AbstractObject<2, T></tt>. See Convenience alternative to `AbstractObject<2, T>`. See
@ref AbstractObject for more information. @ref AbstractObject for more information.
@see @ref AbstractObject2D, @ref AbstractBasicObject3D @see @ref AbstractObject2D, @ref AbstractBasicObject3D
*/ */
@ -286,7 +286,7 @@ typedef AbstractBasicObject2D<Float> AbstractObject2D;
/** /**
@brief Base object for three-dimensional scenes @brief Base object for three-dimensional scenes
Convenience alternative to <tt>%AbstractObject<3, T></tt>. See Convenience alternative to `AbstractObject<3, T>`. See
@ref AbstractObject for more information. @ref AbstractObject for more information.
@see @ref AbstractObject3D, @ref AbstractBasicObject2D @see @ref AbstractObject3D, @ref AbstractBasicObject2D
*/ */

4
src/Magnum/SceneGraph/AbstractTransformation.h

@ -101,7 +101,7 @@ enum class TransformationType: UnsignedByte {
/** /**
@brief Base transformation for two-dimensional scenes @brief Base transformation for two-dimensional scenes
Convenience alternative to <tt>%AbstractTransformation<2, T></tt>. See Convenience alternative to `AbstractTransformation<2, T>`. See
@ref AbstractTransformation for more information. @ref AbstractTransformation for more information.
@see @ref AbstractTransformation2D, @ref AbstractBasicTransformation3D @see @ref AbstractTransformation2D, @ref AbstractBasicTransformation3D
*/ */
@ -117,7 +117,7 @@ typedef AbstractBasicTransformation2D<Float> AbstractTransformation2D;
/** /**
@brief Base transformation for three-dimensional scenes @brief Base transformation for three-dimensional scenes
Convenience alternative to <tt>%AbstractTransformation<3, T></tt>. See Convenience alternative to `AbstractTransformation<3, T>`. See
@ref AbstractTransformation for more information. @ref AbstractTransformation for more information.
@see @ref AbstractTransformation3D, @ref AbstractBasicTransformation2D @see @ref AbstractTransformation3D, @ref AbstractBasicTransformation2D
*/ */

4
src/Magnum/SceneGraph/AbstractTranslation.h

@ -85,7 +85,7 @@ class AbstractTranslation: public AbstractTransformation<dimensions, T> {
/** /**
@brief Base transformation for two-dimensional scenes supporting translation @brief Base transformation for two-dimensional scenes supporting translation
Convenience alternative to <tt>%AbstractTranslation<2, T, TranslationType></tt>. Convenience alternative to `AbstractTranslation<2, T, TranslationType>`.
See @ref AbstractTranslation for more information. See @ref AbstractTranslation for more information.
@see @ref AbstractTranslation2D, @ref AbstractBasicTranslation3D @see @ref AbstractTranslation2D, @ref AbstractBasicTranslation3D
*/ */
@ -106,7 +106,7 @@ typedef AbstractBasicTranslation2D<Float> AbstractTranslation2D;
/** /**
@brief Base transformation for three-dimensional scenes supporting translation @brief Base transformation for three-dimensional scenes supporting translation
Convenience alternative to <tt>%AbstractTranslation<3, T, TranslationType></tt>. Convenience alternative to `AbstractTranslation<3, T, TranslationType>`.
See @ref AbstractTranslation for more information. See @ref AbstractTranslation for more information.
@see @ref AbstractTranslation3D, @ref AbstractBasicTranslation2D @see @ref AbstractTranslation3D, @ref AbstractBasicTranslation2D
*/ */

6
src/Magnum/SceneGraph/AbstractTranslationRotation3D.h

@ -68,7 +68,7 @@ template<class T> class AbstractBasicTranslationRotation3D: public AbstractBasic
* @return Reference to self (for method chaining) * @return Reference to self (for method chaining)
* *
* In some implementations faster than calling * In some implementations faster than calling
* `rotate(angle, %Vector3::xAxis())`, see subclasses for more * `rotate(angle, Vector3::xAxis())`, see subclasses for more
* information. * information.
*/ */
AbstractBasicTranslationRotation3D<T>& rotateX(Math::Rad<T> angle, TransformationType type = TransformationType::Global) { AbstractBasicTranslationRotation3D<T>& rotateX(Math::Rad<T> angle, TransformationType type = TransformationType::Global) {
@ -83,7 +83,7 @@ template<class T> class AbstractBasicTranslationRotation3D: public AbstractBasic
* @return Reference to self (for method chaining) * @return Reference to self (for method chaining)
* *
* In some implementations faster than calling * In some implementations faster than calling
* `rotate(angle, %Vector3::yAxis())`, see subclasses for more * `rotate(angle, Vector3::yAxis())`, see subclasses for more
* information. * information.
*/ */
AbstractBasicTranslationRotation3D<T>& rotateY(Math::Rad<T> angle, TransformationType type = TransformationType::Global) { AbstractBasicTranslationRotation3D<T>& rotateY(Math::Rad<T> angle, TransformationType type = TransformationType::Global) {
@ -98,7 +98,7 @@ template<class T> class AbstractBasicTranslationRotation3D: public AbstractBasic
* @return Reference to self (for method chaining) * @return Reference to self (for method chaining)
* *
* In some implementations faster than calling * In some implementations faster than calling
* `rotate(angle, %Vector3::zAxis())`, see subclasses for more * `rotate(angle, Vector3::zAxis())`, see subclasses for more
* information. * information.
*/ */
AbstractBasicTranslationRotation3D<T>& rotateZ(Math::Rad<T> angle, TransformationType type = TransformationType::Global) { AbstractBasicTranslationRotation3D<T>& rotateZ(Math::Rad<T> angle, TransformationType type = TransformationType::Global) {

18
src/Magnum/SceneGraph/Animable.h

@ -60,9 +60,9 @@ enum class AnimationState: UnsignedByte {
Debug MAGNUM_SCENEGRAPH_EXPORT operator<<(Debug debug, AnimationState value); Debug MAGNUM_SCENEGRAPH_EXPORT operator<<(Debug debug, AnimationState value);
/** /**
@brief %Animable @brief Animable
Adds animation feature to object. Each %Animable is part of some Adds animation feature to object. Each Animable is part of some
@ref AnimableGroup, which takes care of running the animations. @ref AnimableGroup, which takes care of running the animations.
## Usage ## Usage
@ -147,7 +147,7 @@ template<UnsignedInt dimensions, class T> class Animable: public AbstractGrouped
public: public:
/** /**
* @brief Constructor * @brief Constructor
* @param object %Object this animable belongs to * @param object Object this animable belongs to
* @param group Group this animable belongs to * @param group Group this animable belongs to
* *
* Creates stopped non-repeating animation with infinite duration, * Creates stopped non-repeating animation with infinite duration,
@ -337,32 +337,32 @@ template<UnsignedInt dimensions, class T> class Animable: public AbstractGrouped
}; };
/** /**
@brief %Animable for two-dimensional scenes @brief Animable for two-dimensional scenes
Convenience alternative to <tt>%Animable<2, T></tt>. See @ref Animable for more Convenience alternative to `Animable<2, T>`. See @ref Animable for more
information. information.
@see @ref Animable2D, @ref BasicAnimable3D @see @ref Animable2D, @ref BasicAnimable3D
*/ */
template<class T> using BasicAnimable2D = Animable<2, T>; template<class T> using BasicAnimable2D = Animable<2, T>;
/** /**
@brief %Animable for two-dimensional float scenes @brief Animable for two-dimensional float scenes
@see @ref Animable3D @see @ref Animable3D
*/ */
typedef BasicAnimable2D<Float> Animable2D; typedef BasicAnimable2D<Float> Animable2D;
/** /**
@brief %Animable for three-dimensional scenes @brief Animable for three-dimensional scenes
Convenience alternative to <tt>%Animable<3, T></tt>. See @ref Animable for more Convenience alternative to `Animable<3, T>`. See @ref Animable for more
information. information.
@see @ref Animable3D, @ref BasicAnimable2D @see @ref Animable3D, @ref BasicAnimable2D
*/ */
template<class T> using BasicAnimable3D = Animable<3, T>; template<class T> using BasicAnimable3D = Animable<3, T>;
/** /**
@brief %Animable for three-dimensional float scenes @brief Animable for three-dimensional float scenes
@see @ref Animable2D @see @ref Animable2D
*/ */

12
src/Magnum/SceneGraph/AnimableGroup.h

@ -73,32 +73,32 @@ template<UnsignedInt dimensions, class T> class AnimableGroup: public FeatureGro
}; };
/** /**
@brief %Animable group for two-dimensional scenes @brief Animable group for two-dimensional scenes
Convenience alternative to <tt>%AnimableGroup<2, T></tt>. See Animable for Convenience alternative to `AnimableGroup<2, T>`. See Animable for
more information. more information.
@see @ref AnimableGroup2D, @ref BasicAnimableGroup3D @see @ref AnimableGroup2D, @ref BasicAnimableGroup3D
*/ */
template<class T> using BasicAnimableGroup2D = AnimableGroup<2, T>; template<class T> using BasicAnimableGroup2D = AnimableGroup<2, T>;
/** /**
@brief %Animable group for two-dimensional float scenes @brief Animable group for two-dimensional float scenes
@see @ref AnimableGroup3D @see @ref AnimableGroup3D
*/ */
typedef BasicAnimableGroup2D<Float> AnimableGroup2D; typedef BasicAnimableGroup2D<Float> AnimableGroup2D;
/** /**
@brief %Animable group for three-dimensional scenes @brief Animable group for three-dimensional scenes
Convenience alternative to <tt>%AnimableGroup<3, T></tt>. See Animable for Convenience alternative to `AnimableGroup<3, T>`. See Animable for
more information. more information.
@see @ref AnimableGroup3D, @ref BasicAnimableGroup2D @see @ref AnimableGroup3D, @ref BasicAnimableGroup2D
*/ */
template<class T> using BasicAnimableGroup3D = AnimableGroup<3, T>; template<class T> using BasicAnimableGroup3D = AnimableGroup<3, T>;
/** /**
@brief %Animable group for three-dimensional float scenes @brief Animable group for three-dimensional float scenes
@see @ref AnimableGroup2D @see @ref AnimableGroup2D
*/ */

2
src/Magnum/SceneGraph/Camera2D.h

@ -63,7 +63,7 @@ template<class T> class BasicCamera2D: public AbstractBasicCamera2D<T> {
public: public:
/** /**
* @brief Constructor * @brief Constructor
* @param object %Object holding this feature * @param object Object holding this feature
* *
* Sets orthographic projection to the default OpenGL cube (range @f$ [-1; 1] @f$ in all directions). * Sets orthographic projection to the default OpenGL cube (range @f$ [-1; 1] @f$ in all directions).
* @see @ref setProjection() * @see @ref setProjection()

2
src/Magnum/SceneGraph/Camera3D.h

@ -68,7 +68,7 @@ template<class T> class BasicCamera3D: public AbstractBasicCamera3D<T> {
public: public:
/** /**
* @brief Constructor * @brief Constructor
* @param object %Object holding this feature * @param object Object holding this feature
*/ */
explicit BasicCamera3D(AbstractBasicObject3D<T>& object); explicit BasicCamera3D(AbstractBasicObject3D<T>& object);

24
src/Magnum/SceneGraph/Drawable.h

@ -34,9 +34,9 @@
namespace Magnum { namespace SceneGraph { namespace Magnum { namespace SceneGraph {
/** /**
@brief %Drawable @brief Drawable
Adds drawing function to the object. Each %Drawable is part of some Adds drawing function to the object. Each Drawable is part of some
@ref DrawableGroup and the whole group is drawn with particular camera using @ref DrawableGroup and the whole group is drawn with particular camera using
@ref AbstractCamera::draw(). @ref AbstractCamera::draw().
@ -134,7 +134,7 @@ template<UnsignedInt dimensions, class T> class Drawable: public AbstractGrouped
public: public:
/** /**
* @brief Constructor * @brief Constructor
* @param object %Object this drawable belongs to * @param object Object this drawable belongs to
* @param drawables Group this drawable belongs to * @param drawables Group this drawable belongs to
* *
* Adds the feature to the object and also to the group, if specified. * Adds the feature to the object and also to the group, if specified.
@ -158,7 +158,7 @@ template<UnsignedInt dimensions, class T> class Drawable: public AbstractGrouped
/** /**
* @brief Draw the object using given camera * @brief Draw the object using given camera
* @param transformationMatrix %Object transformation relative * @param transformationMatrix Object transformation relative
* to camera * to camera
* @param camera Camera * @param camera Camera
* *
@ -169,32 +169,32 @@ template<UnsignedInt dimensions, class T> class Drawable: public AbstractGrouped
}; };
/** /**
@brief %Drawable for two-dimensional scenes @brief Drawable for two-dimensional scenes
Convenience alternative to <tt>%Drawable<2, T></tt>. See @ref Drawable for more Convenience alternative to `Drawable<2, T>`. See @ref Drawable for more
information. information.
@see @ref Drawable2D, @ref BasicDrawable3D @see @ref Drawable2D, @ref BasicDrawable3D
*/ */
template<class T> using BasicDrawable2D = Drawable<2, T>; template<class T> using BasicDrawable2D = Drawable<2, T>;
/** /**
@brief %Drawable for two-dimensional float scenes @brief Drawable for two-dimensional float scenes
@see @ref Drawable3D @see @ref Drawable3D
*/ */
typedef BasicDrawable2D<Float> Drawable2D; typedef BasicDrawable2D<Float> Drawable2D;
/** /**
@brief %Drawable for three-dimensional scenes @brief Drawable for three-dimensional scenes
Convenience alternative to <tt>%Drawable<3, T></tt>. See @ref Drawable for more Convenience alternative to `Drawable<3, T>`. See @ref Drawable for more
information. information.
@see @ref Drawable3D, @ref BasicDrawable3D @see @ref Drawable3D, @ref BasicDrawable3D
*/ */
template<class T> using BasicDrawable3D = Drawable<3, T>; template<class T> using BasicDrawable3D = Drawable<3, T>;
/** /**
@brief %Drawable for three-dimensional float scenes @brief Drawable for three-dimensional float scenes
@see @ref Drawable2D @see @ref Drawable2D
*/ */
@ -212,7 +212,7 @@ template<UnsignedInt dimensions, class T> using DrawableGroup = FeatureGroup<dim
/** /**
@brief Group of drawables for two-dimensional scenes @brief Group of drawables for two-dimensional scenes
Convenience alternative to <tt>%DrawableGroup<2, T></tt>. See @ref Drawable for Convenience alternative to `DrawableGroup<2, T>`. See @ref Drawable for
more information. more information.
@see @ref DrawableGroup2D, @ref BasicDrawableGroup3D @see @ref DrawableGroup2D, @ref BasicDrawableGroup3D
*/ */
@ -228,7 +228,7 @@ typedef BasicDrawableGroup2D<Float> DrawableGroup2D;
/** /**
@brief Group of drawables for three-dimensional scenes @brief Group of drawables for three-dimensional scenes
Convenience alternative to <tt>%DrawableGroup<3, T></tt>. See @ref Drawable for Convenience alternative to `DrawableGroup<3, T>`. See @ref Drawable for
more information. more information.
@see @ref DrawableGroup3D, @ref BasicDrawableGroup2D @see @ref DrawableGroup3D, @ref BasicDrawableGroup2D
*/ */

2
src/Magnum/SceneGraph/DualComplexTransformation.h

@ -48,7 +48,7 @@ template<class T> class BasicDualComplexTransformation: public AbstractBasicTran
/** @brief Underlying transformation type */ /** @brief Underlying transformation type */
typedef Math::DualComplex<T> DataType; typedef Math::DualComplex<T> DataType;
/** @brief %Object transformation */ /** @brief Object transformation */
Math::DualComplex<T> transformation() const { return _transformation; } Math::DualComplex<T> transformation() const { return _transformation; }
/** /**

2
src/Magnum/SceneGraph/DualQuaternionTransformation.h

@ -48,7 +48,7 @@ template<class T> class BasicDualQuaternionTransformation: public AbstractBasicT
/** @brief Underlying transformation type */ /** @brief Underlying transformation type */
typedef Math::DualQuaternion<T> DataType; typedef Math::DualQuaternion<T> DataType;
/** @brief %Object transformation */ /** @brief Object transformation */
Math::DualQuaternion<T> transformation() const { return _transformation; } Math::DualQuaternion<T> transformation() const { return _transformation; }
/** /**

8
src/Magnum/SceneGraph/FeatureGroup.h

@ -116,7 +116,7 @@ template<UnsignedInt dimensions, class Feature, class T> class FeatureGroup: pub
/** /**
@brief Base feature group for two-dimensional scenes @brief Base feature group for two-dimensional scenes
Convenience alternative to <tt>%FeatureGroup<2, Feature, T></tt>. See Convenience alternative to `FeatureGroup<2, Feature, T>`. See
@ref AbstractGroupedFeature for more information. @ref AbstractGroupedFeature for more information.
@see @ref FeatureGroup2D, @ref BasicFeatureGroup3D @see @ref FeatureGroup2D, @ref BasicFeatureGroup3D
*/ */
@ -125,7 +125,7 @@ template<class Feature, class T> using BasicFeatureGroup2D = FeatureGroup<2, Fea
/** /**
@brief Base feature group for two-dimensional float scenes @brief Base feature group for two-dimensional float scenes
Convenience alternative to <tt>%BasicFeatureGroup2D<Feature, Float></tt>. See Convenience alternative to `BasicFeatureGroup2D<Feature, Float>`. See
@ref AbstractGroupedFeature for more information. @ref AbstractGroupedFeature for more information.
@see @ref FeatureGroup3D @see @ref FeatureGroup3D
*/ */
@ -134,7 +134,7 @@ template<class Feature> using FeatureGroup2D = BasicFeatureGroup2D<Feature, Floa
/** /**
@brief Base feature group for three-dimensional scenes @brief Base feature group for three-dimensional scenes
Convenience alternative to <tt>%FeatureGroup<3, Feature, T></tt>. See Convenience alternative to `FeatureGroup<3, Feature, T>`. See
@ref AbstractGroupedFeature for more information. @ref AbstractGroupedFeature for more information.
@see @ref FeatureGroup3D, @ref BasicFeatureGroup2D @see @ref FeatureGroup3D, @ref BasicFeatureGroup2D
*/ */
@ -143,7 +143,7 @@ template<class Feature, class T> using BasicFeatureGroup3D = FeatureGroup<3, Fea
/** /**
@brief Base feature group for three-dimensional float scenes @brief Base feature group for three-dimensional float scenes
Convenience alternative to <tt>%BasicFeatureGroup3D<Feature, Float></tt>. See Convenience alternative to `BasicFeatureGroup3D<Feature, Float>`. See
@ref AbstractGroupedFeature for more information. @ref AbstractGroupedFeature for more information.
@see @ref FeatureGroup2D @see @ref FeatureGroup2D
*/ */

2
src/Magnum/SceneGraph/MatrixTransformation2D.h

@ -47,7 +47,7 @@ template<class T> class BasicMatrixTransformation2D: public AbstractBasicTransla
/** @brief Underlying transformation type */ /** @brief Underlying transformation type */
typedef Math::Matrix3<T> DataType; typedef Math::Matrix3<T> DataType;
/** @brief %Object transformation */ /** @brief Object transformation */
Math::Matrix3<T> transformation() const { return _transformation; } Math::Matrix3<T> transformation() const { return _transformation; }
/** /**

2
src/Magnum/SceneGraph/MatrixTransformation3D.h

@ -46,7 +46,7 @@ template<class T> class BasicMatrixTransformation3D: public AbstractBasicTransla
/** @brief Underlying transformation type */ /** @brief Underlying transformation type */
typedef Math::Matrix4<T> DataType; typedef Math::Matrix4<T> DataType;
/** @brief %Object transformation */ /** @brief Object transformation */
Math::Matrix4<T> transformation() const { return _transformation; } Math::Matrix4<T> transformation() const { return _transformation; }
/** /**

2
src/Magnum/SceneGraph/Object.h

@ -50,7 +50,7 @@ namespace Implementation {
} }
/** /**
@brief %Object @brief Object
Base of scene graph. Contains specific transformation implementation, takes Base of scene graph. Contains specific transformation implementation, takes
care of parent/children relationship and contains features. See @ref scenegraph care of parent/children relationship and contains features. See @ref scenegraph

2
src/Magnum/SceneGraph/RigidMatrixTransformation2D.h

@ -51,7 +51,7 @@ template<class T> class BasicRigidMatrixTransformation2D: public AbstractBasicTr
/** @brief Underlying transformation type */ /** @brief Underlying transformation type */
typedef Math::Matrix3<T> DataType; typedef Math::Matrix3<T> DataType;
/** @brief %Object transformation */ /** @brief Object transformation */
Math::Matrix3<T> transformation() const { return _transformation; } Math::Matrix3<T> transformation() const { return _transformation; }
/** /**

2
src/Magnum/SceneGraph/RigidMatrixTransformation3D.h

@ -50,7 +50,7 @@ template<class T> class BasicRigidMatrixTransformation3D: public AbstractBasicTr
/** @brief Underlying transformation type */ /** @brief Underlying transformation type */
typedef Math::Matrix4<T> DataType; typedef Math::Matrix4<T> DataType;
/** @brief %Object transformation */ /** @brief Object transformation */
Math::Matrix4<T> transformation() const { return _transformation; } Math::Matrix4<T> transformation() const { return _transformation; }
/** /**

2
src/Magnum/SceneGraph/Scene.h

@ -34,7 +34,7 @@
namespace Magnum { namespace SceneGraph { namespace Magnum { namespace SceneGraph {
/** /**
@brief %Scene @brief Scene
Basically @ref Object which cannot have parent or non-default transformation. Basically @ref Object which cannot have parent or non-default transformation.
See @ref scenegraph for introduction. See @ref scenegraph for introduction.

6
src/Magnum/SceneGraph/TranslationTransformation.h

@ -62,7 +62,7 @@ class TranslationTransformation: public AbstractTranslation<dimensions, T, Trans
/** @brief Underlying transformation type */ /** @brief Underlying transformation type */
typedef VectorTypeFor<dimensions, TranslationType> DataType; typedef VectorTypeFor<dimensions, TranslationType> DataType;
/** @brief %Object transformation */ /** @brief Object transformation */
VectorTypeFor<dimensions, TranslationType> transformation() const { return _transformation; } VectorTypeFor<dimensions, TranslationType> transformation() const { return _transformation; }
/** /**
@ -129,7 +129,7 @@ class TranslationTransformation: public AbstractTranslation<dimensions, T, Trans
/** /**
@brief Base transformation for two-dimensional scenes supporting translation @brief Base transformation for two-dimensional scenes supporting translation
Convenience alternative to <tt>%TranslationTransformation<2, T, TranslationType></tt>. Convenience alternative to `TranslationTransformation<2, T, TranslationType>`.
See @ref TranslationTransformation for more information. See @ref TranslationTransformation for more information.
@see @ref TranslationTransformation2D, @ref BasicTranslationTransformation3D @see @ref TranslationTransformation2D, @ref BasicTranslationTransformation3D
*/ */
@ -150,7 +150,7 @@ typedef BasicTranslationTransformation2D<Float> TranslationTransformation2D;
/** /**
@brief Base transformation for three-dimensional scenes supporting translation @brief Base transformation for three-dimensional scenes supporting translation
Convenience alternative to <tt>%TranslationTransformation<3, T, TranslationType></tt>. Convenience alternative to `TranslationTransformation<3, T, TranslationType>`.
See @ref TranslationTransformation for more information. See @ref TranslationTransformation for more information.
@see @ref TranslationTransformation3D, @ref BasicTranslationTransformation2D @see @ref TranslationTransformation3D, @ref BasicTranslationTransformation2D
*/ */

Loading…
Cancel
Save