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