dali-toolkit/internal/visuals/animated-vector-image/animated-vector-image-visual.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_ANIMATED_VECTOR_IMAGE_VISUAL_H
   2 #define DALI_TOOLKIT_INTERNAL_ANIMATED_VECTOR_IMAGE_VISUAL_H
   3
   4 /*
   5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  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>
  27 #include <dali/integration-api/processor-interface.h>
  28
  29 // INTERNAL INCLUDES
  30 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  31 #include <dali-toolkit/internal/visuals/visual-url.h>
  32 #include <dali-toolkit/devel-api/visuals/animated-vector-image-visual-actions-devel.h>
  33 #include <dali-toolkit/internal/visuals/animated-vector-image/vector-animation-task.h>
  34
  35 namespace Dali
  36 {
  37
  38 namespace Toolkit
  39 {
  40
  41 namespace Internal
  42 {
  43
  44 class ImageVisualShaderFactory;
  45 class AnimatedVectorImageVisual;
  46 using AnimatedVectorImageVisualPtr = IntrusivePtr< AnimatedVectorImageVisual >;
  47
  48 /**
  49  * The visual which renders an animated vector image using VectorAnimationRenderer.
  50  * VectorAnimationRenderer renders the animation image and this visuall controls the images.
  51  *
  52  * The following property is essential
  53  *
  54  * | %Property Name           | Type             |
  55  * |--------------------------|------------------|
  56  * | url                      | STRING           |
  57  *
  58  */
  59 class AnimatedVectorImageVisual: public Visual::Base, public ConnectionTracker, public Integration::Processor
  60 {
  61 public:
  62
  63   /**
  64    * @brief Create the AnimatedVectorImageVisual using the image URL.
  65    *
  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.
  71    */
  72   static AnimatedVectorImageVisualPtr New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties );
  73
  74   /**
  75    * @brief Create the AnimatedVectorImageVisual using the image URL.
  76    *
  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.
  81    */
  82   static AnimatedVectorImageVisualPtr New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl );
  83
  84 public:  // from Visual
  85
  86   /**
  87    * @copydoc Visual::Base::GetNaturalSize
  88    */
  89   void GetNaturalSize( Vector2& naturalSize ) override;
  90
  91   /**
  92    * @copydoc Visual::Base::CreatePropertyMap
  93    */
  94   void DoCreatePropertyMap( Property::Map& map ) const override;
  95
  96   /**
  97    * @copydoc Visual::Base::CreateInstancePropertyMap
  98    */
  99   void DoCreateInstancePropertyMap( Property::Map& map ) const override;
 100
 101 protected:
 102
 103   /**
 104    * @brief Constructor.
 105    *
 106    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
 107    * @param[in] shaderFactory The ImageVisualShaderFactory object
 108    * @param[in] imageUrl The URL to an animated vector image to use
 109    */
 110   AnimatedVectorImageVisual( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl );
 111
 112   /**
 113    * @brief A reference counted object may only be deleted by calling Unreference().
 114    */
 115   virtual ~AnimatedVectorImageVisual();
 116
 117   /**
 118    * @copydoc Visual::Base::DoSetProperties
 119    */
 120   void DoSetProperties( const Property::Map& propertyMap ) override;
 121
 122   /**
 123    * @copydoc Visual::Base::DoSetOnStage
 124    */
 125   void DoSetOnStage( Actor& actor ) override;
 126
 127   /**
 128    * @copydoc Visual::Base::DoSetOffStage
 129    */
 130   void DoSetOffStage( Actor& actor ) override;
 131
 132   /**
 133    * @copydoc Visual::Base::OnSetTransform
 134    */
 135   void OnSetTransform() override;
 136
 137   /**
 138    * @copydoc Visual::Base::OnDoAction
 139    */
 140   void OnDoAction( const Property::Index actionId, const Property::Value& attributes ) override;
 141
 142 protected: // Implementation of Processor
 143
 144   /**
 145    * @copydoc Dali::Integration::Processor::Process()
 146    */
 147   void Process() override;
 148
 149 private:
 150
 151   /**
 152    * Helper method to set individual values by index key.
 153    * @param[in] index The index key of the value
 154    * @param[in] value The value
 155    */
 156   void DoSetProperty( Property::Index index, const Property::Value& value );
 157
 158   /**
 159    * @brief Called when the texture upload is completed.
 160    */
 161   void OnUploadCompleted();
 162
 163   /**
 164    * @brief Event callback from rasterize thread. This is called after the animation is finished.
 165    */
 166   void OnAnimationFinished();
 167
 168   /**
 169    * @brief Send animation data to the rasterize thread.
 170    */
 171   void SendAnimationData();
 172
 173   /**
 174    * @brief Set the vector image size.
 175    */
 176   void SetVectorImageSize();
 177
 178   /**
 179    * @brief Stop the animation.
 180    */
 181   void StopAnimation();
 182
 183   /**
 184    * @brief Trigger rasterization of the vector content.
 185    */
 186   void TriggerVectorRasterization();
 187
 188   /**
 189    * @brief Callback when the world scale factor changes.
 190    */
 191   void OnScaleNotification( PropertyNotification& source );
 192
 193   /**
 194    * @brief Callback when the size changes.
 195    */
 196   void OnSizeNotification( PropertyNotification& source );
 197
 198   /**
 199    * @brief Callback when the visibility of the actor is changed.
 200    */
 201   void OnControlVisibilityChanged( Actor actor, bool visible, DevelActor::VisibilityChange::Type type );
 202
 203   /**
 204    * @brief Callback when the visibility of the window is changed.
 205    */
 206   void OnWindowVisibilityChanged( Window window, bool visible );
 207
 208   // Undefined
 209   AnimatedVectorImageVisual( const AnimatedVectorImageVisual& visual ) = delete;
 210
 211   // Undefined
 212   AnimatedVectorImageVisual& operator=( const AnimatedVectorImageVisual& visual ) = delete;
 213
 214 private:
 215   VisualUrl                                    mUrl;
 216   VectorAnimationTask::AnimationData           mAnimationData;
 217   VectorAnimationTaskPtr                       mVectorAnimationTask;
 218   ImageVisualShaderFactory&                    mImageVisualShaderFactory;
 219   PropertyNotification                         mScaleNotification;
 220   PropertyNotification                         mSizeNotification;
 221   Vector2                                      mVisualSize;
 222   Vector2                                      mVisualScale;
 223   WeakHandle< Actor >                          mPlacementActor;
 224   DevelImageVisual::PlayState::Type            mPlayState;
 225   bool                                         mRendererAdded;
 226   bool                                         mRasterizationTriggered;
 227 };
 228
 229 } // namespace Internal
 230
 231 } // namespace Toolkit
 232
 233 } // namespace Dali
 234
 235 #endif // DALI_TOOLKIT_INTERNAL_ANIMATED_VECTOR_IMAGE_VISUAL_H