urho3d/Engine/Graphics/AnimationController.h

//
// Urho3D Engine
// Copyright (c) 2008-2011 Lasse Öörni
//
// 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 "Component.h"

class AnimatedModel;
class Animation;
class AnimationState;
struct Bone;

/// Control data for an animation
struct AnimationControl
{
    /// Construct with defaults
    AnimationControl() :
        speed_(1.0f),
        targetWeight_(0.0f),
        fadeTime_(0.0f),
        autoFadeTime_(0.0f),
        setTimeTtl_(0.0f),
        setWeightTtl_(0.0f),
        setTime_(0),
        setWeight_(0),
        setTimeRev_(0),
        setWeightRev_(0)
    {
    }

    /// Animation resource name hash
    StringHash hash_;
    /// Animation speed
    float speed_;
    /// Animation target weight
    float targetWeight_;
    /// Animation weight fade time, 0 if no fade
    float fadeTime_;
    /// Animation autofade on stop -time, 0 if disabled
    float autoFadeTime_;
    /// Set time command time-to-live
    float setTimeTtl_;
    /// Set weight command time-to-live
    float setWeightTtl_;
    /// Set time command
    unsigned short setTime_;
    /// Set weight command
    unsigned char setWeight_;
    /// Set time command revision
    unsigned char setTimeRev_;
    /// Set weight command revision
    unsigned char setWeightRev_;
};

/// Component that drives an AnimatedModel's animations
class AnimationController : public Component
{
    OBJECT(AnimationController);

public:
    /// Construct
    AnimationController(Context* context);
    /// Destruct
    virtual ~AnimationController();
    /// Register object factory
    static void RegisterObject(Context* context);
    
    /// Update the animations. Is called from HandleScenePostUpdate()
    void Update(float timeStep);
    /// Play an animation and set full target weight. Name must be the full resource name. Return true on success
    bool Play(const String& name, unsigned char layer, bool looped, float fadeInTime = 0.0f);
    /// Play an animation, set full target weight and fade out all other animations on the same layer. Name must be the full resource name. Return true on success
    bool PlayExclusive(const String& name, unsigned char layer, bool looped, float fadeTime = 0.0f);
    /// Stop an animation. Zero fadetime is instant. Return true on success
    bool Stop(const String& name, float fadeOutTime = 0.0f);
    /// Stop all animations on a specific layer. Zero fadetime is instant
    void StopLayer(unsigned char layer, float fadeOutTime = 0.0f);
    /// Stop all animations. Zero fadetime is instant
    void StopAll(float fadeTime = 0.0f);
    /// Fade animation to target weight. Return true on success
    bool Fade(const String& name, float targetWeight, float fadeTime);
    /// Fade other animations on the same layer to target weight. Return true on success
    bool FadeOthers(const String& name, float targetWeight, float fadeTime);
    
    /// Set animation blending layer priority. Return true on success
    bool SetLayer(const String& name, unsigned char layer);
    /// Set animation start bone. Return true on success
    bool SetStartBone(const String& name, const String& startBoneName);
    /// Set animation time position. Return true on success
    bool SetTime(const String& name, float time);
    /// Set animation weight. Return true on success
    bool SetWeight(const String& name, float weight);
    /// Set animation looping. Return true on success
    bool SetLooped(const String& name, bool enable);
    /// Set animation speed. Return true on success
    bool SetSpeed(const String& name, float speed);
    /// Set animation autofade on stop (non-looped animations only.) Zero time disables. Return true on success
    bool SetAutoFade(const String& name, float fadeOutTime);
    
    /// Return whether an animation is active
    bool IsPlaying(const String& name) const;
    /// Return whether an animation is fading in
    bool IsFadingIn(const String& name) const;
    /// Return whether an animation is fading out
    bool IsFadingOut(const String& name) const;
    /// Return animation blending layer
    unsigned char GetLayer(const String& name) const;
    /// Return animation start bone, or null if no such animation
    Bone* GetStartBone(const String& name) const;
    /// Return animation start bone name, or null if no such animation
    const String& GetStartBoneName(const String& name) const;
    /// Return animation time position
    float GetTime(const String& name) const;
    /// Return animation weight
    float GetWeight(const String& name) const;
    /// Return animation looping
    bool IsLooped(const String& name) const;
    /// Return animation length
    float GetLength(const String& name) const;
    /// Return animation speed
    float GetSpeed(const String& name) const;
    /// Return animation fade target weight
    float GetFadeTarget(const String& name) const;
    /// Return animation fade time
    float GetFadeTime(const String& name) const;
    /// Return animation autofade time
    float GetAutoFade(const String& name) const;
    
    /// Set animations attribute
    void SetAnimationsAttr(const PODVector<unsigned char>& value);
    /// Set network animations attribute
    void SetNetAnimationsAttr(const PODVector<unsigned char>& value);
    /// Return animations attribute
    const PODVector<unsigned char>& GetAnimationsAttr() const;
    /// Return net animations attribute
    const PODVector<unsigned char>& GetNetAnimationsAttr() const;
    
protected:
    /// Handle node being assigned
    virtual void OnNodeSet(Node* node);
    
private:
    /// Find the internal index and animation state of an animation
    void FindAnimation(const String& name, unsigned& index, AnimationState*& state) const;
    /// Find the animation state only
    AnimationState* FindAnimationState(const String& name) const;
    /// Handle scene post-update event
    void HandleScenePostUpdate(StringHash eventType, VariantMap& eventData);
    
    /// Controlled animations
    Vector<AnimationControl> animations_;
    /// Attribute buffer for network replication
    mutable VectorBuffer attrBuffer_;
};