dali/internal/vector-animation/common/vector-animation-renderer-plugin-proxy.h

   1 #ifndef DALI_INTERNAL_VECTOR_ANIMATION_RENDERER_PLUGIN_PROXY_H
   2 #define DALI_INTERNAL_VECTOR_ANIMATION_RENDERER_PLUGIN_PROXY_H
   3
   4 /*
   5  * Copyright (c) 2018 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 // INTERNAL INCLUDES
  22 #include <dali/devel-api/adaptor-framework/vector-animation-renderer-plugin.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Internal
  28 {
  29
  30 namespace Adaptor
  31 {
  32
  33 /**
  34  * Proxy class to dynamically load, use and unload vector animation renderer plugin.
  35  */
  36 class VectorAnimationRendererPluginProxy
  37 {
  38 public:
  39
  40   /**
  41    * @brief Constructor
  42    */
  43   VectorAnimationRendererPluginProxy( const std::string& sharedObjectName );
  44
  45   /**
  46    * @brief Destructor
  47    */
  48   ~VectorAnimationRendererPluginProxy();
  49
  50   /**
  51    * @copydoc Dali::VectorAnimationRendererPlugin::SetUrl()
  52    */
  53   void SetUrl( const std::string& url );
  54
  55   /**
  56    * @copydoc Dali::VectorAnimationRendererPlugin::SetRenderer()
  57    */
  58   void SetRenderer( Dali::Renderer renderer );
  59
  60   /**
  61    * @copydoc Dali::VectorAnimationRendererPlugin::SetSize()
  62    */
  63   void SetSize( uint32_t width, uint32_t height );
  64
  65   /**
  66    * @copydoc Dali::VectorAnimationRendererPlugin::StartRender()
  67    */
  68   bool StartRender();
  69
  70   /**
  71    * @copydoc Dali::VectorAnimationRendererPlugin::StopRender()
  72    */
  73   void StopRender();
  74
  75   /**
  76    * @copydoc Dali::VectorAnimationRendererPlugin::Render()
  77    */
  78   void Render( uint32_t frameNumber );
  79
  80   /**
  81    * @copydoc Dali::VectorAnimationRendererPlugin::GetTotalFrameNumber()
  82    */
  83   uint32_t GetTotalFrameNumber() const;
  84
  85   /**
  86    * @copydoc Dali::VectorAnimationRendererPlugin::GetFrameRate()
  87    */
  88   float GetFrameRate() const;
  89
  90   // Not copyable or movable
  91   VectorAnimationRendererPluginProxy( const VectorAnimationRendererPluginProxy& ) = delete; ///< Deleted copy constructor
  92   VectorAnimationRendererPluginProxy( VectorAnimationRendererPluginProxy&& ) = delete; ///< Deleted move constructor
  93   VectorAnimationRendererPluginProxy& operator=( const VectorAnimationRendererPluginProxy& ) = delete; ///< Deleted copy assignment operator
  94   VectorAnimationRendererPluginProxy& operator=( VectorAnimationRendererPluginProxy&& ) = delete; ///< Deleted move assignment operator
  95
  96 private:
  97
  98   /**
  99    * Dynamically loads the plugin.
 100    */
 101   void Initialize();
 102
 103 private:
 104
 105   using CreateVectorAnimationRendererFunction = Dali::VectorAnimationRendererPlugin* (*)();
 106
 107   std::string                            mSharedObjectName;   ///< Shared object name
 108   void*                                  mLibHandle;          ///< Handle for the loaded library
 109   Dali::VectorAnimationRendererPlugin*   mPlugin;             ///< Plugin handle
 110
 111   CreateVectorAnimationRendererFunction  mCreateVectorAnimationRendererPtr;   ///< Function pointer called in adaptor to create a plugin instance
 112
 113 };
 114
 115 } // namespace Adaptor
 116
 117 } // namespace Internal
 118
 119 } // namespace Dali
 120
 121 #endif // DALI_INTERNAL_VECTOR_ANIMATION_RENDERER_PLUGIN_PROXY_H