////////////////////////////////////////////////////////////////////////////////////////////////////
// NoesisGUI - http://www.noesisengine.com
// Copyright (c) 2013 Noesis Technologies S.L. All Rights Reserved.
////////////////////////////////////////////////////////////////////////////////////////////////////


#ifndef __GUI_DISCRETEOBJECTKEYFRAME_H__
#define __GUI_DISCRETEOBJECTKEYFRAME_H__


#include <NsCore/Noesis.h>
#include <NsCore/ReflectionDeclare.h>
#include <NsGui/ObjectKeyFrame.h>
#include <NsGui/AnimationApi.h>


namespace Noesis
{

////////////////////////////////////////////////////////////////////////////////////////////////////
/// Animates from the *Object* value of the previous key frame to its own *Value* using discrete
/// interpolation.
///
/// This class is used as part of a ObjectKeyFrameCollection in conjunction with a
/// ObjectAnimationUsingKeyFrames to animate a Object property value along a set of key frames.
///
/// A key frame defines a segment of the ObjectAnimationUsingKeyFrames 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 DiscreteObjectKeyFrame 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.discreteobjectkeyframe.aspx
////////////////////////////////////////////////////////////////////////////////////////////////////
class NS_GUI_ANIMATION_API DiscreteObjectKeyFrame final: public ObjectKeyFrame
{
public:
    // Hides Freezable methods for convenience
    //@{
    Ptr<DiscreteObjectKeyFrame> Clone() const;
    Ptr<DiscreteObjectKeyFrame> CloneCurrentValue() const;
    //@}

protected:
    /// From Freezable
    //@{
    Ptr<Freezable> CreateInstanceCore() const override;
    //@}

    /// From KeyFrame
    //@{
    BaseComponent* InterpolateValueCore(BaseComponent* baseValue, float keyFrameProgress) override;
    //@}

    NS_DECLARE_REFLECTION(DiscreteObjectKeyFrame, ObjectKeyFrame)
};

}


#endif