dali/internal/event/common/property-notifier.h

   1 #ifndef DALI_INTERNAL_PROPERTY_NOTIFIER_H
   2 #define DALI_INTERNAL_PROPERTY_NOTIFIER_H
   3
   4 /*
   5  * Copyright (c) 2023 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 // INTERNAL INCLUDES
  22 #include <dali/internal/common/message.h>
  23 #include <dali/internal/event/common/notifier-interface.h> ///< for NotifierInterface::NotifyId
  24
  25 namespace Dali
  26 {
  27 namespace Internal
  28 {
  29 namespace SceneGraph
  30 {
  31 class PropertyNotification;
  32
  33 } //namespace SceneGraph
  34
  35 /**
  36  * Interface used by the update-thread to trigger property changed notification signals.
  37  */
  38 class PropertyNotifier
  39 {
  40 public:
  41   /**
  42    * Virtual destructor.
  43    */
  44   virtual ~PropertyNotifier() = default;
  45
  46   /**
  47    * Provide notification signals for a changed property.
  48    * This method should be called in the event-thread; the update-thread must use PropertyChangedMessage.
  49    * @param[in] notifyId A notifyId to the SceneGraph::PropertyNotification that has been mnodified.
  50    * @param[in] validity Passes in whether the notification was triggered by a true or false condition result
  51    */
  52   virtual void NotifyProperty(NotifierInterface::NotifyId notifyId, bool validity) = 0;
  53 };
  54
  55 /**
  56  * Notification message for when a property has been modified
  57  * @param[in] notifier This will provide the notification signal.
  58  */
  59 inline MessageBase* PropertyChangedMessage(PropertyNotifier& notifier, NotifierInterface::NotifyId notifyId, bool validity)
  60 {
  61   return new MessageValue2<PropertyNotifier, NotifierInterface::NotifyId, bool>(&notifier,
  62                                                                                 &PropertyNotifier::NotifyProperty,
  63                                                                                 notifyId,
  64                                                                                 validity);
  65 }
  66
  67 } // namespace Internal
  68
  69 } // namespace Dali
  70
  71 #endif // DALI_INTERNAL_PROPERTY_NOTIFIER_H