1 #ifndef __DALI_TOOLKIT_BUBBLE_EMMITER_H__
2 #define __DALI_TOOLKIT_BUBBLE_EMMITER_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-toolkit/public-api/controls/control.h>
30 namespace Internal DALI_INTERNAL
33 * @brief BubbleEmitter implementation class.
39 * @brief BubbleEmitter is used to display lots of moving bubbles on the stage.
41 * This is done by applying BubbleEffect to multiple specifically created meshActors.
43 class DALI_IMPORT_API BubbleEmitter : public Control
48 * @brief Create an empty BubbleEmitter handle.
53 * @brief Virtual destructor.
58 * @brief Create an initialized BubbleEmitter.
60 * @param[in] winSize The size of the bubble moving area, usually the same size as the background image actor.
61 * @param[in] shapeImage The alpha channnel of this texture defines the bubble shape.
62 * @param[in] maximumNumberOfBubble The maximum number of bubble needed.
63 * @param[in] bubbleSizeRange The size range of the bubbles; x component is the low bound, and y component is the up bound.
64 * @return The initialized BubbleEmitter object.
66 static BubbleEmitter New( const Vector2& winSize,
68 unsigned int maximumNumberOfBubble,
69 const Vector2& bubbleSizeRange );
73 * @brief Copy constructor.
75 * Creates another handle that points to the same real object
76 * @param[in] handle The handle to copy
78 BubbleEmitter( const BubbleEmitter& handle );
81 * @brief Assignment operator.
83 * Changes this handle to point to another real object
84 * @param[in] rhs The object to point at
85 * @return A reference to this
87 BubbleEmitter& operator=( const BubbleEmitter& rhs );
90 * @brief Downcast an Object handle to SuperBlurView.
92 * If handle points to a BubbleEmitter, the downcast produces valid handle.
93 * If not, the returned handle is left uninitialized.
94 * @param[in] handle Handle to an object
95 * @return handle to a BubbleEmitter or an uninitialized handle
97 static BubbleEmitter DownCast( BaseHandle handle );
100 * @brief Return the root actor of all bubbles, should then be added to stage.
102 * @return The bubble root actor.
104 Actor GetRootActor();
107 * @brief Set Background image.
109 * The bubbles pick color from this image with HSV values adjusted.
110 * @param[in] bgImage The background image which provide color to bubbles.
111 * @param[in] hsvDelta The hsv channel difference used to adjust the background image color.
112 * If set these vector as Vector3::Zero, original colors are used.
114 void SetBackground( Image bgImage, const Vector3& hsvDelta );
117 * @brief Set bubble shape.
119 * The bubble mesh is a rectangular patch, but its displayed shape is decided by the alpha channel of the shape image.
120 * @param[in] shapeImage The image whose alpha channel defines the bubble shape.
122 void SetShapeImage( Image shapeImage );
125 * @brief Set the scale factor applied to all the bubbles.
127 * @param [in] scale The scale factor applied on bubbles.
129 void SetBubbleScale( float scale );
132 * @brief Set the density of the bubble.
134 * Ideally every bubble's moving track is controlled by different uniforms in BubbleEffect shaders.
135 * To increase the density, 'density' number of bubbles are sharing one group of uniforms, but with random offsets between these bubbles.
136 * The available density is one to nine. The default density is five.
137 * By set the density bigger than one, instead of emit one bubble each time, a 'density' number of bubbles are emitted.
138 * @param[in] density The density of the bubble.
140 void SetBubbleDensity( unsigned int density );
143 * @brief Enable different blending mode for rendering.
145 * @param[in] enable If false, the default blending function for RenderableActor is used.
147 void SetBlendMode( bool enable );
150 * @brief Add a bubble movement to the animation.
152 * @param[in] animation The animation reference.
153 * By passing the animation into BubbleEmitter, the animation's duration and how many bubbles contained within this animation are freely decided in App.
154 * @param[in] emitPosition The start position of the bubble movement.
155 * @param[in] direction The direction used to constrain the bubble to move in an adjacent direction around it.
156 * @param[in] displacement The displacement used to bound the moving distance of the bubble.
158 void EmitBubble( Animation& animation, const Vector2& emitPosition, const Vector2& direction, const Vector2& displacement );
161 * @brief Start an animation to enlarge every activated bubble's size and moving speed.
163 * @param[in] duration The duration of the animation
164 * @param[in] multiple The bubble size and moving speed will be increased gradually to multiple speed during the animation.
166 void StartExplosion( float duration, float multiple );
169 * @brief Reset all the parameters controlling the bubbles after animation.
173 public: // Not intended for developer use
176 * @brief Creates a handle using the Toolkit::Internal implementation.
178 * @param[in] implementation The Control implementation.
180 DALI_INTERNAL BubbleEmitter(Internal::BubbleEmitter& implementation);
183 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
185 * @param[in] internal A pointer to the internal CustomActor.
187 explicit DALI_INTERNAL BubbleEmitter(Dali::Internal::CustomActor* internal);
190 } // namespace Toolkit
194 #endif /* __DALI_TOOLKIT_BUBBLE_EMMITER_H__ */