[dali_2.3.5] Merge branch 'devel/master'

[platform/core/uifw/dali-adaptor.git] / dali / devel-api / adaptor-framework / vector-animation-renderer.h

diff --git a/dali/devel-api/adaptor-framework/vector-animation-renderer.h b/dali/devel-api/adaptor-framework/vector-animation-renderer.h
index f493b6b..cec206f 100644 (file)
--- a/dali/devel-api/adaptor-framework/vector-animation-renderer.h
+++ b/dali/devel-api/adaptor-framework/vector-animation-renderer.h
@@ -2,7 +2,7 @@
 #define DALI_VECTOR_ANIMATION_RENDERER_H
 
 /*
- * Copyright (c) 2021 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2023 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,6 +19,7 @@
  */
 
 // EXTERNAL INCLUDES
+#include <dali/public-api/common/dali-vector.h>
 #include <dali/public-api/object/base-handle.h>
 #include <dali/public-api/rendering/renderer.h>
 
@@ -46,6 +47,20 @@ class VectorAnimationRenderer;
 class DALI_ADAPTOR_API VectorAnimationRenderer : public BaseHandle
 {
 public:
+  enum class VectorProperty
+  {
+    FILL_COLOR,         ///< Fill color of the object, Type Property::VECTOR3
+    FILL_OPACITY,       ///< Fill opacity of the object, Type Property::FLOAT
+    STROKE_COLOR,       ///< Stroke color of the object, Type Property::VECTOR3
+    STROKE_OPACITY,     ///< Stroke opacity of the object, Type Property::FLOAT
+    STROKE_WIDTH,       ///< Stroke width of the object, Type Property::FLOAT
+    TRANSFORM_ANCHOR,   ///< Transform anchor of the Layer and Group object, Type Property::VECTOR2
+    TRANSFORM_POSITION, ///< Transform position of the Layer and Group object, Type Property::VECTOR2
+    TRANSFORM_SCALE,    ///< Transform scale of the Layer and Group object, Type Property::VECTOR2 [0..100]
+    TRANSFORM_ROTATION, ///< Transform rotation of the Layer and Group object, Type Property::FLOAT [0..360] in degrees
+    TRANSFORM_OPACITY   ///< Transform opacity of the Layer and Group object, Type Property::FLOAT
+  };
+
   /// @brief UploadCompleted signal type.
   using UploadCompletedSignalType = Signal<void()>;
 
@@ -96,6 +111,14 @@ public:
   bool Load(const std::string& url);
 
   /**
+   * @brief Loads the animation file by buffer.
+   *
+   * @param[in] data The raw buffer of the vector animation file
+   * @return True if loading success, false otherwise.
+   */
+  bool Load(const Dali::Vector<uint8_t>& data);
+
+  /**
    * @brief Sets the renderer used to display the result image.
    *
    * @param[in] renderer The renderer used to display the result image
@@ -119,6 +142,11 @@ public:
   bool Render(uint32_t frameNumber);
 
   /**
+   * @brief Notify the Renderer that rendering is stopped.
+   */
+  void RenderStopped();
+
+  /**
    * @brief Gets the total number of frames of the file
    *
    * @return The total number of frames
@@ -163,9 +191,50 @@ public:
   bool GetMarkerInfo(const std::string& marker, uint32_t& startFrame, uint32_t& endFrame) const;
 
   /**
-   * @brief Ignores a rendered frame which is not shown yet.
+   * @brief Gets the all composition marker informations.
+   *
+   * @param[out] map The marker information
+   */
+  void GetMarkerInfo(Property::Map& map) const;
+
+  /**
+   * @brief Invalidates the rendered buffer.
+   * @note The upload completed signal will be emitted again.
+   */
+  void InvalidateBuffer();
+
+  /**
+   * @brief Sets property value for the specified keyPath. This keyPath can resolve to multiple contents.
+   * In that case, the callback's value will apply to all of them.
+   *
+   * @param[in] keyPath The key path used to target a specific content or a set of contents that will be updated.
+   * @param[in] property The property to set.
+   * @param[in] callback The callback that gets called every time the animation is rendered.
+   * @param[in] id The Id to specify the callback. It should be unique and will be passed when the callback is called.
+   *
+   * @note A callback of the following type may be used:
+   * id  The id to specify the callback.
+   * property The property that represent what you are trying to change.
+   * frameNumber The current frame number.
+   * It returns a Property::Value to set according to the property type.
+   *
+   * @code
+   *   Property::Value MyFunction(int32_t id, VectorProperty property, uint32_t frameNumber);
+   * @endcode
+   *
+   * The keypath should contain object names separated by (.) and can handle globe(**) or wildchar(*).
+   * Ownership of the callback is passed onto this class.
+   */
+  void AddPropertyValueCallback(const std::string& keyPath, VectorProperty property, CallbackBase* callback, int32_t id);
+
+  /**
+   * @brief Keep the rasterized buffer to use the frame cache.
+   *
+   * By default, only as much as needed is kept in the rasterized buffer and not kept after use.
+   * tis API is efficient in terms of memory, but has the disadvantage of having to load the necessary buffer each time.
+   * therefore, if there are cases in which you want to improve the performance even if the app sacrifices a lot of memory, this API is useful.
    */
-  void IgnoreRenderedFrame();
+  void KeepRasterizedBuffer();
 
 public: // Signals
   /**