1 #ifndef DALI_TOOLKIT_INTERNAL_ANIMATED_VECTOR_IMAGE_VISUAL_H
2 #define DALI_TOOLKIT_INTERNAL_ANIMATED_VECTOR_IMAGE_VISUAL_H
5 * Copyright (c) 2020 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/public-api/common/intrusive-ptr.h>
23 #include <dali/public-api/object/weak-handle.h>
24 #include <dali/public-api/object/property-notification.h>
25 #include <dali/public-api/adaptor-framework/window.h>
26 #include <dali/devel-api/actors/actor-devel.h>
29 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
30 #include <dali-toolkit/internal/visuals/visual-url.h>
31 #include <dali-toolkit/devel-api/visuals/animated-vector-image-visual-actions-devel.h>
32 #include <dali-toolkit/internal/visuals/animated-vector-image/vector-animation-task.h>
33 #include <dali-toolkit/internal/visuals/animated-vector-image/vector-animation-manager.h>
44 class ImageVisualShaderFactory;
45 class AnimatedVectorImageVisual;
46 using AnimatedVectorImageVisualPtr = IntrusivePtr< AnimatedVectorImageVisual >;
49 * The visual which renders an animated vector image using VectorAnimationRenderer.
50 * VectorAnimationRenderer renders the animation image and this visuall controls the images.
52 * The following property is essential
54 * | %Property Name | Type |
55 * |--------------------------|------------------|
59 class AnimatedVectorImageVisual: public Visual::Base, public ConnectionTracker, public VectorAnimationManager::LifecycleObserver
64 * @brief Create the AnimatedVectorImageVisual using the image URL.
66 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
67 * @param[in] shaderFactory The ImageVisualShaderFactory object
68 * @param[in] imageUrl The URL to an animated vector image to use
69 * @param[in] properties A Property::Map containing settings for this visual
70 * @return A smart-pointer to the newly allocated visual.
72 static AnimatedVectorImageVisualPtr New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties );
75 * @brief Create the AnimatedVectorImageVisual using the image URL.
77 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
78 * @param[in] shaderFactory The ImageVisualShaderFactory object
79 * @param[in] imageUrl The URL to an animated vector image to use
80 * @return A smart-pointer to the newly allocated visual.
82 static AnimatedVectorImageVisualPtr New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl );
84 public: // from Visual
87 * @copydoc Visual::Base::GetNaturalSize
89 void GetNaturalSize( Vector2& naturalSize ) override;
92 * @copydoc Visual::Base::CreatePropertyMap
94 void DoCreatePropertyMap( Property::Map& map ) const override;
97 * @copydoc Visual::Base::CreateInstancePropertyMap
99 void DoCreateInstancePropertyMap( Property::Map& map ) const override;
101 protected: // From VectorAnimationManager::LifecycleObserver:
103 * @copydoc VectorAnimationManager::LifecycleObserver::VectorAnimationManagerDestroyed()
105 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
116 AnimatedVectorImageVisual( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl );
119 * @brief A reference counted object may only be deleted by calling Unreference().
121 ~AnimatedVectorImageVisual() override;
124 * @copydoc Visual::Base::DoSetProperties
126 void DoSetProperties( const Property::Map& propertyMap ) override;
129 * @copydoc Visual::Base::DoSetOnScene
131 void DoSetOnScene( Actor& actor ) override;
134 * @copydoc Visual::Base::DoSetOffScene
136 void DoSetOffScene( Actor& actor ) override;
139 * @copydoc Visual::Base::OnSetTransform
141 void OnSetTransform() override;
144 * @copydoc Visual::Base::OnDoAction
146 void OnDoAction( const Property::Index actionId, const Property::Value& attributes ) override;
151 * Helper method to set individual values by index key.
152 * @param[in] index The index key of the value
153 * @param[in] value The value
155 void DoSetProperty( Property::Index index, const Property::Value& value );
158 * @brief Called when the texture upload is completed.
160 void OnUploadCompleted();
163 * @brief Event callback from rasterize thread. This is called after the animation is finished.
165 void OnAnimationFinished();
168 * @brief Send animation data to the rasterize thread.
170 void SendAnimationData();
173 * @brief Set the vector image size.
175 void SetVectorImageSize();
178 * @brief Stop the animation.
180 void StopAnimation();
183 * @brief Trigger rasterization of the vector content.
185 void TriggerVectorRasterization();
188 * @brief Callback when the world scale factor changes.
190 void OnScaleNotification( PropertyNotification& source );
193 * @brief Callback when the size changes.
195 void OnSizeNotification( PropertyNotification& source );
198 * @brief Callback when the visibility of the actor is changed.
200 void OnControlVisibilityChanged( Actor actor, bool visible, DevelActor::VisibilityChange::Type type );
203 * @brief Callback when the visibility of the window is changed.
205 void OnWindowVisibilityChanged( Window window, bool visible );
208 * @brief Callback when the event is processed.
210 void OnProcessEvents();
213 AnimatedVectorImageVisual( const AnimatedVectorImageVisual& visual ) = delete;
216 AnimatedVectorImageVisual& operator=( const AnimatedVectorImageVisual& visual ) = delete;
220 VectorAnimationTask::AnimationData mAnimationData;
221 VectorAnimationTaskPtr mVectorAnimationTask;
222 ImageVisualShaderFactory& mImageVisualShaderFactory;
223 PropertyNotification mScaleNotification;
224 PropertyNotification mSizeNotification;
226 Vector2 mVisualScale;
227 WeakHandle< Actor > mPlacementActor;
228 DevelImageVisual::PlayState::Type mPlayState;
229 CallbackBase* mEventCallback; // Not owned
234 } // namespace Internal
236 } // namespace Toolkit
240 #endif // DALI_TOOLKIT_INTERNAL_ANIMATED_VECTOR_IMAGE_VISUAL_H