/*
 * Copyright (C) 2006 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once
#include <animation/SAnimation.h>

SNSBEGIN
/**
 * An animation that controls the alpha level of an object.
 * Useful for fading things in and out. This animation ends up
 * changing the alpha property of a {@link STransformation}
 *
 */
class SOUI_EXP SAlphaAnimation : public SAnimation {
    DEF_SOBJECT(SAnimation, L"alpha")
  private:
    float mFromAlpha;
    float mToAlpha;

  public:
    SOUI_ATTRS_BEGIN()
        ATTR_FLOAT(L"fromAlpha", mFromAlpha, FALSE)
        ATTR_FLOAT(L"toAlpha", mToAlpha, FALSE)
    SOUI_ATTRS_END()
    /**
     * Constructor to use when building an AlphaAnimation from code
     *
     * @param fromAlpha Starting alpha value for the animation, where 1.0 means
     *        fully opaque and 0.0 means fully transparent.
     * @param toAlpha Ending alpha value for the animation.
     */
  public:
    SAlphaAnimation();

    void init(float fromAlpha = 0.0f, float toAlpha = 0.0f);

  protected:
    /**
     * Changes the alpha property of the supplied {@link STransformation}
     */
    STDMETHOD_(void, applyTransformation)
    (THIS_ float interpolatedTime, ITransformation *t) OVERRIDE;

    STDMETHOD_(void, copy)(THIS_ const IAnimation *src) OVERRIDE;

  public:
    /**
     * @hide
     */
    STDMETHOD_(BOOL, hasAlpha)(THIS) SCONST OVERRIDE;
};

SNSEND
