mirror of https://github.com/mosra/magnum.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
133 lines
4.3 KiB
133 lines
4.3 KiB
#ifndef Magnum_SceneGraph_AbstractGroupedFeature_h |
|
#define Magnum_SceneGraph_AbstractGroupedFeature_h |
|
/* |
|
Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz> |
|
|
|
This file is part of Magnum. |
|
|
|
Magnum is free software: you can redistribute it and/or modify |
|
it under the terms of the GNU Lesser General Public License version 3 |
|
only, as published by the Free Software Foundation. |
|
|
|
Magnum is distributed in the hope that it will be useful, |
|
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
GNU Lesser General Public License version 3 for more details. |
|
*/ |
|
|
|
/** @file |
|
* @brief Class Magnum::SceneGraph::AbstractGroupedFeature, alias Magnum::SceneGraph::AbstractGroupedFeature2D, Magnum::SceneGraph::AbstractGroupedFeature3D |
|
*/ |
|
|
|
#include <algorithm> |
|
#include <vector> |
|
|
|
#include "AbstractFeature.h" |
|
#include "FeatureGroup.h" |
|
|
|
namespace Magnum { namespace SceneGraph { |
|
|
|
/** |
|
@brief Base for grouped features |
|
|
|
Used together with FeatureGroup. |
|
|
|
@section AbstractGroupedFeature-subclassing Subclassing |
|
|
|
Usage is via subclassing the feature using [CRTP](http://en.wikipedia.org/wiki/Curiously_recurring_template_pattern) |
|
and typedef'ing FeatureGroup to accept only given type, e.g.: |
|
@code |
|
class Drawable: public SceneGraph::AbstractGroupedFeature3D<Drawable> { |
|
// ... |
|
}; |
|
|
|
typedef SceneGraph::FeatureGroup3D<Drawable> DrawableGroup; |
|
@endcode |
|
|
|
@see @ref scenegraph, AbstractGroupedFeature2D, AbstractGroupedFeature3D, |
|
FeatureGroup, FeatureGroup2D, FeatureGroup3D |
|
*/ |
|
#ifndef DOXYGEN_GENERATING_OUTPUT |
|
template<std::uint8_t dimensions, class Derived, class T> |
|
#else |
|
template<std::uint8_t dimensions, class Derived, class T = GLfloat> |
|
#endif |
|
class AbstractGroupedFeature: public AbstractFeature<dimensions, T> { |
|
friend class FeatureGroup<dimensions, Derived, T>; |
|
|
|
public: |
|
/** |
|
* @brief Constructor |
|
* @param object %Object this feature belongs to |
|
* @param group Group this feature belongs to |
|
* |
|
* Adds the feature to the object and to group, if specified. |
|
* @see FeatureGroup::add() |
|
*/ |
|
inline explicit AbstractGroupedFeature(AbstractObject<dimensions, T>* object, FeatureGroup<dimensions, Derived, T>* group = nullptr): AbstractFeature<dimensions, T>(object), _group(nullptr) { |
|
if(group) group->add(static_cast<Derived*>(this)); |
|
} |
|
|
|
/** |
|
* @brief Destructor |
|
* |
|
* Removes the feature from object and from group, if it belongs to |
|
* any. |
|
*/ |
|
inline ~AbstractGroupedFeature() { |
|
if(_group) _group->remove(static_cast<Derived*>(this)); |
|
} |
|
|
|
/** @brief Group this feature belongs to */ |
|
inline FeatureGroup<dimensions, Derived, T>* group() { |
|
return _group; |
|
} |
|
|
|
/** @overload */ |
|
inline const FeatureGroup<dimensions, Derived, T>* group() const { |
|
return _group; |
|
} |
|
|
|
private: |
|
FeatureGroup<dimensions, Derived, T>* _group; |
|
}; |
|
|
|
/** |
|
@brief Base for two-dimensional grouped features |
|
|
|
Convenience alternative to <tt>%AbstractGroupedFeature<2, Derived, T></tt>. See |
|
AbstractGroupedFeature for more information. |
|
@see AbstractGroupedFeature3D |
|
@note Not available on GCC < 4.7. Use <tt>%AbstractGroupedFeature<2, Derived, T></tt> |
|
instead. |
|
@todoc Remove workaround when Doxygen supports alias template |
|
*/ |
|
#ifndef DOXYGEN_GENERATING_OUTPUT |
|
#ifndef CORRADE_GCC46_COMPATIBILITY |
|
template<class Derived, class T = GLfloat> using AbstractGroupedFeature2D = AbstractGroupedFeature<2, Derived, T>; |
|
#endif |
|
#else |
|
typedef AbstractGroupedFeature<2, Derived, T = GLfloat> AbstractGroupedFeature2D; |
|
#endif |
|
|
|
/** |
|
@brief Base for three-dimensional grouped features |
|
|
|
Convenience alternative to <tt>%AbstractGroupedFeature<3, Derived, T></tt>. See |
|
AbstractGroupedFeature for more information. |
|
@see AbstractGroupedFeature2D |
|
@note Not available on GCC < 4.7. Use <tt>%AbstractGroupedFeature<3, Derived, T></tt> |
|
instead. |
|
@todoc Remove workaround when Doxygen supports alias template |
|
*/ |
|
#ifndef DOXYGEN_GENERATING_OUTPUT |
|
#ifndef CORRADE_GCC46_COMPATIBILITY |
|
template<class Derived, class T = GLfloat> using AbstractGroupedFeature3D = AbstractGroupedFeature<3, Derived, T>; |
|
#endif |
|
#else |
|
typedef AbstractGroupedFeature<3, Derived, T = GLfloat> AbstractGroupedFeature3D; |
|
#endif |
|
|
|
}} |
|
|
|
#endif
|
|
|