xmake.repo/packages/n/noesis/latest/Include/NsGui/StringAnimationBase.h

60 lines
2.3 KiB
C
Raw Normal View History

2024-12-22 19:15:02 +08:00
////////////////////////////////////////////////////////////////////////////////////////////////////
// NoesisGUI - http://www.noesisengine.com
// Copyright (c) 2013 Noesis Technologies S.L. All Rights Reserved.
////////////////////////////////////////////////////////////////////////////////////////////////////
#ifndef __GUI_STRINGANIMATIONBASE_H__
#define __GUI_STRINGANIMATIONBASE_H__
#include <NsCore/Noesis.h>
#include <NsCore/ReflectionDeclare.h>
#include <NsGui/AnimationTimeline.h>
#include <NsGui/AnimationApi.h>
namespace Noesis
{
////////////////////////////////////////////////////////////////////////////////////////////////////
/// Abstract class that, when implemented, animates a *String* value.
///
/// Derive from a StringAnimationBase class and implement the *GetCurrentValueCore* method. The
/// *GetCurrentValueCore* method returns the current value of the animation. It takes three
/// parameters: a suggested starting value, a suggested ending value, and an AnimationClock, which
/// you use to determine the progress of the animation.
///
/// Because StringAnimationBase class inherit from the Freezable class, you must also override
/// *CreateInstanceCore* core to return a new instance of your class.
///
/// http://msdn.microsoft.com/en-us/library/system.windows.media.animation.stringanimationbase.aspx
////////////////////////////////////////////////////////////////////////////////////////////////////
class NS_GUI_ANIMATION_API StringAnimationBase: public AnimationTimeline
{
public:
/// Gets the current value of the animation
String GetCurrentValue(const String& defaultOrigin, const String& defaultDestination,
AnimationClock* clock);
protected:
/// Calculates a value that represents the current value of the property being animated,
/// as determined by the host animation
virtual String GetCurrentValueCore(const String& defaultOrigin,
const String& defaultDestination, AnimationClock* clock) = 0;
private:
/// From AnimationTimeline
//@{
const Type* GetTargetPropertyType() const final override;
Ptr<BaseComponent> GetCurrentValue(BaseComponent* defaultOrigin,
BaseComponent* defaultDestination, AnimationClock* clock) final override;
//@}
NS_DECLARE_REFLECTION(StringAnimationBase, AnimationTimeline)
};
}
#endif