#define DALI_UPDATE_PROXY_H
/*
- * Copyright (c) 2018 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.
namespace Dali
{
-
namespace Internal DALI_INTERNAL
{
class UpdateProxy;
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[out] position Set to the Actor's current position, if Actor ID is valid
* @return Whether the method call was successful or not.
*/
- bool GetPosition( uint32_t id, Vector3& position ) const;
+ bool GetPosition(uint32_t id, Vector3& position) const;
/**
* @brief Allows setting an Actor's local position from the Frame callback function for the current frame only.
* @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 SetPosition( uint32_t id, const Vector3& position );
+ bool SetPosition(uint32_t id, const Vector3& position);
/**
* @brief Allows baking an Actor's local position from the Frame callback function.
* @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 BakePosition( uint32_t id, const Vector3& position );
+ 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[out] size Set to the Actor's current size, if Actor ID is valid
* @return Whether the method call was successful or not.
*/
- bool GetSize( uint32_t id, Vector3& size ) const;
+ bool GetSize(uint32_t id, Vector3& size) const;
/**
* @brief Allows setting an Actor's size from the Frame callback function for the current frame only.
* @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 SetSize( uint32_t id, const Vector3& size );
+ bool SetSize(uint32_t id, const Vector3& size);
/**
* @brief Allows baking an Actor's size from the Frame callback function.
* @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 BakeSize( uint32_t id, const Vector3& size );
+ bool BakeSize(uint32_t id, const Vector3& size);
/**
* @brief Given the Actor ID, this retrieves that Actor's local position and size.
* @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 GetPositionAndSize( uint32_t id, Vector3& position, Vector3& size ) const;
+ bool GetPositionAndSize(uint32_t id, Vector3& position, Vector3& size) const;
+
+ /**
+ * @brief Given the Actor ID, this retrieves that Actor's world position 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] size Set to the Actor's current size, if Actor ID is valid
+ * @return Whether the method call was successful or not.
+ */
+ 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[out] scale Set to the Actor's current scale, if Actor ID is valid
* @return Whether the method call was successful or not.
*/
- bool GetScale( uint32_t id, Vector3& scale ) const;
+ bool GetScale(uint32_t id, Vector3& scale) const;
/**
* @brief Allows setting an Actor's local scale from the Frame callback function for the current frame only.
* @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 SetScale( uint32_t id, const Vector3& scale );
+ bool SetScale(uint32_t id, const Vector3& scale);
/**
* @brief Allows baking an Actor's local scale from the Frame callback function.
* @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 BakeScale( uint32_t id, const Vector3& scale );
+ bool BakeScale(uint32_t id, const Vector3& scale);
/**
* @brief Given the Actor ID, this retrieves that Actor's local color.
* @param[out] color Set to the Actor's current color, if Actor ID is valid
* @return Whether the method call was successful or not.
*/
- bool GetColor( uint32_t id, Vector4& color ) const;
+ bool GetColor(uint32_t id, Vector4& color) const;
/**
* @brief Allows setting an Actor's local color from the Frame callback function for the current frame only.
* @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 SetColor( uint32_t id, const Vector4& color ) const;
+ bool SetColor(uint32_t id, const Vector4& color);
/**
* @brief Allows baking an Actor's local color from the Frame callback function.
* @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 BakeColor( uint32_t id, const Vector4& color ) const;
+ bool BakeColor(uint32_t id, const Vector4& color);
-public: // Not intended for application developers
+ /**
+ * @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
/**
* @brief Constructor.
* @param[in] impl A reference to the internal object.
*/
- DALI_INTERNAL UpdateProxy( Internal::UpdateProxy& impl );
+ DALI_INTERNAL UpdateProxy(Internal::UpdateProxy& impl);
/**
* @brief Destructor.
// Not copyable or movable
- UpdateProxy( const UpdateProxy& ) = delete; ///< Deleted copy constructor
- UpdateProxy( UpdateProxy&& ) = delete; ///< Deleted move constructor
- UpdateProxy& operator=( const UpdateProxy& ) = delete; ///< Deleted copy assignment operator
- UpdateProxy& operator=( UpdateProxy&& ) = delete; ///< Deleted move assignment operator
+ UpdateProxy(const UpdateProxy&) = delete; ///< Deleted copy constructor
+ UpdateProxy(UpdateProxy&&) = delete; ///< Deleted move constructor
+ UpdateProxy& operator=(const UpdateProxy&) = delete; ///< Deleted copy assignment operator
+ UpdateProxy& operator=(UpdateProxy&&) = delete; ///< Deleted move assignment operator
/// @endcond
private:
-
/// @cond internal
Internal::UpdateProxy& mImpl;
/// @endcond
projects / platform / core / uifw / dali-core.git / blobdiff