1 #ifndef DALI_TOOLKIT_BUBBLE_EMMITER_H
2 #define DALI_TOOLKIT_BUBBLE_EMMITER_H
5 * Copyright (c) 2019 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>
23 #include <dali/public-api/rendering/texture.h>
31 namespace Internal DALI_INTERNAL
34 * @brief BubbleEmitter implementation class.
40 * @brief BubbleEmitter is used to display lots of moving bubbles on the stage.
42 * This is done by applying BubbleEffect to multiple specifically created meshActors.
44 class DALI_TOOLKIT_API BubbleEmitter : public Control
49 * @brief Create an empty BubbleEmitter handle.
54 * @brief Virtual destructor.
59 * @brief Create an initialized BubbleEmitter.
61 * @param[in] winSize The size of the bubble moving area, usually the same size as the background.
62 * @param[in] shapeTexture The alpha channnel of this texture defines the bubble shape.
63 * @param[in] maximumNumberOfBubble The maximum number of bubble needed.
64 * @param[in] bubbleSizeRange The size range of the bubbles; x component is the low bound, and y component is the up bound.
65 * @return The initialized BubbleEmitter object.
67 static BubbleEmitter New( const Vector2& winSize,
68 Dali::Texture shapeTexture,
69 unsigned int maximumNumberOfBubble,
70 const Vector2& bubbleSizeRange );
74 * @brief Copy constructor.
76 * Creates another handle that points to the same real object
77 * @param[in] handle The handle to copy
79 BubbleEmitter( const BubbleEmitter& handle );
82 * @brief Assignment operator.
84 * Changes this handle to point to another real object
85 * @param[in] rhs The object to point at
86 * @return A reference to this
88 BubbleEmitter& operator=( const BubbleEmitter& rhs );
91 * @brief Downcast an Object handle to SuperBlurView.
93 * If handle points to a BubbleEmitter, the downcast produces valid handle.
94 * If not, the returned handle is left uninitialized.
95 * @param[in] handle Handle to an object
96 * @return handle to a BubbleEmitter or an uninitialized handle
98 static BubbleEmitter DownCast( BaseHandle handle );
101 * @brief Return the root actor of all bubbles, should then be added to stage.
103 * @return The bubble root actor.
105 Actor GetRootActor();
108 * @brief Set Background image.
110 * The bubbles pick color from this image with HSV values adjusted.
111 * @param[in] bgTexture The background texture which provide color to bubbles.
112 * @param[in] hsvDelta The hsv channel difference used to adjust the background image color.
113 * If set these vector as Vector3::Zero, original colors are used.
115 void SetBackground( Dali::Texture bgTexture, const Vector3& hsvDelta );
118 * @brief Set bubble shape.
120 * The bubble mesh is a rectangular patch, but its displayed shape is decided by the alpha channel of the shape texture.
121 * @param[in] shapeTexture The texture whose alpha channel defines the bubble shape.
123 void SetBubbleShape( Dali::Texture shapeTexture );
126 * @brief Set the scale factor applied to all the bubbles.
128 * @param [in] scale The scale factor applied on bubbles.
130 void SetBubbleScale( float scale );
133 * @brief Set the density of the bubble.
135 * Ideally every bubble's moving track is controlled by different uniforms in shader.
136 * To increase the density, 'density' number of bubbles are sharing one group of uniforms, but with random offsets between these bubbles.
137 * The available densities are one to nine only. The default value is five.
138 * By set the density bigger than one, instead of emit one bubble each time, a 'density' number of bubbles are emitted.
139 * @param[in] density The density of the bubble.
141 void SetBubbleDensity( unsigned int density );
144 * @brief Add a bubble movement to the animation.
146 * @param[in] animation The animation reference.
147 * By passing the animation into BubbleEmitter, the animation's duration and how many bubbles contained within this animation are freely decided in App.
148 * @param[in] emitPosition The start position of the bubble movement.
149 * @param[in] direction The direction used to constrain the bubble to move in an adjacent direction around it.
150 * @param[in] displacement The displacement used to bound the moving distance of the bubble.
152 void EmitBubble( Animation& animation, const Vector2& emitPosition, const Vector2& direction, const Vector2& displacement );
155 * @brief Reset all the parameters controlling the bubbles after animation.
159 public: // Not intended for developer use
162 * @brief Creates a handle using the Toolkit::Internal implementation.
164 * @param[in] implementation The Control implementation.
166 DALI_INTERNAL BubbleEmitter(Internal::BubbleEmitter& implementation);
169 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
171 * @param[in] internal A pointer to the internal CustomActor.
173 explicit DALI_INTERNAL BubbleEmitter(Dali::Internal::CustomActor* internal);
176 } // namespace Toolkit
180 #endif /* DALI_TOOLKIT_BUBBLE_EMMITER_H */