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

100 lines
3.1 KiB
C++

////////////////////////////////////////////////////////////////////////////////////////////////////
// NoesisGUI - http://www.noesisengine.com
// Copyright (c) 2013 Noesis Technologies S.L. All Rights Reserved.
////////////////////////////////////////////////////////////////////////////////////////////////////
#ifndef __GUI_SIZEANIMATION_H__
#define __GUI_SIZEANIMATION_H__
#include <NsCore/Noesis.h>
#include <NsCore/ReflectionDeclare.h>
#include <NsGui/SizeAnimationBase.h>
#include <NsGui/AnimationApi.h>
namespace Noesis
{
template<class T> class Nullable;
////////////////////////////////////////////////////////////////////////////////////////////////////
/// Animates the value of a *Size* property between two target values using linear interpolation
/// over a specified *Duration*.
///
/// It is common to specify a starting value (set it by using the *From* property) and an ending
/// value (set it by using the *To* property). However, you can also specify only a starting value,
/// a destination value, or an offset value. In these cases, the animation obtains the missing
/// target value from the property that is being animated.
///
/// http://msdn.microsoft.com/en-us/library/system.windows.media.animation.sizeanimation.aspx
////////////////////////////////////////////////////////////////////////////////////////////////////
class NS_GUI_ANIMATION_API SizeAnimation: public SizeAnimationBase
{
public:
/// Gets or sets the total amount by which the animation changes its starting value
//@{
const Nullable<Size>& GetBy() const;
void SetBy(const Nullable<Size>& by);
//@}
/// Gets or sets the animation's starting value
//@{
const Nullable<Size>& GetFrom() const;
void SetFrom(const Nullable<Size>& from);
//@}
/// Gets or sets the animation's ending value
//@{
const Nullable<Size>& GetTo() const;
void SetTo(const Nullable<Size>& to);
//@}
/// Gets or sets the easing function applied to this animation
//@{
EasingFunctionBase* GetEasingFunction() const;
void SetEasingFunction(EasingFunctionBase* function);
//@}
/// From Freezable
//@{
Ptr<SizeAnimation> Clone() const;
Ptr<SizeAnimation> CloneCurrentValue() const;
//@}
public:
/// Dependency properties
//@{
static const DependencyProperty* ByProperty;
static const DependencyProperty* FromProperty;
static const DependencyProperty* ToProperty;
static const DependencyProperty* EasingFunctionProperty;
//@}
protected:
/// From Freezable
//@{
Ptr<Freezable> CreateInstanceCore() const override;
//@}
/// From AnimationTimeline
//@{
Ptr<AnimationTimeline> CreateTransitionFrom(EasingFunctionBase* easing) const override;
Ptr<AnimationTimeline> CreateTransitionTo(EasingFunctionBase* easing) const override;
//@}
/// From SizeAnimationBase
//@{
Size GetCurrentValueCore(const Size& defaultOrigin, const Size& defaultDestination,
AnimationClock* clock) override;
//@}
private:
NS_DECLARE_REFLECTION(SizeAnimation, SizeAnimationBase)
};
}
#endif