dali-toolkit/internal/controls/bubble-effect/bubble-actor.h

   1 #ifndef __DALI_TOOLKIT_INTERNAL_BUBBLE_ACTOR_H_
   2 #define __DALI_TOOLKIT_INTERNAL_BUBBLE_ACTOR_H_
   3
   4 /*
   5  * Copyright (c) 2015 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 #include <dali/public-api/actors/actor.h>
  22 #include <dali/public-api/actors/renderer.h>
  23 #include <dali/public-api/object/property-buffer.h>
  24 #include <dali/public-api/object/property-map.h>
  25 #include <dali/public-api/shader-effects/material.h>
  26
  27 namespace Dali
  28 {
  29
  30 namespace Toolkit
  31 {
  32
  33 namespace Internal
  34 {
  35
  36 /**
  37  * BubbleActor is a group of bubbles.Each bubble can be moved separately.
  38  * Its custom shader achieves similar effect of particle system by applying on a specially created mesh
  39  * Each bubble is rendered on a patch with two triangles; and each mesh can contain multiple such patches, thus a group.
  40  */
  41 class BubbleActor : public RefObject
  42 {
  43 public:
  44
  45   /**
  46    * Constructor
  47    * @param[in] numberOfBubble How many groups of uniforms are used to control the bubble movement.
  48    * Note: Limited by the maximum available uniforms, this parameter cannot be bigger than 100.
  49    * Ideally use one group of uniform to control one bubble.
  50    * If the num of patches in the MeshActor is more than groups of uniforms,
  51    * the uniform values will be shared by multiple bubbles. Allow up to 9 times.
  52    * @param[in] movementArea The size of the bubble moving area, usually the same size as the background image actor.
  53    * @return A newly allocated object.
  54    */
  55   BubbleActor( unsigned int numberOfBubble,
  56                const Vector2& movementArea);
  57
  58   /**
  59    * @brief Destructor
  60    */
  61   ~BubbleActor(){}
  62
  63   /**
  64    * Prepare for the rendering: create and add renderer, and register properties
  65    * @param[in] geometry The geometry to be used by the renderer
  66    * @param[in] material The material to be used by the renderer
  67    */
  68   void MakeRenderable( Geometry geometry, Material material  );
  69
  70   /**
  71    * Return the mesh actor which is used to display the bubbles
  72    */
  73   Actor GetMeshActor();
  74
  75   /**
  76    * Sets the geometry to be used by the renderer
  77    * @param[in] geometry The geometry to be used by the renderer
  78    */
  79   void SetGeometry( Geometry geometry );
  80
  81   /**
  82    * Set the bubble movement area for the BubbleEffect
  83    * @param[in] movementArea The size of bubble movement area; by default, it is the stage size
  84    */
  85   void SetMovementArea( const Vector2& movementArea );
  86
  87   /**
  88    * Set the start and end positions of the index-th bubble's movement.
  89    * @param[in] index Indicate which bubble these properties are applied on.
  90    * @param[in] startAndEndPosition The start and the end position of movement.
  91    */
  92   void SetStartAndEndPosition( unsigned int index, const Vector4& startAndEndPosition );
  93
  94   /**
  95    * Set the movement completed percentage of the index-th bubble.
  96    * The bubble will appear at start position when percentage equals to zero,
  97    * and disappear near end position (affected by gravity) when percentage equals to one.
  98    * This percentage property is used to animate the bubble movement.
  99    * @param[in] index Indicate which bubble this property is applied on.
 100    * @param[in] percentage Set the percentage property value ( between zero and one ).
 101    */
 102   void SetPercentage( unsigned int index, float percentage );
 103
 104   /**
 105    * Set the gravity applied to the y direction, which makes the bubbles no longer moving on a straight line.
 106    * @param[in] gravity The gravity on the y direction.
 107    */
 108   void SetGravity( float gravity );
 109
 110   /**
 111    * Set the scale factor applied to the bubbles
 112    * @param[in] scale The scale factor applied on all bubbles.
 113    */
 114   void SetDynamicScale( float scale );
 115
 116   /**
 117    * Get the idx-th percentage property.
 118    * @param[in] idx The percentage property index.
 119    * @return the idx-th percentage property.
 120    */
 121   Property GetPercentageProperty( unsigned int idx );
 122
 123   /**
 124    * Reset the uniform values to default.
 125    */
 126   void ResetProperties();
 127
 128 private:
 129
 130   Actor        mActor;
 131   Renderer     mRenderer;
 132
 133   Vector2      mMovementArea;      ///< The size of the bubble moving area, usually the same size as the background image actor.
 134
 135   //properties mapped as uniforms
 136   std::vector<Property::Index> mIndicesOffset;             ///< Indices of the properties mapping to uniform array 'uOffset'
 137   std::vector<Property::Index> mIndiceStartEndPos;         ///< Indices of the properties mapping to uniform array 'uStartAndEndPos'
 138   std::vector<Property::Index> mIndicesPercentage;         ///< Indices of the properties mapping to uniform array 'uPercentage'
 139   Property::Index              mIndexGravity;              ///< Index of the property mapping to uniform 'uGravity'
 140   Property::Index              mIndexDynamicScale;         ///< Index of the property mapping to uniform 'uDynamicScale'
 141   Property::Index              mIndexInvertedMovementArea; ///< Index of the property mapping to uniform 'uInvertedMovementArea'
 142
 143   unsigned int mNumBubble;  ///< How many groups of uniforms are used to control the bubble movement.
 144 };
 145
 146 } // namespace Internal
 147
 148 } // namespace Toolkit
 149
 150 } // namespace Dali
 151
 152 #endif /* __DALI_TOOLKIT_INTERNAL_BUBBLE_ACTOR_H_ */