urho3d/Source/Engine/Scene/AttributeAnimation.h

//
// Copyright (c) 2008-2014 the Urho3D project.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//

#pragma once

#include "Serializable.h"
#include "Variant.h"

namespace Urho3D
{

class SceneObject;

/// Animation mode.
enum AnimationMode
{
    /// Loop mode.
    AM_LOOP = 0,
    /// Clamp mode.
    AM_CLAMP,
    /// Pingpong Mode.
    AM_PINGPONG,
};

/// Base class for attribute animation.
class URHO3D_API AttributeAnimation : public Serializable
{
    OBJECT(AttributeAnimation);

public:
    /// Construct.
    AttributeAnimation(Context* context);
    /// Destruct.
    virtual ~AttributeAnimation();

    /// Set animation mode.
    void SetAnimationMode(AnimationMode animationMode_);
    /// Add key frame (please add in order).
    void AddKeyFrame(float time, const Variant& value);

    /// Return value type.
    VariantType GetValueType() const;
    /// Return Animation mode.
    AnimationMode GetAnimationMode() const { return animationMode_; }
    /// Get value by animation time.
    void GetValue(float animationTime, Variant& animationValue) const;

protected:
    /// Calculate time according to the animation mode.
    float CalculateTime(float animationTime, float totalTime) const;

    /// Animation mode.
    AnimationMode animationMode_;

    /// Key frame
    struct KeyFrame
    {
        /// Time.
        float time_;
        /// Value.
        Variant value_;
    };
    /// Key frames.
    Vector<KeyFrame> keyframes_;
    

};

}