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

[platform/core/uifw/dali-core.git] / dali / devel-api / update / update-proxy.h

diff --git a/dali/devel-api/update/update-proxy.h b/dali/devel-api/update/update-proxy.h
index 0698b9a..eb093a0 100644 (file)
--- a/dali/devel-api/update/update-proxy.h
+++ b/dali/devel-api/update/update-proxy.h
@@ -2,7 +2,7 @@
 #define DALI_UPDATE_PROXY_H
 
 /*
- * Copyright (c) 2022 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.
@@ -46,6 +46,12 @@ class DALI_CORE_API UpdateProxy
 {
 public:
   /**
+   * Type to define a unique sync point.
+   */
+  using NotifySyncPoint = int;
+  static constexpr NotifySyncPoint INVALID_SYNC{-1};
+
+  /**
    * @brief Given the Actor ID, this retrieves that Actor's local position.
    * @param[in]   id        The Actor ID
    * @param[out]  position  Set to the Actor's current position, if Actor ID is valid
@@ -72,6 +78,32 @@ public:
   bool BakePosition(uint32_t id, const Vector3& position);
 
   /**
+   * @brief Given the Actor ID, this retrieves that Actor's local orientation.
+   * @param[in]   id        The Actor ID
+   * @param[out]  orientation  Set to the Actor's current orientation, if Actor ID is valid
+   * @return Whether the method call was successful or not.
+   */
+  bool GetOrientation(uint32_t id, Quaternion& orientation) const;
+
+  /**
+   * @brief Allows setting an Actor's local orientation from the Frame callback function for the current frame only.
+   * @param[in]  id        The Actor ID
+   * @param[in]  orientation  The orientation to set
+   * @return Whether the method call was successful or not.
+   * @note This will get reset to the internally calculated or previously baked value in the next frame, so will have to be set again.
+   */
+  bool SetOrientation(uint32_t id, const Quaternion& orientation);
+
+  /**
+   * @brief Allows baking an Actor's local orientation from the Frame callback function.
+   * @param[in]  id        The Actor ID
+   * @param[in]  orientation  The orientation to bake
+   * @return Whether the method call was successful or not.
+   * @note The value is saved so will cause undesired effects if this property is being animated.
+   */
+  bool BakeOrientation(uint32_t id, const Quaternion& orientation);
+
+  /**
    * @brief Given the Actor ID, this retrieves that Actor's size.
    * @param[in]   id    The Actor ID
    * @param[out]  size  Set to the Actor's current size, if Actor ID is valid
@@ -117,6 +149,17 @@ public:
   bool GetWorldPositionScaleAndSize(uint32_t id, Vector3& position, Vector3& scale, Vector3& size) const;
 
   /**
+   * @brief Given the Actor ID, this retrieves that Actor's world transform properties and size.
+   * @param[in]   id        The Actor ID
+   * @param[out]  position  Set to the Actor's current world position, if Actor ID is valid
+   * @param[out]  scale     Set to the Actor's current world scale, if Actor ID is valid
+   * @param[out]  orientation Set to the Actor's current world orientation, if Actor ID is valid
+   * @param[out]  size      Set to the Actor's current size, if Actor ID is valid
+   * @return Whether the method call was successful or not.
+   */
+  bool GetWorldTransformAndSize(uint32_t id, Vector3& position, Vector3& scale, Quaternion& orientation, Vector3& size) const;
+
+  /**
    * @brief Given the Actor ID, this retrieves that Actor's local scale.
    * @param[in]   id     The Actor ID
    * @param[out]  scale  Set to the Actor's current scale, if Actor ID is valid
@@ -168,6 +211,32 @@ public:
    */
   bool BakeColor(uint32_t id, const Vector4& color);
 
+  /**
+   * @brief Pop a sync point off the stack.
+   *
+   * Sync points can be added from the event side using Dali::DevelStage::NotifyFrameCallback().
+   * @return INVALID_SYNC if there was no SyncPoint, or a unique value if there was a sync point.
+   */
+  NotifySyncPoint PopSyncPoint();
+
+  /**
+   * @brief Given the Actor ID, Gets the updated area of the actor.
+   *
+   * @param[in]   id     The Actor ID
+   * @param[out]  updateArea  Get to the Actor's current updated area, if Actor ID is valid
+   * @return Whether the method call was successful or not.
+   */
+  bool GetUpdateArea(uint32_t id, Vector4& updateArea) const;
+
+  /**
+   * @brief Given the Actor ID, Sets the updated area of the actor.
+   *
+   * @param[in]   id     The Actor ID
+   * @param[in]   updateArea  Set to the Actor's current updated area, if Actor ID is valid
+   * @return Whether the method call was successful or not.
+   */
+  bool SetUpdateArea(uint32_t id, const Vector4& updateArea);
+
 public: // Not intended for application developers
   /// @cond internal