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) 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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/actors/camera-actor.h>
  23 #include <dali/public-api/common/stage.h>
  24 #include <dali/public-api/images/frame-buffer-image.h>
  25 #include <dali/public-api/render-tasks/render-task.h>
  26 #include <dali/devel-api/object/property-buffer.h>
  27 #include <dali/devel-api/rendering/geometry.h>
  28 #include <dali/devel-api/rendering/renderer.h>
  29 #include <dali/devel-api/rendering/sampler.h>
  30 #include <dali/devel-api/rendering/shader.h>
  31
  32 // INTERNAL INCLUDES
  33 #include <dali-toolkit/public-api/controls/control-impl.h>
  34 #include <dali-toolkit/devel-api/controls/bubble-effect/bubble-emitter.h>
  35
  36 namespace Dali
  37 {
  38
  39 namespace Toolkit
  40 {
  41
  42 namespace Internal
  43 {
  44
  45 class BubbleActor;
  46 typedef IntrusivePtr<BubbleActor> BubbleActorPtr;
  47
  48 /**
  49  * BubbleEmitter implementation class.
  50  */
  51 class BubbleEmitter : public Control
  52 {
  53 public:
  54
  55   /**
  56    * Destructor
  57    */
  58   ~BubbleEmitter();
  59
  60   /**
  61    * @copydoc Toolkit::BubbleEmitter::New
  62    */
  63   static Toolkit::BubbleEmitter New( const Vector2& winSize,
  64                                      Image shapeImage,
  65                                      unsigned int maximumNumberOfBubble,
  66                                      const Vector2& bubbleSizeRange );
  67
  68   /**
  69    * @copydoc Toolkit::BubbleEmitter::GetRootActor
  70    */
  71   Actor GetRootActor();
  72
  73   /**
  74    * @copydoc Toolkit::BubbleEmitter::SetBackground
  75    */
  76   void SetBackground( Image bgImage, const Vector3& hsvDelta );
  77
  78   /**
  79    * @copydoc Toolkit::BubbleEmitter::SetShapeImage
  80    */
  81   void SetShapeImage( Image shapeImage );
  82
  83   /**
  84    * @copydoc Toolkit::BubbleEmiter::SetBubbleScale
  85    */
  86   void SetBubbleScale( float scale );
  87
  88   /**
  89    * @copydoc Toolkit::BubbleEmitter::SetBubbleDensity
  90    */
  91   void SetBubbleDensity( unsigned int density );
  92
  93   /**
  94    * @copydoc Toolkit::BubbleEmitter::EmitBubble
  95    */
  96   void EmitBubble( Animation& animation, const Vector2& emitPosition, const Vector2& direction, const Vector2& displacement );
  97
  98   /**
  99    * @copydoc Toolkit::BubbleEmitter::Restore
 100    */
 101   void Restore();
 102
 103 private:
 104
 105   /**
 106    * Construct a new BubbleEmitter object.
 107    * @param[in] movementArea The size of the bubble moving area
 108    * @param[in] shapeImage The alpha channnel of this texture defines the bubble shape.
 109    * @param[in] maximumNumberOfBubble The maximum number of bubble needed.
 110    * @param[in] bubbleSizeRange The size range of the bubbles; x component is the minimal size, and y component is the maximum size.
 111    */
 112   BubbleEmitter( const Vector2& movementArea,
 113                  Image shapeImage,
 114                  unsigned int maximumNumberOfBubble,
 115                  const Vector2& bubbleSizeRange );
 116
 117   /**
 118    * This method is called after the CubeTransitionEffect has been initialized.
 119    * The meshActors and BubbleEffects are created here.
 120    */
 121   void OnInitialize();
 122
 123   /**
 124    * Create the geometry of a mesh.
 125    * @param[in] numOfPatch The triangle number in the mesh is 2*numOfPatch; two triangles for each bubble.
 126    * @return The mesh geometry.
 127    */
 128   Geometry CreateGeometry( unsigned int numOfPatch );
 129
 130   /**
 131    * Callback function of the finished signal of off-screen render task.
 132    * @param[in] source The render task used to create the color adjusted background image.
 133    */
 134   void OnRenderFinished(RenderTask& source);
 135
 136   /**
 137    * Callback function from Stage to tell us if the context has been regained.
 138    */
 139   void OnContextRegained();
 140
 141   /**
 142    * Set the uniform values to the shader effect to emit a bubble
 143    * @param[in] bubbleActor The BubbleActor to render the current bubble
 144    * @param[in] curUniform The index of the uniform array in the shader
 145    * @param[in] emitPosition The start position of the bubble movement.
 146    * @param[in] direction The direction used to constrain the bubble to move in an adjacent direction around it.
 147    * @param[in] displacement The displacement used to bound the moving distance of the bubble.
 148    */
 149   void SetBubbleParameter( BubbleActorPtr bubbleActor, unsigned int curUniform,
 150                            const Vector2& emitPosition, const Vector2& direction, const Vector2& displacement );
 151
 152 private:
 153
 154   Actor                       mBubbleRoot;          ///<The bubble root actor. Need to add it to stage to get the bubbles rendered.
 155   Image                       mShapeImage;          ///< The alpha channnel of this texture defines the bubble shape.
 156   Image                       mBackgroundImage;     ///< The original background image
 157   FrameBufferImage            mEffectImage;         ///< The image stores the adjusted color of the background image.The bubbles pick color from this image.
 158   CameraActor                 mCameraActor;         ///< The render task views the scene from the perspective of this actor.
 159
 160   Geometry                    mMeshGeometry;         ///< The mesh geometry which contains the vertices and indices data
 161   TextureSet                  mTextureSet;           ///< The texture set which controls the bubble display
 162   std::vector<BubbleActorPtr> mBubbleActors;         ///< The meshActor vector, its size is mNumShader.
 163
 164   Vector2                     mMovementArea;        ///< The size of the bubble moving area, usually the same size as the background image actor.
 165   Vector2                     mBubbleSizeRange;     ///< The size range of the bubbles; x component is the low bound, and y component is the up bound.
 166   Vector3                     mHSVDelta;            ///< The HSV difference used to adjust the background image color.
 167
 168   unsigned int                mNumBubblePerActor;   ///< How many bubbles for each BubbleActor.
 169   unsigned int                mNumActor;            ///< How many BubbleActors are used.
 170   unsigned int                mDensity;             ///< How many bubbles will emit at each time, they are controlled by same uniforms in the shader.
 171   unsigned int                mTotalNumOfBubble;    ///< mNumBubblePerShader*mNumShader.
 172   unsigned int                mCurrentBubble;       ///< Keep track of the index for the newly emitted bubble
 173   unsigned int                mRandomSeed;          ///< Seed to generate random number.
 174
 175   bool                        mRenderTaskRunning;   ///< If the background render task is currently running
 176
 177 };
 178
 179 } // namespace Internal
 180
 181 // Helpers for public-api forwarding methods
 182 inline Internal::BubbleEmitter& GetImpl(Dali::Toolkit::BubbleEmitter& obj)
 183 {
 184   DALI_ASSERT_ALWAYS(obj && "BubbleEmitter handle is empty");
 185   Dali::RefObject& handle = obj.GetImplementation();
 186   return static_cast<Toolkit::Internal::BubbleEmitter&>(handle);
 187 }
 188
 189 inline const Internal::BubbleEmitter& GetImpl(const Dali::Toolkit::BubbleEmitter& obj)
 190 {
 191   DALI_ASSERT_ALWAYS(obj && "BubbleEmitter handle is empty");
 192   const Dali::RefObject& handle = obj.GetImplementation();
 193   return static_cast<const Toolkit::Internal::BubbleEmitter&>(handle);
 194 }
 195
 196 } // namespace Toolkit
 197
 198 } // namespace Dali
 199
 200 #endif /* __DALI_TOOLKIT_INTERNAL_BUBBLE_EMITTER_IMPL_H__ */