dali/devel-api/adaptor-framework/vector-animation-renderer.h

   1 #ifndef DALI_VECTOR_ANIMATION_RENDERER_H
   2 #define DALI_VECTOR_ANIMATION_RENDERER_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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/object/base-handle.h>
  23 #include <dali/public-api/rendering/renderer.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/public-api/dali-adaptor-common.h>
  27
  28 namespace Dali
  29 {
  30 /**
  31  * @addtogroup dali_adaptor_framework
  32  * @{
  33  */
  34
  35 namespace Internal DALI_INTERNAL
  36 {
  37 namespace Adaptor
  38 {
  39 class VectorAnimationRenderer;
  40 }
  41 }
  42
  43 /**
  44  * @brief Used for rendering a vector animation file
  45  */
  46 class DALI_ADAPTOR_API VectorAnimationRenderer : public BaseHandle
  47 {
  48 public:
  49
  50   /**
  51    * @brief Creates an initialized handle to a new VectorAnimationRenderer.
  52    *
  53    * @param[in] url The url of the vector animation file
  54    * @param[in] renderer The renderer used to render the image
  55    * @param[in] width The width of the content
  56    * @param[in] height The height of the content
  57    * @return A handle to a newly allocated VectorAnimationRenderer
  58    */
  59   static VectorAnimationRenderer New( const std::string& url, Renderer renderer, uint32_t width, uint32_t height );
  60
  61   /**
  62    * @brief Creates an empty handle.
  63    * Use VectorAnimationRenderer::New() to create an initialized object.
  64    */
  65   VectorAnimationRenderer();
  66
  67   /**
  68    * @brief Destructor.
  69    */
  70   ~VectorAnimationRenderer();
  71
  72   /**
  73    * @brief This copy constructor is required for (smart) pointer semantics.
  74    *
  75    * @param[in] handle A reference to the copied handle
  76    */
  77   VectorAnimationRenderer( const VectorAnimationRenderer& handle );
  78
  79   /**
  80    * @brief This assignment operator is required for (smart) pointer semantics.
  81    *
  82    * @param[in] rhs A reference to the copied handle
  83    * @return A reference to this
  84    */
  85   VectorAnimationRenderer& operator=( const VectorAnimationRenderer& rhs );
  86
  87   /**
  88    * @brief Starts the rendering.
  89    *
  90    * @return True if the renderer is successfully started, false otherwise.
  91    */
  92   bool StartRender();
  93
  94   /**
  95    * @brief Stops the rendering.
  96    */
  97   void StopRender();
  98
  99   /**
 100    * @brief Renders the content to the target buffer synchronously.
 101    *
 102    * @param[in] frameNumber The frame number to be rendered
 103    */
 104   void Render( uint32_t frameNumber );
 105
 106   /**
 107    * @brief Gets the total number of frames of the file
 108    *
 109    * @return The total number of frames
 110    */
 111   uint32_t GetTotalFrameNumber();
 112
 113 public: // Signals
 114
 115 public: // Not intended for application developers
 116
 117   /// @cond internal
 118   /**
 119    * @brief The constructor.
 120    * @note  Not intended for application developers.
 121    *
 122    * @param[in] pointer A pointer to a newly allocated VectorAnimationRenderer
 123    */
 124   explicit DALI_INTERNAL VectorAnimationRenderer( Internal::Adaptor::VectorAnimationRenderer* internal );
 125   /// @endcond
 126
 127 };
 128
 129 /**
 130  * @}
 131  */
 132 } // namespace Dali
 133
 134 #endif // DALI_VECTOR_ANIMATION_RENDERER_H