-//
-// Copyright (c) 2014 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Flora License, Version 1.0 (the License);
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://floralicense.org/license/
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an AS IS BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
+/*
+ * Copyright (c) 2020 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
// CLASS HEADER
#include <dali/internal/update/animation/scene-graph-animation.h>
#include <cmath> // fmod
// INTERNAL INCLUDES
+#include <dali/internal/common/memory-pool-object-allocator.h>
#include <dali/internal/render/common/performance-monitor.h>
+#include <dali/public-api/math/math-utils.h>
+namespace //Unnamed namespace
+{
+//Memory pool used to allocate new animations. Memory used by this pool will be released when shutting down DALi
+Dali::Internal::MemoryPoolObjectAllocator<Dali::Internal::SceneGraph::Animation> gAnimationMemoryPool;
+
+inline void WrapInPlayRange( float& elapsed, const float& playRangeStartSeconds, const float& playRangeEndSeconds)
+{
+ if( elapsed > playRangeEndSeconds )
+ {
+ elapsed = playRangeStartSeconds + fmodf( ( elapsed - playRangeStartSeconds ), ( playRangeEndSeconds - playRangeStartSeconds ) );
+ }
+ else if( elapsed < playRangeStartSeconds )
+ {
+ elapsed = playRangeEndSeconds - fmodf( ( playRangeStartSeconds - elapsed ), ( playRangeEndSeconds - playRangeStartSeconds ) );
+ }
+}
+
+/// Compares the end times of the animators and if the end time is less, then it is moved earlier in the list. If end times are the same, then no change.
+bool CompareAnimatorEndTimes( const Dali::Internal::SceneGraph::AnimatorBase* lhs, const Dali::Internal::SceneGraph::AnimatorBase* rhs )
+{
+ return ( ( lhs->GetIntervalDelay() + lhs->GetDuration() ) < ( rhs->GetIntervalDelay() + rhs->GetDuration() ) );
+}
-using namespace std;
+} // unnamed namespace
namespace Dali
{
namespace SceneGraph
{
-float DefaultAlphaFunc(float progress)
+Animation* Animation::New( float durationSeconds, float speedFactor, const Vector2& playRange, int32_t loopCount, EndAction endAction, EndAction disconnectAction )
{
- return progress; // linear
+ return new ( gAnimationMemoryPool.AllocateRawThreadSafe() ) Animation( durationSeconds, speedFactor, playRange, loopCount, endAction, disconnectAction );
}
-Animation::Animation(float durationSeconds, bool isLooping, Dali::Animation::EndAction endAction, Dali::Animation::EndAction destroyAction)
-: mDurationSeconds(durationSeconds),
- mLooping(isLooping),
+Animation::Animation( float durationSeconds, float speedFactor, const Vector2& playRange, int32_t loopCount, Dali::Animation::EndAction endAction, Dali::Animation::EndAction disconnectAction )
+: mPlayRange( playRange ),
+ mDurationSeconds( durationSeconds ),
+ mDelaySeconds( 0.0f ),
+ mElapsedSeconds( playRange.x*mDurationSeconds ),
+ mSpeedFactor( speedFactor ),
+ mProgressMarker( 0.0f ),
+ mPlayedCount( 0 ),
+ mLoopCount(loopCount),
+ mCurrentLoop(0),
mEndAction(endAction),
- mDestroyAction(destroyAction),
+ mDisconnectAction(disconnectAction),
mState(Stopped),
- mElapsedSeconds(0.0f),
- mPlayCount(0)
+ mProgressReachedSignalRequired( false ),
+ mAutoReverseEnabled( false ),
+ mIsActive{ false }
{
}
-Animation::~Animation()
+Animation::~Animation() = default;
+
+void Animation::operator delete( void* ptr )
{
+ gAnimationMemoryPool.FreeThreadSafe( static_cast<Animation*>( ptr ) );
}
void Animation::SetDuration(float durationSeconds)
{
- DALI_ASSERT_DEBUG(durationSeconds > 0.0f);
-
mDurationSeconds = durationSeconds;
}
-void Animation::SetLooping(bool looping)
+void Animation::SetProgressNotification( float progress )
+{
+ mProgressMarker = progress;
+ if ( mProgressMarker > 0.0f )
+ {
+ mProgressReachedSignalRequired = true;
+ }
+}
+
+void Animation::SetLoopCount(int32_t loopCount)
{
- mLooping = looping;
+ mLoopCount = loopCount;
+ mCurrentLoop = 0;
}
void Animation::SetEndAction(Dali::Animation::EndAction action)
mEndAction = action;
}
-void Animation::SetDestroyAction(Dali::Animation::EndAction action)
+void Animation::SetDisconnectAction(Dali::Animation::EndAction action)
{
- mDestroyAction = action;
+ if ( mDisconnectAction != action )
+ {
+ mDisconnectAction = action;
+
+ for ( auto&& item : mAnimators )
+ {
+ item->SetDisconnectAction( action );
+ }
+ }
+}
+
+void Animation::SetPlayRange( const Vector2& range )
+{
+ mPlayRange = range;
+
+ // Make sure mElapsedSeconds is within the new range
+
+ if( mState == Stopped )
+ {
+ // Ensure that the animation starts at the right place
+ mElapsedSeconds = mPlayRange.x * mDurationSeconds;
+ }
+ else
+ {
+ // If already past the end of the range, but before end of duration, then clamp will
+ // ensure that the animation stops on the next update.
+ // If not yet at the start of the range, clamping will jump to the start
+ mElapsedSeconds = Dali::Clamp(mElapsedSeconds, mPlayRange.x*mDurationSeconds , mPlayRange.y*mDurationSeconds );
+ }
}
void Animation::Play()
{
+ // Sort according to end time with earlier end times coming first, if the end time is the same, then the animators are not moved
+ std::stable_sort( mAnimators.Begin(), mAnimators.End(), CompareAnimatorEndTimes );
+
mState = Playing;
+
+ if ( mSpeedFactor < 0.0f && mElapsedSeconds <= mPlayRange.x*mDurationSeconds )
+ {
+ mElapsedSeconds = mPlayRange.y * mDurationSeconds;
+ }
+
+ SetAnimatorsActive( true );
+
+ mCurrentLoop = 0;
+}
+
+void Animation::PlayFrom( float progress )
+{
+ // If the animation is already playing this has no effect
+ // Progress is guaranteed to be in range.
+ if( mState != Playing )
+ {
+ mElapsedSeconds = progress * mDurationSeconds;
+ mState = Playing;
+
+ SetAnimatorsActive( true );
+
+ mCurrentLoop = 0;
+ }
+}
+
+void Animation::PlayAfter( float delaySeconds )
+{
+ if( mState != Playing )
+ {
+ mDelaySeconds = delaySeconds;
+ mState = Playing;
+
+ if ( mSpeedFactor < 0.0f && mElapsedSeconds <= mPlayRange.x*mDurationSeconds )
+ {
+ mElapsedSeconds = mPlayRange.y * mDurationSeconds;
+ }
+
+ SetAnimatorsActive( true );
+
+ mCurrentLoop = 0;
+ }
}
void Animation::Pause()
}
}
+void Animation::Bake(BufferIndex bufferIndex, EndAction action)
+{
+ if( action == Dali::Animation::BAKE_FINAL )
+ {
+ if( mSpeedFactor > 0.0f )
+ {
+ mElapsedSeconds = mPlayRange.y*mDurationSeconds + Math::MACHINE_EPSILON_1; // Force animation to reach it's end
+ }
+ else
+ {
+ mElapsedSeconds = mPlayRange.x*mDurationSeconds - Math::MACHINE_EPSILON_1; //Force animation to reach it's beginning
+ }
+ }
+
+ UpdateAnimators( bufferIndex, true/*bake the final result*/, true /*animation finished*/ );
+}
+
+void Animation::SetAnimatorsActive( bool active )
+{
+ for ( auto&& item : mAnimators )
+ {
+ item->SetActive( active );
+ }
+}
+
bool Animation::Stop(BufferIndex bufferIndex)
{
bool animationFinished(false);
{
animationFinished = true; // The actor-thread should be notified of this
- if( mEndAction != Dali::Animation::Discard )
+ if( mEndAction != Dali::Animation::DISCARD )
{
- if( mEndAction == Dali::Animation::BakeFinal )
- {
- mElapsedSeconds = mDurationSeconds + Math::MACHINE_EPSILON_1; // Force animation to reach it's end
- }
- UpdateAnimators(bufferIndex, true/*bake the final result*/);
+ Bake( bufferIndex, mEndAction );
+
+ // Animators are automatically set to inactive in Bake
+ }
+ else
+ {
+ SetAnimatorsActive( false );
}
// The animation has now been played to completion
- ++mPlayCount;
+ ++mPlayedCount;
+ mCurrentLoop = 0;
}
- mElapsedSeconds = 0.0f;
+ mElapsedSeconds = mPlayRange.x*mDurationSeconds;
mState = Stopped;
return animationFinished;
{
if (mState == Playing || mState == Paused)
{
- if (mDestroyAction != Dali::Animation::Discard)
+ if (mEndAction != Dali::Animation::DISCARD)
+ {
+ Bake( bufferIndex, mEndAction );
+
+ // Animators are automatically set to inactive in Bake
+ }
+ else
{
- UpdateAnimators(bufferIndex, true/*bake the final result*/);
+ SetAnimatorsActive( false );
}
}
mState = Destroyed;
}
-void Animation::AddAnimator( AnimatorBase* animator, PropertyOwner* propertyOwner )
+void Animation::SetLoopingMode( bool loopingMode )
+{
+ mAutoReverseEnabled = loopingMode;
+
+ for ( auto&& item : mAnimators )
+ {
+ // Send some variables together to figure out the Animation status
+ item->SetSpeedFactor( mSpeedFactor );
+ item->SetLoopCount( mLoopCount );
+ item->SetLoopingMode( loopingMode );
+ }
+}
+
+void Animation::AddAnimator( OwnerPointer<AnimatorBase>& animator )
{
- animator->Attach( propertyOwner );
+ animator->ConnectToSceneGraph();
+ animator->SetDisconnectAction( mDisconnectAction );
- mAnimators.PushBack( animator );
+ mAnimators.PushBack( animator.Release() );
}
-bool Animation::Update(BufferIndex bufferIndex, float elapsedSeconds)
+void Animation::Update( BufferIndex bufferIndex, float elapsedSeconds, bool& looped, bool& finished, bool& progressReached )
{
+ looped = false;
+ finished = false;
+
if (mState == Stopped || mState == Destroyed)
{
// Short circuit when animation isn't running
- return false;
+ return;
}
// The animation must still be applied when Paused/Stopping
if (mState == Playing)
{
- mElapsedSeconds += elapsedSeconds;
- }
+ // Sign value of speed factor. It can optimize many arithmetic comparision
+ float signSpeedFactor = ( mSpeedFactor < 0.0f ) ? -1.f : 1.f;
- if (mLooping)
- {
- if (mElapsedSeconds > mDurationSeconds)
+ // If there is delay time before Animation starts, wait the Animation until mDelaySeconds.
+ if( mDelaySeconds > 0.0f )
{
- mElapsedSeconds = fmod(mElapsedSeconds, mDurationSeconds);
+ float reduceSeconds = fabsf( elapsedSeconds * mSpeedFactor );
+ if( reduceSeconds > mDelaySeconds )
+ {
+ // add overflowed time to mElapsedSecond.
+ // If speed factor > 0, add it. if speed factor < 0, subtract it.
+ float overflowSeconds = reduceSeconds - mDelaySeconds;
+ mElapsedSeconds += signSpeedFactor * overflowSeconds;
+ mDelaySeconds = 0.0f;
+ }
+ else
+ {
+ mDelaySeconds -= reduceSeconds;
+ }
+ }
+ else
+ {
+ mElapsedSeconds += ( elapsedSeconds * mSpeedFactor );
}
- }
- const bool animationFinished(mState == Playing && mElapsedSeconds > mDurationSeconds);
+ const float playRangeStartSeconds = mPlayRange.x * mDurationSeconds;
+ const float playRangeEndSeconds = mPlayRange.y * mDurationSeconds;
+ // Final reached seconds. It can optimize many arithmetic comparision
+ float edgeRangeSeconds = ( mSpeedFactor < 0.0f ) ? playRangeStartSeconds : playRangeEndSeconds;
- UpdateAnimators(bufferIndex, animationFinished && (mEndAction != Dali::Animation::Discard));
+ // Optimized Factors.
+ // elapsed > edge --> check if looped
+ // elapsed >= marker --> check if elapsed reached to marker in normal case
+ // edge >= marker --> check if elapsed reached to marker in looped case
+ float elapsedFactor = signSpeedFactor * mElapsedSeconds;
+ float edgeFactor = signSpeedFactor * edgeRangeSeconds;
+ float markerFactor = signSpeedFactor * mProgressMarker;
- if (animationFinished)
- {
- // The animation has now been played to completion
- ++mPlayCount;
+ // check it is looped
+ looped = ( elapsedFactor > edgeFactor );
- mElapsedSeconds = 0.0f;
- mState = Stopped;
+ if( looped )
+ {
+ WrapInPlayRange( mElapsedSeconds, playRangeStartSeconds, playRangeEndSeconds );
+
+ // Recalculate elapsedFactor here
+ elapsedFactor = signSpeedFactor * mElapsedSeconds;
+
+ if( mLoopCount != 0 )
+ {
+ // Check If this animation is finished
+ ++mCurrentLoop;
+ if( mCurrentLoop >= mLoopCount )
+ {
+ DALI_ASSERT_DEBUG( mCurrentLoop == mLoopCount );
+ finished = true;
+
+ // The animation has now been played to completion
+ ++mPlayedCount;
+
+ // Make elapsed second as edge of range forcely.
+ mElapsedSeconds = edgeRangeSeconds + signSpeedFactor * Math::MACHINE_EPSILON_10;
+ UpdateAnimators(bufferIndex, finished && (mEndAction != Dali::Animation::DISCARD), finished );
+
+ // After update animation, mElapsedSeconds must be begin of value
+ mElapsedSeconds = playRangeStartSeconds + playRangeEndSeconds - edgeRangeSeconds;
+ mState = Stopped;
+ }
+ }
+
+ // when it is on looped state, 2 case to send progress signal.
+ // (require && range_value >= marker) || << Signal at previous loop
+ // (marker > 0 && !finished && elaped >= marker) << Signal at current loop
+ if( ( mProgressMarker > 0.0f ) && !finished && ( elapsedFactor >= markerFactor ) )
+ {
+ // The application should be notified by NotificationManager, in another thread
+ progressReached = true;
+ mProgressReachedSignalRequired = false;
+ }
+ else
+ {
+ if( mProgressReachedSignalRequired && ( edgeFactor >= markerFactor ) )
+ {
+ progressReached = true;
+ }
+ mProgressReachedSignalRequired = mProgressMarker > 0.0f;
+ }
+ }
+ else
+ {
+ // when it is not on looped state, only 1 case to send progress signal.
+ // (require && elaped >= marker)
+ if( mProgressReachedSignalRequired && ( elapsedFactor >= markerFactor ) )
+ {
+ // The application should be notified by NotificationManager, in another thread
+ progressReached = true;
+ mProgressReachedSignalRequired = false;
+ }
+ }
}
- return animationFinished;
+ // Already updated when finished. So skip.
+ if( !finished )
+ {
+ UpdateAnimators(bufferIndex, false, false );
+ }
}
-void Animation::UpdateAnimators(BufferIndex bufferIndex, bool bake)
+void Animation::UpdateAnimators( BufferIndex bufferIndex, bool bake, bool animationFinished )
{
- for ( AnimatorIter iter = mAnimators.Begin(); iter != mAnimators.End(); )
- {
- // If an animator is not successfully applied, then it has been orphaned
- bool applied(true);
+ mIsActive[bufferIndex] = false;
- AnimatorBase *animator = *iter;
- const float initialDelay(animator->GetInitialDelay());
+ const Vector2 playRange( mPlayRange * mDurationSeconds );
+ float elapsedSecondsClamped = Clamp( mElapsedSeconds, playRange.x, playRange.y );
- if (mElapsedSeconds >= initialDelay)
- {
- // Calculate a progress specific to each individual animator
- float progress(1.0f);
- const float animatorDuration = animator->GetDuration();
- if (animatorDuration > 0.0f) // animators can be "immediate"
- {
- progress = min(1.0f, (mElapsedSeconds - initialDelay) / animatorDuration);
- }
+ bool cleanup = false;
- applied = animator->Update(bufferIndex, progress, bake);
+ //Loop through all animators
+ for(auto& animator : mAnimators)
+ {
+ if(animator->Orphan())
+ {
+ cleanup = true;
+ continue;
}
- // Animators are automatically removed, when orphaned from animatable scene objects.
- if (!applied)
+ bool applied(true);
+ if(animator->IsEnabled())
{
- iter = mAnimators.Erase(iter);
+ const float intervalDelay(animator->GetIntervalDelay());
+
+ if(elapsedSecondsClamped >= intervalDelay)
+ {
+ // Calculate a progress specific to each individual animator
+ float progress(1.0f);
+ const float animatorDuration = animator->GetDuration();
+ if(animatorDuration > 0.0f) // animators can be "immediate"
+ {
+ progress = Clamp((elapsedSecondsClamped - intervalDelay) / animatorDuration, 0.0f, 1.0f);
+ }
+ animator->Update(bufferIndex, progress, bake);
+
+ if (animatorDuration > 0.0f && (elapsedSecondsClamped - intervalDelay) <= animatorDuration)
+ {
+ mIsActive[bufferIndex] = true;
+ }
+ }
+ applied = true;
}
else
{
- ++iter;
+ applied = false;
+ }
+
+ if(animationFinished)
+ {
+ animator->SetActive(false);
+ }
+ if(applied)
+ {
INCREASE_COUNTER(PerformanceMonitor::ANIMATORS_APPLIED);
}
}
+
+ if(cleanup)
+ {
+ //Remove animators whose PropertyOwner has been destroyed
+ mAnimators.Erase(std::remove_if(mAnimators.begin(),
+ mAnimators.end(),
+ [](auto& animator) { return animator->Orphan(); }),
+ mAnimators.end());
+ }
}
} // namespace SceneGraph
projects / platform / core / uifw / dali-core.git / blobdiff