1 #ifndef __DALI_TOOLKIT_INTERNAL_BUBBLE_EMITTER_IMPL_H__
2 #define __DALI_TOOLKIT_INTERNAL_BUBBLE_EMITTER_IMPL_H__
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/dali.h>
23 #include <dali-toolkit/public-api/controls/control-impl.h>
24 #include <dali-toolkit/public-api/controls/bubble-effect/bubble-emitter.h>
25 #include <dali-toolkit/public-api/shader-effects/bubble-effect/bubble-effect.h>
39 * BubbleEmitter implementation class.
41 class BubbleEmitter : public ControlImpl
51 * @copydoc Toolkit::BubbleEmitter::New
53 static Toolkit::BubbleEmitter New( const Vector2& winSize,
55 unsigned int maximumNumberOfBubble,
56 const Vector2& bubbleSizeRange );
59 * @copydoc Toolkit::BubbleEmitter::GetRootActor
64 * @copydoc Toolkit::BubbleEmitter::SetBackground
66 void SetBackground( Image bgImage, const Vector3& hsvDelta );
69 * @copydoc Toolkit::BubbleEmitter::SetShapeImage
71 void SetShapeImage( Image shapeImage );
74 * @copydoc Toolkit::BubbleEmiter::SetBubbleScale
76 void SetBubbleScale( float scale );
79 * @copydoc Toolkit::BubbleEmitter::SetBubbleDensity
81 void SetBubbleDensity( unsigned int density );
84 * @copydoc Toolkit::BubbleEmitter::SetBlendMode
86 void SetBlendMode( bool enable );
89 * @copydoc Toolkit::BubbleEmitter::EmitBubble
91 void EmitBubble( Animation& animation, const Vector2& emitPosition, const Vector2& direction, const Vector2& displacement );
94 * @copydoc Toolkit::BubbleEmitter::StartExplosion
96 void StartExplosion( float duration, float multiple );
99 * @copydoc Toolkit::BubbleEmitter::Restore
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.
112 BubbleEmitter( const Vector2& movementArea,
114 unsigned int maximumNumberOfBubble,
115 const Vector2& bubbleSizeRange );
118 * This method is called after the CubeTransitionEffect has been initialized.
119 * The meshActors and BubbleEffects are created here.
124 * Callback function of the finished signal of off-screen render task.
125 * @param[in] source The render task used to create the color adjusted background image.
127 void OnRenderFinished(RenderTask& source);
130 * Generate the material object which is attached to the meshActor to describe its color, texture, texture mapping mode etc.
135 * Add a vertex to the mesh data.
136 * @param[in] vertices The collection of vertices.
137 * @param[in] XYZ The vertex position coordinates.
138 * @param[in] UV The vertex texture coordinate.
140 void AddVertex(MeshData::VertexContainer& vertices, Vector3 XYZ, Vector2 UV);
143 * Add a triangle to the mesh data.
144 * @param[in] faces The collection od FaceIndex items.
145 * @param[in] v0 The index of the first point of the triangle.
146 * @param[in] v1 The index of the second point of the triangle.
147 * @param[in] v3 The index of the first point of the triangle.
149 void AddTriangle(MeshData::FaceIndices& faces,size_t v0, size_t v1, size_t v2);
153 * @param[in] meshData The MeshData object which encompasses all the data required to describe and render the 3D mesh.
154 * @param[in] numberOfBubble The triangle number in the meshData is 2*numOfBubble; two triangles for each bubble
156 void ConstructBubbleMesh( MeshData& meshData, unsigned int numOfBubble);
159 * Set the uniform values to the shader effect to emit a bubble
160 * @param[in] effect The BubbleEffect to render the current bubble
161 * @param[in] curUniform The index of the uniform array in the shader
162 * @param[in] emitPosition The start position of the bubble movement.
163 * @param[in] displacement The displacement used to bound the moving distance of the bubble.
165 void SetBubbleParameter( BubbleEffect& effect, unsigned int curUniform,
166 const Vector2& emitPosition, const Vector2& displacement );
169 * Set the uniform values to the shader effect to emit a bubble
170 * @param[in] effect The BubbleEffect to render the current bubble
171 * @param[in] curUniform The index of the uniform array in the shader
172 * @param[in] emitPosition The start position of the bubble movement.
173 * @param[in] direction The direction used to constrain the bubble to move in an adjacent direction around it.
174 * @param[in] displacement The displacement used to bound the moving distance of the bubble.
176 void SetBubbleParameter( BubbleEffect& effect, unsigned int curUniform,
177 const Vector2& emitPosition, const Vector2& direction, const Vector2& displacement );
180 * Callback function of the explosion animation finished signal to reset the shader parameters
181 * @param[in] source The explosion animation.
183 void OnExplosionFinished( Animation& source );
186 * Return a random value between the given interval.
187 * @param[in] f0 The low bound
188 * @param[in] f1 The up bound
189 * @return A random value between the given interval
191 float RandomRange(float f0, float f1);
195 Vector2 mMovementArea; ///< The size of the bubble moving area, usually the same size as the background image actor.
196 Image mShapeImage; ///< The alpha channnel of this texture defines the bubble shape.
197 Actor mBubbleRoot; ///<The bubble root actor. Need to add it to stage to get the bubbles rendered.
199 unsigned int mNumBubblePerShader; ///< How many bubbles for each BubbleEffect shader.
200 unsigned int mNumShader; ///< How many BubbleEffect shaders are used.
201 unsigned int mTotalNumOfBubble; ///< mNumBubblePerShader*mNumShader.
202 Vector2 mBubbleSizeRange; ///< The bubble size range.
204 std::vector<Mesh> mMesh; ///< The mesh vector, each mesh is used to create a meshActor which applies a BubbleEffect.
205 std::vector<MeshActor> mMeshActor; ///< The meshActor vector, its size is mNumShader.
206 MeshActor mMeshActorForNoise; ///< An Extra mesh data to emit bubbles which emit bubble in totally random angle.
207 Material mCustomMaterial; ///< The material object which is attached to the meshActor to describe its color, texture, texture mapping mode etc.
209 std::vector<BubbleEffect> mEffect; ///< The bubbleEffect vector, corresponding to the mMeshActoe vector.
210 BubbleEffect mEffectForNoise; ///< The extra bubbleEffect, corresponding to the mMeshActorForNoise.
212 unsigned int mCurrentUniform; ///< Keep track of the uniform index for the newly emitted bubble
214 FrameBufferImage mEffectImage; ///< The image stores the adjusted color of the background image.The bubbles pick color from this image.
215 CameraActor mCameraActor; ///< The render task views the scene from the perspective of this actor.
217 unsigned int mDensity; ///< How many bubbles will emit at each time, they are controlled by same uniforms in the shader.
221 } // namespace Internal
223 // Helpers for public-api forwarding methods
224 inline Internal::BubbleEmitter& GetImpl(Dali::Toolkit::BubbleEmitter& obj)
226 DALI_ASSERT_ALWAYS(obj && "BubbleEmitter handle is empty");
227 Dali::RefObject& handle = obj.GetImplementation();
228 return static_cast<Toolkit::Internal::BubbleEmitter&>(handle);
231 inline const Internal::BubbleEmitter& GetImpl(const Dali::Toolkit::BubbleEmitter& obj)
233 DALI_ASSERT_ALWAYS(obj && "BubbleEmitter handle is empty");
234 const Dali::RefObject& handle = obj.GetImplementation();
235 return static_cast<const Toolkit::Internal::BubbleEmitter&>(handle);
238 } // namespace Toolkit
242 #endif /* __DALI_TOOLKIT_INTERNAL_BUBBLE_EMITTER_IMPL_H__ */