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