base/dali-toolkit/internal/controls/scrollable/bouncing-effect-actor.h

   1 #ifndef __DALI_TOOLKIT_INTERNAL_BOUNCING_EFFECT_ACTOR_H__
   2 #define __DALI_TOOLKIT_INTERNAL_BOUNCING_EFFECT_ACTOR_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/actors/actor.h>
  23 #include <dali/public-api/object/property.h>
  24
  25 namespace Dali
  26 {
  27
  28 namespace Toolkit
  29 {
  30
  31 namespace Internal
  32 {
  33
  34 /**
  35  * @brief Creates a Dali::Actor to display the bouncing effect for overshoot
  36  *
  37  * Usage example:
  38  * @code
  39  *  // create the actor and get the property index for animation
  40  *  Property::Index bouncePropertyIndex = Property::INVALID_INDEX;
  41  *  Actor bounceActor = CreateBouncingEffectActor( bouncePropertyIndex );
  42
  43  *  // set size and color
  44  *  bounceActor.SetSize(720.f, 42.f );
  45  *  bounceActor.SetColor( Vector4( 0.0,0.64f,0.85f,0.25f ) );
  46  *
  47  *  // add to stage
  48  *  bounceActor.SetParentOrigin(ParentOrigin::CENTER);
  49  *  Stage::GetCurrent().Add(bounceActor);
  50
  51  *  // start the bouncing animation
  52  *  Animation anim = Animation::New(2.0f);
  53  *  anim.AnimateTo( Property( bounceActor, bouncePropertyIndex ), 1.f, AlphaFunctions::Sin );
  54  *  anim.Play();
  55  * @endcode
  56  *
  57  * @param[out] bouncePropertyIndex The property index which controls the bouncing
  58  * @return The actor which displays the bouncing effect
  59  */
  60 Actor CreateBouncingEffectActor( Property::Index& bouncePropertyIndex);
  61
  62 } // namespace Internal
  63
  64 } // namespace Toolkit
  65
  66 } // namespace Dali
  67
  68
  69 #endif /* __DALI_TOOLKIT_INTERNAL_BOUNCING_EFFECT_ACTOR_H__ */