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

80 lines
2.7 KiB
C++

////////////////////////////////////////////////////////////////////////////////////////////////////
// NoesisGUI - http://www.noesisengine.com
// Copyright (c) 2013 Noesis Technologies S.L. All Rights Reserved.
////////////////////////////////////////////////////////////////////////////////////////////////////
#ifndef __GUI_SPLINESIZEKEYFRAME_H__
#define __GUI_SPLINESIZEKEYFRAME_H__
#include <NsCore/Noesis.h>
#include <NsCore/ReflectionDeclare.h>
#include <NsGui/SizeKeyFrame.h>
#include <NsGui/AnimationApi.h>
namespace Noesis
{
class KeySpline;
////////////////////////////////////////////////////////////////////////////////////////////////////
/// Animates from the *Size* value of the previous key frame to its own *Value* using splined
/// interpolation.
///
/// This class is used as part of a SizeKeyFrameCollection in conjunction with a
/// SizeAnimationUsingKeyFrames to animate a Size property value along a set of key frames.
///
/// A key frame defines a segment of the SizeAnimationUsingKeyFrames to which it belongs. Each key
/// frame has a target Value and a KeyTime. The KeyTime specifies the time at which the key frame's
/// Value should be reached. A key frame animates from the target value of the previous key frame to
/// its own target value. It starts when the previous key frame ends and ends when its own key time
/// is reached.
///
/// Spline key frames like SplineSizeKeyFrame creates a variable transition between values which is
/// determined by the KeySpline property. Splined interpolation can be used to achieve more
/// realistic "real world" timing effects such as acceleration and deceleration.
///
/// http://msdn.microsoft.com/en-us/library/system.windows.media.animation.splinesizekeyframe.aspx
////////////////////////////////////////////////////////////////////////////////////////////////////
class NS_GUI_ANIMATION_API SplineSizeKeyFrame final: public SizeKeyFrame
{
public:
/// Gets or sets the two control points that define animation progress for this key frame
//@{
KeySpline* GetKeySpline() const;
void SetKeySpline(KeySpline* spline);
//@}
// Hides Freezable methods for convenience
//@{
Ptr<SplineSizeKeyFrame> Clone() const;
Ptr<SplineSizeKeyFrame> CloneCurrentValue() const;
//@}
public:
/// Dependency properties
//@{
static const DependencyProperty* KeySplineProperty;
//@}
protected:
/// From Freezable
//@{
Ptr<Freezable> CreateInstanceCore() const override;
//@}
/// From KeyFrame
//@{
Size InterpolateValueCore(const Size& baseValue, float keyFrameProgress) override;
//@}
NS_DECLARE_REFLECTION(SplineSizeKeyFrame, SizeKeyFrame)
};
}
#endif