dali/internal/update/common/property-base.h

   1 #ifndef DALI_INTERNAL_SCENE_GRAPH_PROPERTY_BASE_H
   2 #define DALI_INTERNAL_SCENE_GRAPH_PROPERTY_BASE_H
   3
   4 /*
   5  * Copyright (c) 2024 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 <cstddef>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/internal/common/type-abstraction.h>
  26 #include <dali/internal/event/common/property-input-impl.h>
  27 #include <dali/internal/update/common/scene-graph-buffers.h>
  28 #include <dali/public-api/object/property.h>
  29
  30 namespace Dali
  31 {
  32 namespace Internal
  33 {
  34 namespace SceneGraph
  35 {
  36 class ResetterManager;
  37
  38 /**
  39  * Polymorphic base class for scene-graph properties, held by Nodes etc.
  40  */
  41 class PropertyBase : public PropertyInputImpl
  42 {
  43 public:
  44   /**
  45    * Default constructor.
  46    */
  47   PropertyBase() = default;
  48
  49   /**
  50    * Virtual destructor.
  51    */
  52   ~PropertyBase() = default;
  53
  54   /**
  55    * @brief Registers a resetter manager for whole property bases.
  56    *
  57    * @param [in] manager The manager to register.
  58    */
  59   static void RegisterResetterManager(ResetterManager& manager);
  60
  61   /**
  62    * @brief Unregisters a resetter manager.
  63    */
  64   static void UnregisterResetterManager();
  65
  66   /**
  67    * @brief Request to reset the property to a base value to registered ResetterManager.
  68    */
  69   void RequestResetToBaseValue();
  70
  71   /**
  72    * Reset the property to a base value; only required if the property is animated.
  73    * @param [in] currentBufferIndex The current buffer index.
  74    */
  75   virtual void ResetToBaseValue(BufferIndex updateBufferIndex) = 0;
  76
  77   /**
  78    * @copydoc Dali::Internal::PropertyInputImpl::InputChanged()
  79    */
  80   bool InputChanged() const override
  81   {
  82     return !IsClean();
  83   }
  84
  85   /**
  86    * Query whether the property has changed.
  87    * @return True if the property has not changed.
  88    */
  89   virtual bool IsClean() const = 0;
  90
  91 private:
  92   // Undefined
  93   PropertyBase(const PropertyBase& property);
  94
  95   // Undefined
  96   PropertyBase& operator=(const PropertyBase& rhs);
  97 };
  98
  99 } // namespace SceneGraph
 100
 101 } // namespace Internal
 102
 103 } // namespace Dali
 104
 105 #endif // DALI_INTERNAL_SCENE_GRAPH_PROPERTY_BASE_H