xmake.repo/packages/n/noesis/latest/Include/NsGui/SizeAnimationBase.h
2024-12-22 19:15:02 +08:00

62 lines
2.3 KiB
C++

////////////////////////////////////////////////////////////////////////////////////////////////////
// NoesisGUI - http://www.noesisengine.com
// Copyright (c) 2013 Noesis Technologies S.L. All Rights Reserved.
////////////////////////////////////////////////////////////////////////////////////////////////////
#ifndef __GUI_SIZEANIMATIONBASE_H__
#define __GUI_SIZEANIMATIONBASE_H__
#include <NsCore/Noesis.h>
#include <NsCore/ReflectionDeclare.h>
#include <NsGui/AnimationTimeline.h>
#include <NsGui/AnimationApi.h>
namespace Noesis
{
struct Size;
////////////////////////////////////////////////////////////////////////////////////////////////////
/// Abstract class that, when implemented, animates a *Size* value.
///
/// Derive from a SizeAnimationBase 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 SizeAnimationBase 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.sizeanimationbase.aspx
////////////////////////////////////////////////////////////////////////////////////////////////////
class NS_GUI_ANIMATION_API SizeAnimationBase: public AnimationTimeline
{
public:
/// Gets the current value of the animation
Size GetCurrentValue(const Size& defaultOrigin, const Size& defaultDestination,
AnimationClock* clock);
protected:
/// Calculates a value that represents the current value of the property being animated,
/// as determined by the host animation
virtual Size GetCurrentValueCore(const Size& defaultOrigin, const Size& 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(SizeAnimationBase, AnimationTimeline)
};
}
#endif