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) 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/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 } // namespace DALI_INTERNAL
  42
  43 /**
  44  * @brief Used for rendering a vector animation file
  45  */
  46 class DALI_ADAPTOR_API VectorAnimationRenderer : public BaseHandle
  47 {
  48 public:
  49   /// @brief UploadCompleted signal type.
  50   using UploadCompletedSignalType = Signal<void()>;
  51
  52   /**
  53    * @brief Creates an initialized handle to a new VectorAnimationRenderer.
  54    *
  55    * @param[in] url The url of the vector animation file
  56    * @return A handle to a newly allocated VectorAnimationRenderer
  57    */
  58   static VectorAnimationRenderer New(const std::string& url);
  59
  60   /**
  61    * @brief Creates an empty handle.
  62    * Use VectorAnimationRenderer::New() to create an initialized object.
  63    */
  64   VectorAnimationRenderer();
  65
  66   /**
  67    * @brief Destructor.
  68    */
  69   ~VectorAnimationRenderer();
  70
  71   /**
  72    * @brief This copy constructor is required for (smart) pointer semantics.
  73    *
  74    * @param[in] handle A reference to the copied handle
  75    */
  76   VectorAnimationRenderer(const VectorAnimationRenderer& handle);
  77
  78   /**
  79    * @brief This assignment operator is required for (smart) pointer semantics.
  80    *
  81    * @param[in] rhs A reference to the copied handle
  82    * @return A reference to this
  83    */
  84   VectorAnimationRenderer& operator=(const VectorAnimationRenderer& rhs);
  85
  86   /**
  87    * @brief Finalizes the renderer.
  88    */
  89   void Finalize();
  90
  91   /**
  92    * @brief Sets the renderer used to display the result image.
  93    *
  94    * @param[in] renderer The renderer used to display the result image
  95    */
  96   void SetRenderer(Renderer renderer);
  97
  98   /**
  99    * @brief Sets the target image size.
 100    *
 101    * @param[in] width The target image width
 102    * @param[in] height The target image height
 103    */
 104   void SetSize(uint32_t width, uint32_t height);
 105
 106   /**
 107    * @brief Renders the content to the target buffer synchronously.
 108    *
 109    * @param[in] frameNumber The frame number to be rendered
 110    * @return True if the rendering success, false otherwise.
 111    */
 112   bool Render(uint32_t frameNumber);
 113
 114   /**
 115    * @brief Gets the total number of frames of the file
 116    *
 117    * @return The total number of frames
 118    */
 119   uint32_t GetTotalFrameNumber() const;
 120
 121   /**
 122    * @brief Gets the frame rate of the file.
 123    *
 124    * @return The frame rate of the file
 125    */
 126   float GetFrameRate() const;
 127
 128   /**
 129    * @brief Gets the default size of the file.
 130    *
 131    * @param[out] width The default width of the file
 132    * @param[out] height The default height of the file
 133    */
 134   void GetDefaultSize(uint32_t& width, uint32_t& height) const;
 135
 136   /**
 137    * @brief Gets the layer information of all the child layers.
 138    *
 139    * @param[out] map The layer information
 140    */
 141   void GetLayerInfo(Property::Map& map) const;
 142
 143   /**
 144    * @brief Gets the start frame and the end frame number of the composition marker.
 145    *
 146    * @param[in] marker The composition marker of the file
 147    * @param[out] startFrame The start frame number of the specified marker
 148    * @param[out] endFrame The end frame number of the specified marker
 149    * @return True if the marker is found in the file, false otherwise.
 150    *
 151    * @note https://helpx.adobe.com/after-effects/using/layer-markers-composition-markers.html
 152    * Markers exported from AfterEffect are used to describe a segment of an animation {comment/tag , startFrame, endFrame}
 153    * Marker can be use to devide a resource in to separate animations by tagging the segment with comment string,
 154    * start frame and duration of that segment.
 155    */
 156   bool GetMarkerInfo(const std::string& marker, uint32_t& startFrame, uint32_t& endFrame) const;
 157
 158   /**
 159    * @brief Ignores a rendered frame which is not shown yet.
 160    */
 161   void IgnoreRenderedFrame();
 162
 163 public: // Signals
 164   /**
 165    * @brief Connect to this signal to be notified when the texture upload is completed.
 166    *
 167    * @return The signal to connect to.
 168    */
 169   UploadCompletedSignalType& UploadCompletedSignal();
 170
 171 public: // Not intended for application developers
 172   /// @cond internal
 173   /**
 174    * @brief The constructor.
 175    * @note  Not intended for application developers.
 176    *
 177    * @param[in] pointer A pointer to a newly allocated VectorAnimationRenderer
 178    */
 179   explicit DALI_INTERNAL VectorAnimationRenderer(Internal::Adaptor::VectorAnimationRenderer* internal);
 180   /// @endcond
 181 };
 182
 183 /**
 184  * @}
 185  */
 186 } // namespace Dali
 187
 188 #endif // DALI_VECTOR_ANIMATION_RENDERER_H