optional/dali-toolkit/internal/controls/bubble-effect/bubble-emitter-impl.h

   1 #ifndef __DALI_TOOLKIT_INTERNAL_BUBBLE_EMITTER_IMPL_H__
   2 #define __DALI_TOOLKIT_INTERNAL_BUBBLE_EMITTER_IMPL_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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/actors/camera-actor.h>
  23 #include <dali/public-api/actors/image-actor.h>
  24 #include <dali/public-api/actors/mesh-actor.h>
  25 #include <dali/public-api/common/stage.h>
  26 #include <dali/public-api/images/frame-buffer-image.h>
  27 #include <dali/public-api/geometry/mesh.h>
  28 #include <dali/public-api/render-tasks/render-task.h>
  29
  30 // INTERNAL INCLUDES
  31 #include <dali-toolkit/public-api/controls/control-impl.h>
  32 #include <dali-toolkit/public-api/controls/bubble-effect/bubble-emitter.h>
  33 #include <dali-toolkit/public-api/shader-effects/bubble-effect/bubble-effect.h>
  34
  35 #include <map>
  36
  37 namespace Dali
  38 {
  39
  40 namespace Toolkit
  41 {
  42
  43 namespace Internal
  44 {
  45
  46 /**
  47  * BubbleEmitter implementation class.
  48  */
  49 class BubbleEmitter : public Control
  50 {
  51 public:
  52
  53   /**
  54    * Destructor
  55    */
  56   ~BubbleEmitter();
  57
  58   /**
  59    * @copydoc Toolkit::BubbleEmitter::New
  60    */
  61   static Toolkit::BubbleEmitter New( const Vector2& winSize,
  62                                      Image shapeImage,
  63                                      unsigned int maximumNumberOfBubble,
  64                                      const Vector2& bubbleSizeRange );
  65
  66   /**
  67    * @copydoc Toolkit::BubbleEmitter::GetRootActor
  68    */
  69   Actor GetRootActor();
  70
  71   /**
  72    * @copydoc Toolkit::BubbleEmitter::SetBackground
  73    */
  74   void SetBackground( Image bgImage, const Vector3& hsvDelta );
  75
  76   /**
  77    * @copydoc Toolkit::BubbleEmitter::SetShapeImage
  78    */
  79   void SetShapeImage( Image shapeImage );
  80
  81   /**
  82    * @copydoc Toolkit::BubbleEmiter::SetBubbleScale
  83    */
  84   void SetBubbleScale( float scale );
  85
  86   /**
  87    * @copydoc Toolkit::BubbleEmitter::SetBubbleDensity
  88    */
  89   void SetBubbleDensity( unsigned int density );
  90
  91   /**
  92    * @copydoc Toolkit::BubbleEmitter::SetBlendMode
  93    */
  94   void SetBlendMode( bool enable );
  95
  96   /**
  97    * @copydoc Toolkit::BubbleEmitter::EmitBubble
  98    */
  99   void EmitBubble( Animation& animation, const Vector2& emitPosition, const Vector2& direction, const Vector2& displacement );
 100
 101   /**
 102    * @copydoc Toolkit::BubbleEmitter::StartExplosion
 103    */
 104   void StartExplosion( float duration, float multiple );
 105
 106   /**
 107    * @copydoc Toolkit::BubbleEmitter::Restore
 108    */
 109   void Restore();
 110
 111 private:
 112
 113   /**
 114    * Construct a new BubbleEmitter object.
 115    * @param[in] movementArea The size of the bubble moving area
 116    * @param[in] shapeImage The alpha channnel of this texture defines the bubble shape.
 117    * @param[in] maximumNumberOfBubble The maximum number of bubble needed.
 118    * @param[in] bubbleSizeRange The size range of the bubbles; x component is the minimal size, and y component is the maximum size.
 119    */
 120   BubbleEmitter( const Vector2& movementArea,
 121                  Image shapeImage,
 122                  unsigned int maximumNumberOfBubble,
 123                  const Vector2& bubbleSizeRange );
 124
 125   /**
 126    * This method is called after the CubeTransitionEffect has been initialized.
 127    * The meshActors and BubbleEffects are created here.
 128    */
 129   void OnInitialize();
 130
 131   /**
 132    * Callback function of the finished signal of off-screen render task.
 133    * @param[in] source The render task used to create the color adjusted background image.
 134    */
 135   void OnRenderFinished(RenderTask& source);
 136
 137   /**
 138    * Generate the material object which is attached to the meshActor to describe its color, texture, texture mapping mode etc.
 139    */
 140   void GenMaterial();
 141
 142   /**
 143    * Add a vertex to the mesh data.
 144    * @param[in] vertices The collection of vertices.
 145    * @param[in] XYZ The vertex position coordinates.
 146    * @param[in] UV The vertex texture coordinate.
 147    */
 148   void AddVertex(MeshData::VertexContainer& vertices, Vector3 XYZ, Vector2 UV);
 149
 150   /**
 151    * Add a triangle to the mesh data.
 152    * @param[in] faces The collection od FaceIndex items.
 153    * @param[in] v0 The index of the first point of the triangle.
 154    * @param[in] v1 The index of the second point of the triangle.
 155    * @param[in] v3 The index of the first point of the triangle.
 156    */
 157   void AddTriangle(MeshData::FaceIndices& faces,size_t v0, size_t v1, size_t v2);
 158
 159   /**
 160    * Create a new mesh.
 161    * @param[in] meshData The MeshData object which encompasses all the data required to describe and render the 3D mesh.
 162    * @param[in] numberOfBubble The triangle number in the meshData is 2*numOfBubble; two triangles for each bubble
 163    */
 164   void ConstructBubbleMesh( MeshData& meshData, unsigned int numOfBubble);
 165
 166   /**
 167    * Set the uniform values to the shader effect to emit a bubble
 168    * @param[in] effect The BubbleEffect to render the current bubble
 169    * @param[in] curUniform The index of the uniform array in the shader
 170    * @param[in] emitPosition The start position of the bubble movement.
 171    * @param[in] displacement The displacement used to bound the moving distance of the bubble.
 172    */
 173   void SetBubbleParameter( BubbleEffect& effect, unsigned int curUniform,
 174                            const Vector2& emitPosition, const Vector2& displacement );
 175
 176   /**
 177    * Set the uniform values to the shader effect to emit a bubble
 178    * @param[in] effect The BubbleEffect to render the current bubble
 179    * @param[in] curUniform The index of the uniform array in the shader
 180    * @param[in] emitPosition The start position of the bubble movement.
 181    * @param[in] direction The direction used to constrain the bubble to move in an adjacent direction around it.
 182    * @param[in] displacement The displacement used to bound the moving distance of the bubble.
 183    */
 184   void SetBubbleParameter( BubbleEffect& effect, unsigned int curUniform,
 185                            const Vector2& emitPosition, const Vector2& direction, const Vector2& displacement );
 186
 187   /**
 188    * Callback function of the explosion animation finished signal to reset the shader parameters
 189    * @param[in] source The explosion animation.
 190    */
 191   void OnExplosionFinished( Animation& source );
 192
 193   /**
 194    * Return a random value between the given interval.
 195    * @param[in] f0 The low bound
 196    * @param[in] f1 The up bound
 197    * @return A random value between the given interval
 198    */
 199   float RandomRange(float f0, float f1);
 200
 201 private:
 202
 203   Vector2                     mMovementArea;        ///< The size of the bubble moving area, usually the same size as the background image actor.
 204   Image                       mShapeImage;          ///< The alpha channnel of this texture defines the bubble shape.
 205   Actor                       mBubbleRoot;          ///<The bubble root actor. Need to add it to stage to get the bubbles rendered.
 206
 207   unsigned int                mNumBubblePerShader;  ///< How many bubbles for each BubbleEffect shader.
 208   unsigned int                mNumShader;           ///< How many BubbleEffect shaders are used.
 209   unsigned int                mTotalNumOfBubble;    ///< mNumBubblePerShader*mNumShader.
 210   Vector2                     mBubbleSizeRange;     ///< The bubble size range.
 211
 212   std::vector<Mesh>           mMesh;                ///< The mesh vector, each mesh is used to create a meshActor which applies a BubbleEffect.
 213   std::vector<MeshActor>      mMeshActor;           ///< The meshActor vector, its size is mNumShader.
 214   MeshActor                   mMeshActorForNoise;   ///< An Extra mesh data to emit bubbles which emit bubble in totally random angle.
 215   Material                    mCustomMaterial;      ///< The material object which is attached to the meshActor to describe its color, texture, texture mapping mode etc.
 216
 217   std::vector<BubbleEffect>   mEffect;              ///< The bubbleEffect vector, corresponding to the mMeshActoe vector.
 218   BubbleEffect                mEffectForNoise;      ///< The extra bubbleEffect, corresponding to the mMeshActorForNoise.
 219
 220   unsigned int                mCurrentUniform;      ///< Keep track of the uniform index for the newly emitted bubble
 221
 222   FrameBufferImage            mEffectImage;         ///< The image stores the adjusted color of the background image.The bubbles pick color from this image.
 223   CameraActor                 mCameraActor;         ///< The render task views the scene from the perspective of this actor.
 224
 225   unsigned int                mDensity;             ///< How many bubbles will emit at each time, they are controlled by same uniforms in the shader.
 226
 227 };
 228
 229 } // namespace Internal
 230
 231 // Helpers for public-api forwarding methods
 232 inline Internal::BubbleEmitter& GetImpl(Dali::Toolkit::BubbleEmitter& obj)
 233 {
 234   DALI_ASSERT_ALWAYS(obj && "BubbleEmitter handle is empty");
 235   Dali::RefObject& handle = obj.GetImplementation();
 236   return static_cast<Toolkit::Internal::BubbleEmitter&>(handle);
 237 }
 238
 239 inline const Internal::BubbleEmitter& GetImpl(const Dali::Toolkit::BubbleEmitter& obj)
 240 {
 241   DALI_ASSERT_ALWAYS(obj && "BubbleEmitter handle is empty");
 242   const Dali::RefObject& handle = obj.GetImplementation();
 243   return static_cast<const Toolkit::Internal::BubbleEmitter&>(handle);
 244 }
 245
 246 } // namespace Toolkit
 247
 248 } // namespace Dali
 249
 250 #endif /* __DALI_TOOLKIT_INTERNAL_BUBBLE_EMITTER_IMPL_H__ */