dali/internal/update/common/scene-graph-connection-change-propagator.h

   1 #ifndef DALI_INTERNAL_SCENE_GRAPH_CONNECTION_CHANGE_PROPAGATOR_H
   2 #define DALI_INTERNAL_SCENE_GRAPH_CONNECTION_CHANGE_PROPAGATOR_H
   3
   4 /*
   5  * Copyright (c) 2015 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 #include <dali/public-api/common/dali-vector.h>
  21
  22 namespace Dali
  23 {
  24 namespace Internal
  25 {
  26 namespace SceneGraph
  27 {
  28 class PropertyOwner;
  29
  30 /**
  31  * This class maintains a list of observers that are informed when
  32  * it's owner changes it's connections.
  33  */
  34 class ConnectionChangePropagator
  35 {
  36 public:
  37   class Observer
  38   {
  39   public:
  40     /**
  41      * Inform the observer of the object that it's connections have changed
  42      * @param[in] object The connection owner
  43      */
  44     virtual void ConnectionsChanged(PropertyOwner& object) = 0;
  45
  46     /**
  47      * Inform the observer of the object that a connected object has
  48      * changed it's uniform map in some way.
  49      */
  50     virtual void ConnectedUniformMapChanged() = 0;
  51
  52     /**
  53      * Inform the observer of the object that the object is about to be destroyed
  54      */
  55     virtual void ObservedObjectDestroyed(PropertyOwner& object){}
  56   };
  57
  58   /**
  59    * Constructor
  60    */
  61   ConnectionChangePropagator();
  62
  63   /**
  64    * Destructor
  65    */
  66   ~ConnectionChangePropagator();
  67
  68   /**
  69    * Add an observer
  70    */
  71   void Add(Observer& observer);
  72
  73   /**
  74    * Remove an observer
  75    */
  76   void Remove(Observer& observer);
  77
  78   /**
  79    * Inform the observers that the connections to the object have changed
  80    * @param[in] object The connection owner
  81    */
  82   void ConnectionsChanged(PropertyOwner& object);
  83
  84   /**
  85    * Inform the observers that the uniform map of this or a connected object
  86    * has changed.
  87    */
  88   void ConnectedUniformMapChanged();
  89
  90   /**
  91    * Inform the observers that the object is about to be destroyed
  92    * @param[in] object The connection owner
  93    */
  94   void Destroy( PropertyOwner& object );
  95
  96 private:
  97   typedef Dali::Vector<Observer*> Observers;
  98   typedef Observers::Iterator ObserversIterator;
  99
 100   Observers mObservers;
 101 };
 102
 103
 104 } // SceneGraph
 105 } // Internal
 106 } // Dali
 107
 108 #endif // DALI_INTERNAL_SCENE_GRAPH_CONNECTION_CHANGE_PROPAGATOR_H