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