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

66 lines
2.4 KiB
C
Raw Permalink 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_DISCRETESTRINGKEYFRAME_H__
#define __GUI_DISCRETESTRINGKEYFRAME_H__
#include <NsCore/Noesis.h>
#include <NsCore/ReflectionDeclare.h>
#include <NsGui/StringKeyFrame.h>
#include <NsGui/AnimationApi.h>
namespace Noesis
{
////////////////////////////////////////////////////////////////////////////////////////////////////
/// Animates from the *String* value of the previous key frame to its own *Value* using discrete
/// interpolation.
///
/// This class is used as part of a StringKeyFrameCollection in conjunction with a
/// StringAnimationUsingKeyFrames to animate a String property value along a set of key frames.
///
/// A key frame defines a segment of the StringAnimationUsingKeyFrames 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.
///
/// Discrete key frames like DiscreteStringKeyFrame create sudden "jumps" between values (no
/// Interpolation). In other words, the animated property does not change until the key frame's key
/// time is reached at which point the animated property goes suddenly to the target value.
///
/// http://msdn.microsoft.com/en-us/library/system.windows.media.animation.discretestringkeyframe.aspx
////////////////////////////////////////////////////////////////////////////////////////////////////
class NS_GUI_ANIMATION_API DiscreteStringKeyFrame final: public StringKeyFrame
{
public:
// Hides Freezable methods for convenience
//@{
Ptr<DiscreteStringKeyFrame> Clone() const;
Ptr<DiscreteStringKeyFrame> CloneCurrentValue() const;
//@}
protected:
/// From Freezable
//@{
Ptr<Freezable> CreateInstanceCore() const override;
//@}
/// From KeyFrame
//@{
String InterpolateValueCore(const String& baseValue, float keyFrameProgress) override;
//@}
NS_DECLARE_REFLECTION(DiscreteStringKeyFrame, StringKeyFrame)
};
}
#endif