1 #ifndef DALI_TOOLKIT_INTERNAL_ANIMATED_VECTOR_IMAGE_VISUAL_H
2 #define DALI_TOOLKIT_INTERNAL_ANIMATED_VECTOR_IMAGE_VISUAL_H
5 * Copyright (c) 2024 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/devel-api/actors/actor-devel.h>
23 #include <dali/public-api/adaptor-framework/window.h>
24 #include <dali/public-api/common/intrusive-ptr.h>
25 #include <dali/public-api/object/property-notification.h>
26 #include <dali/public-api/object/weak-handle.h>
29 #include <dali-toolkit/devel-api/visuals/animated-vector-image-visual-actions-devel.h>
30 #include <dali-toolkit/internal/visuals/animated-vector-image/vector-animation-manager.h>
31 #include <dali-toolkit/internal/visuals/animated-vector-image/vector-animation-task.h>
32 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
33 #include <dali-toolkit/internal/visuals/visual-url.h>
41 class ImageVisualShaderFactory;
42 class AnimatedVectorImageVisual;
43 using AnimatedVectorImageVisualPtr = IntrusivePtr<AnimatedVectorImageVisual>;
46 * The visual which renders an animated vector image using VectorAnimationRenderer.
47 * VectorAnimationRenderer renders the animation image and this visuall controls the images.
49 * The following property is essential
51 * | %Property Name | Type |
52 * |--------------------------|------------------|
56 class AnimatedVectorImageVisual : public Visual::Base, public ConnectionTracker, public VectorAnimationManager::LifecycleObserver
60 * @brief Create the AnimatedVectorImageVisual using the image URL.
62 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
63 * @param[in] shaderFactory The ImageVisualShaderFactory object
64 * @param[in] imageUrl The URL to an animated vector image to use
65 * @param[in] properties A Property::Map containing settings for this visual
66 * @return A smart-pointer to the newly allocated visual.
68 static AnimatedVectorImageVisualPtr New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties);
71 * @brief Create the AnimatedVectorImageVisual using the image URL.
73 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
74 * @param[in] shaderFactory The ImageVisualShaderFactory object
75 * @param[in] imageUrl The URL to an animated vector image to use
76 * @param[in] size The width and height of the rasterized buffer. The visual size will be used if these are 0.
77 * @return A smart-pointer to the newly allocated visual.
79 static AnimatedVectorImageVisualPtr New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, ImageDimensions size = ImageDimensions());
81 public: // from Visual
83 * @copydoc Visual::Base::GetNaturalSize
85 void GetNaturalSize(Vector2& naturalSize) override;
88 * @copydoc Visual::Base::CreatePropertyMap
90 void DoCreatePropertyMap(Property::Map& map) const override;
93 * @copydoc Visual::Base::CreateInstancePropertyMap
95 void DoCreateInstancePropertyMap(Property::Map& map) const override;
98 * @copydoc Visual::Base::EnablePreMultipliedAlpha
100 void EnablePreMultipliedAlpha(bool preMultiplied) override;
102 protected: // From VectorAnimationManager::LifecycleObserver:
104 * @copydoc VectorAnimationManager::LifecycleObserver::VectorAnimationManagerDestroyed()
106 void VectorAnimationManagerDestroyed() override;
110 * @brief Constructor.
112 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
113 * @param[in] shaderFactory The ImageVisualShaderFactory object
114 * @param[in] imageUrl The URL to an animated vector image to use
115 * @param[in] size The width and height of the rasterized buffer. The visual size will be used if these are 0.
117 AnimatedVectorImageVisual(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, ImageDimensions size);
120 * @brief A reference counted object may only be deleted by calling Unreference().
122 ~AnimatedVectorImageVisual() override;
125 * @copydoc Visual::Base::OnInitialize
127 void OnInitialize() override;
130 * @copydoc Visual::Base::DoSetProperties
132 void DoSetProperties(const Property::Map& propertyMap) override;
135 * @copydoc Visual::Base::DoSetOnScene
137 void DoSetOnScene(Actor& actor) override;
140 * @copydoc Visual::Base::DoSetOffScene
142 void DoSetOffScene(Actor& actor) override;
145 * @copydoc Visual::Base::OnSetTransform
147 void OnSetTransform() override;
150 * @copydoc Visual::Base::UpdateShader
152 void UpdateShader() override;
155 * @copydoc Visual::Base::GenerateShader
157 Shader GenerateShader() const override;
160 * @copydoc Visual::Base::OnDoAction
162 void OnDoAction(const Property::Index actionId, const Property::Value& attributes) override;
165 * @copydoc Visual::Base::OnDoActionExtension
167 void OnDoActionExtension(const Property::Index actionId, Dali::Any attributes) override;
171 * Helper method to set individual values by index key.
172 * @param[in] index The index key of the value
173 * @param[in] value The value
175 void DoSetProperty(Property::Index index, const Property::Value& value);
178 * @brief Called when the resource is ready.
179 * @param[in] status The resource status
181 void OnResourceReady(VectorAnimationTask::ResourceStatus status);
184 * @brief Event callback from rasterize thread. This is called after the animation is finished.
186 * @param[in] playStateId The play state id
188 void OnAnimationFinished(uint32_t playStateId);
191 * @brief Event callback from rasterize thread. This is called when we want to ensure rendering next frame.
193 * @param[in] argument Not using arguments
195 void OnForceRendering(uint32_t argument);
198 * @brief Send animation data to the rasterize thread.
200 void SendAnimationData();
203 * @brief Set the vector image size.
205 void SetVectorImageSize();
208 * @brief Stop the animation.
210 void StopAnimation();
213 * @brief Trigger rasterization of the vector content.
215 void TriggerVectorRasterization();
218 * @brief Callback when the world scale factor changes.
220 void OnScaleNotification(PropertyNotification& source);
223 * @brief Callback when the size changes.
225 void OnSizeNotification(PropertyNotification& source);
228 * @brief Callback when the visibility of the actor is changed.
230 void OnControlVisibilityChanged(Actor actor, bool visible, DevelActor::VisibilityChange::Type type);
233 * @brief Callback when the visibility of the window is changed.
235 void OnWindowVisibilityChanged(Window window, bool visible);
238 * @brief Callback when the event is processed.
240 void OnProcessEvents();
243 AnimatedVectorImageVisual(const AnimatedVectorImageVisual& visual) = delete;
246 AnimatedVectorImageVisual& operator=(const AnimatedVectorImageVisual& visual) = delete;
250 VectorAnimationTask::AnimationData mAnimationData;
251 VectorAnimationTaskPtr mVectorAnimationTask;
252 ImageVisualShaderFactory& mImageVisualShaderFactory;
253 PropertyNotification mScaleNotification;
254 PropertyNotification mSizeNotification;
256 Vector2 mVisualScale;
257 Dali::ImageDimensions mDesiredSize{};
258 WeakHandle<Actor> mPlacementActor;
259 DevelImageVisual::PlayState::Type mPlayState;
260 CallbackBase* mEventCallback; // Not owned
262 uint32_t mLastSentPlayStateId;
264 bool mLoadFailed : 1;
265 bool mRendererAdded : 1;
266 bool mCoreShutdown : 1;
267 bool mRedrawInScalingDown : 1;
268 bool mEnableFrameCache : 1;
269 bool mUseNativeImage : 1;
272 } // namespace Internal
274 } // namespace Toolkit
278 #endif // DALI_TOOLKIT_INTERNAL_ANIMATED_VECTOR_IMAGE_VISUAL_H