urho3d/Source/Engine/Urho2D/XAnimatedSprite2D.cpp

//
// 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.
//

#include "Precompiled.h"
#include "Context.h"
#include "ResourceCache.h"
#include "Scene.h"
#include "SceneEvents.h"
#include "Sprite2D.h"
#include "StaticSprite2D.h"
#include "XAnimatedSprite2D.h"
#include "XAnimation2D.h"
#include "XAnimationSet2D.h"

#include "DebugNew.h"

namespace Urho3D
{

extern const char* URHO2D_CATEGORY;
extern const char* blendModeNames[];

XAnimatedSprite2D::XAnimatedSprite2D(Context* context) :
    Drawable(context, DRAWABLE_GEOMETRY),
    layer_(0),
    orderInLayer_(0),
    blendMode_(BLEND_ALPHA),
    speed_(1.0f),
    animationTime_(0.0f)
{
}

XAnimatedSprite2D::~XAnimatedSprite2D()
{
}

void XAnimatedSprite2D::RegisterObject(Context* context)
{
    context->RegisterFactory<XAnimatedSprite2D>(URHO2D_CATEGORY);
    ACCESSOR_ATTRIBUTE(XAnimatedSprite2D, VAR_INT, "Layer", GetLayer, SetLayer, int, 0, AM_DEFAULT);
    ACCESSOR_ATTRIBUTE(XAnimatedSprite2D, VAR_INT, "Order in Layer", GetOrderInLayer, SetOrderInLayer, int, 0, AM_DEFAULT);
    ENUM_ACCESSOR_ATTRIBUTE(XAnimatedSprite2D, "Blend Mode", GetBlendMode, SetBlendMode, BlendMode, blendModeNames, BLEND_ALPHA, AM_DEFAULT);
    ACCESSOR_ATTRIBUTE(XAnimatedSprite2D, VAR_FLOAT, "Speed", GetSpeed, SetSpeed, float, 1.0f, AM_DEFAULT);
    ACCESSOR_ATTRIBUTE(XAnimatedSprite2D, VAR_RESOURCEREF, "Animation Set", GetAnimationSetAttr, SetAnimationSetAttr, ResourceRef, ResourceRef(XAnimatedSprite2D::GetTypeStatic()), AM_DEFAULT);
    REF_ACCESSOR_ATTRIBUTE(XAnimatedSprite2D, VAR_STRING, "Animation", GetAnimation, SetAnimation, String, String::EMPTY, AM_DEFAULT);
    COPY_BASE_ATTRIBUTES(Drawable2D, Drawable);
}

void XAnimatedSprite2D::OnSetEnabled()
{
    Drawable::OnSetEnabled();

    Scene* scene = GetScene();
    if (scene)
    {
        if (IsEnabledEffective())
            SubscribeToEvent(scene, E_SCENEPOSTUPDATE, HANDLER(XAnimatedSprite2D, HandleScenePostUpdate));
        else
            UnsubscribeFromEvent(scene, E_SCENEPOSTUPDATE);
    }
}

void XAnimatedSprite2D::SetLayer(int layer)
{
    if (layer == layer_)
        return;

    layer_ = layer;

    for (unsigned i = 0; i < objectNodes_.Size(); ++i)
    {
        StaticSprite2D* objectSprite = objectNodes_[i]->GetComponent<StaticSprite2D>();
        objectSprite->SetLayer(layer_);
    }
}

void XAnimatedSprite2D::SetOrderInLayer(int orderInLayer)
{
    orderInLayer_ = orderInLayer;
}

void XAnimatedSprite2D::SetBlendMode(BlendMode blendMode)
{
    if (blendMode == blendMode_)
        return;

    blendMode_ = blendMode;

    for (unsigned i = 0; i < objectNodes_.Size(); ++i)
    {
        StaticSprite2D* objectSprite = objectNodes_[i]->GetComponent<StaticSprite2D>();
        objectSprite->SetBlendMode(blendMode_);
    }
}

void XAnimatedSprite2D::SetSpeed(float speed)
{
    speed_ = speed;
    MarkNetworkUpdate();
}

void XAnimatedSprite2D::SetAnimation(XAnimationSet2D* animationSet, const String& name)
{
    animationSet_ = animationSet;
    animationName_ = name;
    
    if (animationSet)
        SetAnimation(animationSet->GetAnimation(name));
    else
        SetAnimation(0);
}

void XAnimatedSprite2D::SetAnimationSet(XAnimationSet2D* animationSet)
{
    if (animationSet == animationSet_)
        return;

    animationSet_ = animationSet;

    if (animationSet_)
        SetAnimation(animationSet_->GetAnimation(animationName_));
    else
        SetAnimation(0);

}
void XAnimatedSprite2D::SetAnimation(const String& name)
{
    animationName_ = name;

    if (animationSet_)
        SetAnimation(animationSet_->GetAnimation(animationName_));
}

XAnimationSet2D* XAnimatedSprite2D::GetAnimationSet() const
{
    return animationSet_;
}


void XAnimatedSprite2D::SetAnimationSetAttr(ResourceRef value)
{
    ResourceCache* cache = GetSubsystem<ResourceCache>();
    SetAnimationSet(cache->GetResource<XAnimationSet2D>(value.name_));
}

Urho3D::ResourceRef XAnimatedSprite2D::GetAnimationSetAttr() const
{
    return GetResourceRef(animationSet_, XAnimationSet2D::GetTypeStatic());
}

void XAnimatedSprite2D::OnNodeSet(Node* node)
{
    Drawable::OnNodeSet(node);

    if (node)
    {
        Scene* scene = GetScene();
        if (scene && IsEnabledEffective())
            SubscribeToEvent(scene, E_SCENEPOSTUPDATE, HANDLER(XAnimatedSprite2D, HandleScenePostUpdate));
    }
}

void XAnimatedSprite2D::OnWorldBoundingBoxUpdate()
{
    boundingBox_.Clear();
    worldBoundingBox_.Clear();

    for (unsigned i = 0; i < objectNodes_.Size(); ++i)
    {
        StaticSprite2D* ss = objectNodes_[i]->GetComponent<StaticSprite2D>();
        worldBoundingBox_.Merge(ss->GetWorldBoundingBox());
    }

    boundingBox_ = worldBoundingBox_.Transformed(node_->GetWorldTransform().Inverse());
}



void XAnimatedSprite2D::SetAnimation(XAnimation2D* animation)
{
    if (animation == animation_)
    {
        // Reset time
        animationTime_ = 0.0f;
        return;
    }

    if (animation_)
    {
        // Remove all object nodes
        for (unsigned i = 0; i < objectNodes_.Size(); ++i)
            objectNodes_[i]->Remove();
        objectNodes_.Clear();
    }

    animation_ = animation;

    if (!animation_)
        return;

    animationTime_ = 0.0f;

    for (unsigned i = 0; i < animation_->GetTimelines().Size(); ++i)
    {
        SharedPtr<Node> objectNode(GetNode()->CreateChild(animation_->GetTimelines()[i].name_));

        StaticSprite2D* staticSprite = objectNode->CreateComponent<StaticSprite2D>();
        staticSprite->SetLayer(layer_);
        staticSprite->SetBlendMode(blendMode_);
        staticSprite->SetUseHotSpot(true);

        objectNodes_.Push(objectNode);        
    }

    UpdateAnimation(0.0f);

    MarkNetworkUpdate();
}

void XAnimatedSprite2D::UpdateAnimation(float timeStep)
{
    if (!animation_)
        return;
    
    animationTime_ += timeStep * speed_;

    float animtationLength = animation_->GetLength();
    float time;

    if (animation_->IsLooped())
    {
        time = fmodf(animationTime_, animtationLength);
        if (time < 0.0f)
            time += animation_->GetLength();
    }
    else
        time = Clamp(animationTime_, 0.0f, animtationLength);

    const Vector<MainlineKey>& mainlineKeys = animation_->GetMainlineKeys();
    const MainlineKey* mainlineKey = 0;
    for (unsigned i = 1; i < mainlineKeys.Size(); ++i)
    {
        if (time < mainlineKeys[i].time_)
        {
            mainlineKey = &mainlineKeys[i - 1];
            break;
        }
    }

    if (!mainlineKey)
        mainlineKey = &mainlineKeys.Back();

    const Vector<Timeline>& timelines = animation_->GetTimelines();
    for (unsigned i = 0; i < timelines.Size(); ++i)
    {
        Node* objectNode = objectNodes_[i];

        const ObjectRef* objectRef = mainlineKey->GetObjectRef(i);
        if (!objectRef)
            objectNode->SetEnabled(false);
        else
        {
            objectNode->SetEnabled(true);

            StaticSprite2D* staticSprite = objectNode->GetComponent<StaticSprite2D>();
            staticSprite->SetOrderInLayer(orderInLayer_ + objectRef->zIndex_);

            const Vector<ObjectKey>& objectKeys = timelines[i].objectKeys_;
            for (unsigned j = 0; j < objectKeys.Size() - 1; ++j)
            {
                if (time <= objectKeys[j + 1].time_)
                {
                    const ObjectKey& currKey = objectKeys[j];
                    const ObjectKey& nextKey = objectKeys[j + 1];

                    float t = (time - currKey.time_)  / (nextKey.time_ - currKey.time_);
                    if (t < 0.0f || t > 1.0f)
                    {
                        t = 0;
                    }
                    objectNode->SetPosition(currKey.position_.Lerp(nextKey.position_, t));

                    float angle;
                    if (currKey.spin_ > 0 && currKey.angle_ > nextKey.angle_)
                        angle = Lerp(currKey.angle_, nextKey.angle_ + 360.0f, t);
                    else if (currKey.spin_ < 0 && currKey.angle_ < nextKey.angle_)
                        angle = Lerp(currKey.angle_, nextKey.angle_ - 360.0f, t);
                    else
                        angle = Lerp(currKey.angle_, nextKey.angle_, t);
                    objectNode->SetRotation(angle);

                    objectNode->SetScale(currKey.scale_.Lerp(nextKey.scale_, t));

                    staticSprite->SetSprite(currKey.sprite_);
                    staticSprite->SetHotSpot(currKey.pivot_.Lerp(nextKey.pivot_, t));
                    float alpha_ = Lerp(currKey.alpha_, nextKey.alpha_, t);
                    staticSprite->SetColor(Color(1.0f, 1.0f, 1.0f, alpha_));

                    break;
                }
            }
        }       
    }

    MarkForUpdate();
}

void XAnimatedSprite2D::HandleScenePostUpdate(StringHash eventType, VariantMap& eventData)
{
    using namespace ScenePostUpdate;
    float timeStep = eventData[P_TIMESTEP].GetFloat();
    UpdateAnimation(timeStep);
}

}