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) 2021 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 /**
  37  * Polymorphic base class for scene-graph properties, held by Nodes etc.
  38  */
  39 class PropertyBase : public PropertyInputImpl
  40 {
  41 public:
  42   /**
  43    * Default constructor.
  44    */
  45   PropertyBase();
  46
  47   /**
  48    * Virtual destructor.
  49    */
  50   ~PropertyBase() override;
  51
  52   /**
  53    * Reset the property to a base value; only required if the property is animated.
  54    * @param [in] currentBufferIndex The current buffer index.
  55    */
  56   virtual void ResetToBaseValue(BufferIndex updateBufferIndex) = 0;
  57
  58   /**
  59    * @copydoc Dali::Internal::PropertyInputImpl::InputChanged()
  60    */
  61   bool InputChanged() const override
  62   {
  63     return !IsClean();
  64   }
  65
  66   /**
  67    * Query whether the property has changed.
  68    * @return True if the property has not changed.
  69    */
  70   virtual bool IsClean() const = 0;
  71
  72 private:
  73   // Undefined
  74   PropertyBase(const PropertyBase& property);
  75
  76   // Undefined
  77   PropertyBase& operator=(const PropertyBase& rhs);
  78 };
  79
  80 } // namespace SceneGraph
  81
  82 } // namespace Internal
  83
  84 } // namespace Dali
  85
  86 #endif // DALI_INTERNAL_SCENE_GRAPH_PROPERTY_BASE_H