ic
/
magnum
mirror of https://github.com/mosra/magnum.git
6
0
Fork 0
Code Issues Projects Releases Wiki Activity
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.
11055 Commits
21 Branches
19 Tags
70 MiB
Tree: 134c625f48
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '134c625f48'
${ noResults }
magnum/src/Magnum/SceneGraph/Animable.hpp

147 lines
6.7 KiB
Raw Normal View History Unescape

SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
#ifndef Magnum_SceneGraph_Animable_hpp
#define Magnum_SceneGraph_Animable_hpp
/*
This file is part of Magnum.
Updated copyright year.
6 years ago
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
It's 2023 already!
3 years ago
2020, 2021, 2022, 2023 Vladimír Vondruš <mosra@centrum.cz>
Relicensing to MIT/Expat license, part 2: headers.
13 years ago
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
Relicensing to MIT/Expat license, part 2: headers.
13 years ago
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
*/
/** @file
SceneGraph: doc++
13 years ago
* @brief @ref compilation-speedup-hpp "Template implementation" for @ref Animable.h and @ref AnimableGroup.h
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
*/
Making includes absolute, part 5: absolute includes everywhere. The only places where they aren't absolute are: - when header is included from corresponding source file - when including headers which are not part of final installation (e.g. test-specific configuration, headers from Implementation/)
13 years ago
#include "Magnum/Timeline.h"
Use the new math constants throughout the code.
12 years ago
#include "Magnum/Math/Constants.h"
Making includes absolute, part 5: absolute includes everywhere. The only places where they aren't absolute are: - when header is included from corresponding source file - when including headers which are not part of final installation (e.g. test-specific configuration, headers from Implementation/)
13 years ago
#include "Magnum/SceneGraph/AnimableGroup.h"
#include "Magnum/SceneGraph/Animable.h"
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
namespace Magnum { namespace SceneGraph {
SceneGraph: prefix private Animable members with an underscore. And minor other coding style updates. This code is old, wow!
8 years ago
template<UnsignedInt dimensions, class T> Animable<dimensions, T>::Animable(AbstractObject<dimensions, T>& object, AnimableGroup<dimensions, T>* group): AbstractGroupedFeature<dimensions, Animable<dimensions, T>, T>{object, group}, _duration{0.0f}, _startTime{Constants::inf()}, _pauseTime{-Constants::inf()}, _previousState{AnimationState::Stopped}, _currentState{AnimationState::Stopped}, _repeated{false}, _repeatCount{0}, _repeats{0} {}
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
SceneGraph: behave properly when deleting a running animable. The test now passes again.
8 years ago
template<UnsignedInt dimensions, class T> Animable<dimensions, T>::~Animable() {
/* Update count of running animations when deleting an animable that's
currently running */
if(animables() && _currentState == AnimationState::Running)
--animables()->_runningCount;
}
SceneGraph: de-inlined some constructors & destructor, hidden internals. Might help reducing application size.
13 years ago
Reducing pointer chasings, part 1: method chaining via references. Makes some cases less consistent (and some convenience shortcuts impossible), but goes well with the attitude "don't use pointer when it can't be null".
13 years ago
template<UnsignedInt dimensions, class T> Animable<dimensions, T>& Animable<dimensions, T>::setState(AnimationState state) {
SceneGraph: prefix private Animable members with an underscore. And minor other coding style updates. This code is old, wow!
8 years ago
if(_currentState == state) return *this;
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
/* Not allowed (for sanity) */
SceneGraph: prefix private Animable members with an underscore. And minor other coding style updates. This code is old, wow!
8 years ago
if(_previousState == AnimationState::Stopped && state == AnimationState::Paused)
Reducing pointer chasings, part 1: method chaining via references. Makes some cases less consistent (and some convenience shortcuts impossible), but goes well with the attitude "don't use pointer when it can't be null".
13 years ago
return *this;
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
/* Wake up the group in case no animations are running */
SceneGraph: renamed Animable::group() to Animable::animables(). Fixes ambiguous case when inheriting multiple grouped features in a single object. The original functions are now aliases to the new ones, are marked as deprecated and will be removed in future release.
13 years ago
animables()->wakeUp = true;
SceneGraph: prefix private Animable members with an underscore. And minor other coding style updates. This code is old, wow!
8 years ago
_currentState = state;
Reducing pointer chasings, part 1: method chaining via references. Makes some cases less consistent (and some convenience shortcuts impossible), but goes well with the attitude "don't use pointer when it can't be null".
13 years ago
return *this;
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
}
SceneGraph: renamed Animable::group() to Animable::animables(). Fixes ambiguous case when inheriting multiple grouped features in a single object. The original functions are now aliases to the new ones, are marked as deprecated and will be removed in future release.
13 years ago
template<UnsignedInt dimensions, class T> AnimableGroup<dimensions, T>* Animable<dimensions, T>::animables() {
Better usage of *Basic* in class names, part 3: SceneGraph features. Use AbstractFeature<dimensions, T>, AbstractGroupedFeature<...>, AbstractFeatureGroup<...>, FeatureGroup<...> like before and add two kinds of aliases instead of only one, one with *Basic* for abstract type and one for Float type. Partially reverts commit 572efce3f7cd413addcf67967a88263f7d235830.
13 years ago
return static_cast<AnimableGroup<dimensions, T>*>(AbstractGroupedFeature<dimensions, Animable<dimensions, T>, T>::group());
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
}
SceneGraph: renamed Animable::group() to Animable::animables(). Fixes ambiguous case when inheriting multiple grouped features in a single object. The original functions are now aliases to the new ones, are marked as deprecated and will be removed in future release.
13 years ago
template<UnsignedInt dimensions, class T> const AnimableGroup<dimensions, T>* Animable<dimensions, T>::animables() const {
Better usage of *Basic* in class names, part 3: SceneGraph features. Use AbstractFeature<dimensions, T>, AbstractGroupedFeature<...>, AbstractFeatureGroup<...>, FeatureGroup<...> like before and add two kinds of aliases instead of only one, one with *Basic* for abstract type and one for Float type. Partially reverts commit 572efce3f7cd413addcf67967a88263f7d235830.
13 years ago
return static_cast<const AnimableGroup<dimensions, T>*>(AbstractGroupedFeature<dimensions, Animable<dimensions, T>, T>::group());
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
}
Better usage of *Basic* in class names, part 2: SceneGraph animables. Use Animable<dimensions, T> and AnimableGroup<dimensions, T> like before and add two kinds of aliases instead of only one: BasicAnimable[Group]2D<T>/BasicAnimable[Group]3D<T> for abstract type and Animable[Group]2D/Animable[Group]3D for Float. Partially reverts commit c32c12b387cf644360ad3b2e9305076d16bacc16.
13 years ago
template<UnsignedInt dimensions, class T> void AnimableGroup<dimensions, T>::step(const Float time, const Float delta) {
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
if(!_runningCount && !wakeUp) return;
wakeUp = false;
Reducing pointer chasings, part 2: don't use `this->` so often. It clarifies some things (e.g. from what base given member is). Not changed where it would be too long to write.
13 years ago
for(std::size_t i = 0; i != AnimableGroup<dimensions, T>::size(); ++i) {
Reducing pointer chasings, part 3c: less pointer passing in SceneGraph. Main change is that features take reference to containing object instead of pointer, as the feature must always belong to some object. Feature groups now return references to features and features return reference to containing object, as these cannot be null. Passing `*this` to AbstractFeature (and Camera[23]D) constructor might now clash with deleted copy constructor, added templated constructor to catch and resolve these ambiguous cases.
13 years ago
Animable<dimensions, T>& animable = (*this)[i];
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
/* The animation was stopped recently, just decrease count of running
animations if the animation was running before */
SceneGraph: prefix private Animable members with an underscore. And minor other coding style updates. This code is old, wow!
8 years ago
if(animable._previousState != AnimationState::Stopped && animable._currentState == AnimationState::Stopped) {
if(animable._previousState == AnimationState::Running)
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
--_runningCount;
SceneGraph: prefix private Animable members with an underscore. And minor other coding style updates. This code is old, wow!
8 years ago
animable._previousState = AnimationState::Stopped;
Reducing pointer chasings, part 3c: less pointer passing in SceneGraph. Main change is that features take reference to containing object instead of pointer, as the feature must always belong to some object. Feature groups now return references to features and features return reference to containing object, as these cannot be null. Passing `*this` to AbstractFeature (and Camera[23]D) constructor might now clash with deleted copy constructor, added templated constructor to catch and resolve these ambiguous cases.
13 years ago
animable.animationStopped();
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
continue;
/* The animation was paused recently, set pause time to previous frame time */
SceneGraph: prefix private Animable members with an underscore. And minor other coding style updates. This code is old, wow!
8 years ago
} else if(animable._previousState == AnimationState::Running && animable._currentState == AnimationState::Paused) {
animable._previousState = AnimationState::Paused;
animable._pauseTime = time;
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
--_runningCount;
Reducing pointer chasings, part 3c: less pointer passing in SceneGraph. Main change is that features take reference to containing object instead of pointer, as the feature must always belong to some object. Feature groups now return references to features and features return reference to containing object, as these cannot be null. Passing `*this` to AbstractFeature (and Camera[23]D) constructor might now clash with deleted copy constructor, added templated constructor to catch and resolve these ambiguous cases.
13 years ago
animable.animationPaused();
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
continue;
/* Skip the rest for not running animations */
SceneGraph: prefix private Animable members with an underscore. And minor other coding style updates. This code is old, wow!
8 years ago
} else if(animable._currentState != AnimationState::Running) {
CORRADE_INTERNAL_ASSERT(animable._previousState == animable._currentState);
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
continue;
SceneGraph: restarting animation should allow the same repeat count. Updated test to check that.
13 years ago
/* The animation was started recently, set start time to previous frame
time, reset repeat count */
SceneGraph: prefix private Animable members with an underscore. And minor other coding style updates. This code is old, wow!
8 years ago
} else if(animable._previousState == AnimationState::Stopped) {
animable._previousState = AnimationState::Running;
animable._startTime = time;
animable._repeats = 0;
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
++_runningCount;
Reducing pointer chasings, part 3c: less pointer passing in SceneGraph. Main change is that features take reference to containing object instead of pointer, as the feature must always belong to some object. Feature groups now return references to features and features return reference to containing object, as these cannot be null. Passing `*this` to AbstractFeature (and Camera[23]D) constructor might now clash with deleted copy constructor, added templated constructor to catch and resolve these ambiguous cases.
13 years ago
animable.animationStarted();
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
/* The animation was resumed recently, add pause duration to start time */
SceneGraph: prefix private Animable members with an underscore. And minor other coding style updates. This code is old, wow!
8 years ago
} else if(animable._previousState == AnimationState::Paused) {
animable._previousState = AnimationState::Running;
animable._startTime += time - animable._pauseTime;
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
++_runningCount;
Reducing pointer chasings, part 3c: less pointer passing in SceneGraph. Main change is that features take reference to containing object instead of pointer, as the feature must always belong to some object. Feature groups now return references to features and features return reference to containing object, as these cannot be null. Passing `*this` to AbstractFeature (and Camera[23]D) constructor might now clash with deleted copy constructor, added templated constructor to catch and resolve these ambiguous cases.
13 years ago
animable.animationResumed();
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
}
SceneGraph: prefix private Animable members with an underscore. And minor other coding style updates. This code is old, wow!
8 years ago
CORRADE_INTERNAL_ASSERT(animable._previousState == AnimationState::Running);
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
/* Animation time exceeded duration */
SceneGraph: prefix private Animable members with an underscore. And minor other coding style updates. This code is old, wow!
8 years ago
if(animable._duration != 0.0f && time-animable._startTime > animable._duration) {
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
/* Not repeated or repeat count exceeded, stop */
SceneGraph: prefix private Animable members with an underscore. And minor other coding style updates. This code is old, wow!
8 years ago
if(!animable._repeated || animable._repeats + 1 == animable._repeatCount) {
animable._previousState = AnimationState::Stopped;
animable._currentState = AnimationState::Stopped;
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
--_runningCount;
Reducing pointer chasings, part 3c: less pointer passing in SceneGraph. Main change is that features take reference to containing object instead of pointer, as the feature must always belong to some object. Feature groups now return references to features and features return reference to containing object, as these cannot be null. Passing `*this` to AbstractFeature (and Camera[23]D) constructor might now clash with deleted copy constructor, added templated constructor to catch and resolve these ambiguous cases.
13 years ago
animable.animationStopped();
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
continue;
}
/* Increase repeat count and add duration to startTime */
SceneGraph: prefix private Animable members with an underscore. And minor other coding style updates. This code is old, wow!
8 years ago
++animable._repeats;
animable._startTime += animable._duration;
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
}
/* Animation is still running, perform animation step */
SceneGraph: prefix private Animable members with an underscore. And minor other coding style updates. This code is old, wow!
8 years ago
CORRADE_ASSERT(time - animable._startTime >= 0.0f,
Better usage of *Basic* in class names, part 2: SceneGraph animables. Use Animable<dimensions, T> and AnimableGroup<dimensions, T> like before and add two kinds of aliases instead of only one: BasicAnimable[Group]2D<T>/BasicAnimable[Group]3D<T> for abstract type and Animable[Group]2D/Animable[Group]3D for Float. Partially reverts commit c32c12b387cf644360ad3b2e9305076d16bacc16.
13 years ago
"SceneGraph::AnimableGroup::step(): animation was started in future - probably wrong time passed", );
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
CORRADE_ASSERT(delta >= 0.0f,
Better usage of *Basic* in class names, part 2: SceneGraph animables. Use Animable<dimensions, T> and AnimableGroup<dimensions, T> like before and add two kinds of aliases instead of only one: BasicAnimable[Group]2D<T>/BasicAnimable[Group]3D<T> for abstract type and Animable[Group]2D/Animable[Group]3D for Float. Partially reverts commit c32c12b387cf644360ad3b2e9305076d16bacc16.
13 years ago
"SceneGraph::AnimableGroup::step(): negative delta passed", );
SceneGraph: prefix private Animable members with an underscore. And minor other coding style updates. This code is old, wow!
8 years ago
animable.animationStep(time - animable._startTime, delta);
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
}
Reducing pointer chasings, part 3c: less pointer passing in SceneGraph. Main change is that features take reference to containing object instead of pointer, as the feature must always belong to some object. Feature groups now return references to features and features return reference to containing object, as these cannot be null. Passing `*this` to AbstractFeature (and Camera[23]D) constructor might now clash with deleted copy constructor, added templated constructor to catch and resolve these ambiguous cases.
13 years ago
CORRADE_INTERNAL_ASSERT((_runningCount <= AnimableGroup<dimensions, T>::size()));
SceneGraph: new Animable feature. Allows to animate objects, pause, repeat and resume the animations. The user implements animation step and can perform actions on state changes. Each Animable is part of some group which is optimized for case when no animation is running, thus it is possible to create multiple independent "animation islands" to improve performance.
14 years ago
}
}}
#endif