dali/internal/vector-animation/common/vector-animation-renderer-impl.h

   1 #ifndef DALI_INTERNAL_VECTOR_ANIMATION_RENDERER_IMPL_H
   2 #define DALI_INTERNAL_VECTOR_ANIMATION_RENDERER_IMPL_H
   3
   4 /*
   5  * Copyright (c) 2022 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/object/base-object.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/devel-api/adaptor-framework/vector-animation-renderer.h>
  26 #include <dali/internal/vector-animation/common/vector-animation-renderer-plugin-proxy.h>
  27
  28 namespace Dali
  29 {
  30 namespace Internal
  31 {
  32 namespace Adaptor
  33 {
  34 class VectorAnimationRenderer;
  35 using VectorAnimationRendererPtr = IntrusivePtr<VectorAnimationRenderer>;
  36
  37 /**
  38  * Dali internal VectorAnimationRenderer.
  39  */
  40 class VectorAnimationRenderer : public BaseObject, public ConnectionTracker
  41 {
  42 public:
  43   /**
  44    * @brief Creates a VectorAnimationRenderer object.
  45    *
  46    * @param[in] url The url of the vector animation file
  47    */
  48   static VectorAnimationRendererPtr New();
  49
  50   /**
  51    * @copydoc Dali::VectorAnimationRenderer::Finalize()
  52    */
  53   void Finalize();
  54
  55   /**
  56    * @copydoc Dali::VectorAnimationRenderer::Load()
  57    */
  58   bool Load(const std::string& url);
  59
  60   /**
  61    * @copydoc Dali::VectorAnimationRenderer::SetRenderer()
  62    */
  63   void SetRenderer(Dali::Renderer renderer);
  64
  65   /**
  66    * @copydoc Dali::VectorAnimationRenderer::SetSize()
  67    */
  68   void SetSize(uint32_t width, uint32_t height);
  69
  70   /**
  71    * @copydoc Dali::VectorAnimationRenderer::Render()
  72    */
  73   bool Render(uint32_t frameNumber);
  74
  75   /**
  76    * @copydoc Dali::VectorAnimationRenderer::GetTotalFrameNumber()
  77    */
  78   uint32_t GetTotalFrameNumber() const;
  79
  80   /**
  81    * @copydoc Dali::VectorAnimationRenderer::GetFrameRate()
  82    */
  83   float GetFrameRate() const;
  84
  85   /**
  86    * @copydoc Dali::VectorAnimationRenderer::GetDefaultSize()
  87    */
  88   void GetDefaultSize(uint32_t& width, uint32_t& height) const;
  89
  90   /**
  91    * @copydoc Dali::VectorAnimationRenderer::GetLayerInfo()
  92    */
  93   void GetLayerInfo(Property::Map& map) const;
  94
  95   /**
  96    * @copydoc Dali::VectorAnimationRenderer::GetMarkerInfo()
  97    */
  98   bool GetMarkerInfo(const std::string& marker, uint32_t& startFrame, uint32_t& endFrame) const;
  99
 100   /**
 101    * @copydoc Dali::VectorAnimationRenderer::InvalidateBuffer()
 102    */
 103   void InvalidateBuffer();
 104
 105   /**
 106    * @copydoc Dali::VectorAnimationRenderer::AddPropertyValueCallback()
 107    */
 108   void AddPropertyValueCallback(const std::string& keyPath, Dali::VectorAnimationRenderer::VectorProperty property, CallbackBase* callback, int32_t id);
 109
 110   /**
 111    * @copydoc Dali::VectorAnimationRenderer::UploadCompletedSignal()
 112    */
 113   Dali::VectorAnimationRenderer::UploadCompletedSignalType& UploadCompletedSignal();
 114
 115 private:
 116   /**
 117    * @brief Constructor
 118    */
 119   VectorAnimationRenderer();
 120
 121   /**
 122    * @brief Destructor.
 123    */
 124   ~VectorAnimationRenderer();
 125
 126 private:
 127   VectorAnimationRenderer(const VectorAnimationRenderer&) = delete;
 128   VectorAnimationRenderer& operator=(VectorAnimationRenderer&) = delete;
 129
 130 private:
 131   VectorAnimationRendererPluginProxy mPlugin;
 132 };
 133
 134 } // namespace Adaptor
 135
 136 } // namespace Internal
 137
 138 inline static Internal::Adaptor::VectorAnimationRenderer& GetImplementation(Dali::VectorAnimationRenderer& renderer)
 139 {
 140   DALI_ASSERT_ALWAYS(renderer && "VectorAnimationRenderer handle is empty.");
 141
 142   BaseObject& handle = renderer.GetBaseObject();
 143
 144   return static_cast<Internal::Adaptor::VectorAnimationRenderer&>(handle);
 145 }
 146
 147 inline static const Internal::Adaptor::VectorAnimationRenderer& GetImplementation(const Dali::VectorAnimationRenderer& renderer)
 148 {
 149   DALI_ASSERT_ALWAYS(renderer && "VectorAnimationRenderer handle is empty.");
 150
 151   const BaseObject& handle = renderer.GetBaseObject();
 152
 153   return static_cast<const Internal::Adaptor::VectorAnimationRenderer&>(handle);
 154 }
 155
 156 } // namespace Dali
 157
 158 #endif // DALI_INTERNAL_VECTOR_ANIMATION_RENDERER_IMPL_H