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