dali/internal/update/common/uniform-map.h

   1 #ifndef DALI_INTERNAL_SCENE_GRAPH_UNIFORM_MAP_H
   2 #define DALI_INTERNAL_SCENE_GRAPH_UNIFORM_MAP_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 // EXTERNAL INCLUDES
  21 #include <cstdint> // uint32_t
  22 #include <string>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/devel-api/common/hash.h>
  26 #include <dali/devel-api/common/owner-container.h>
  27 #include <dali/internal/common/const-string.h>
  28
  29 namespace Dali
  30 {
  31 namespace Internal
  32 {
  33 class PropertyInputImpl;
  34
  35 namespace SceneGraph
  36 {
  37 /**
  38  * The uniform map is used to map a uniform name to a property value.
  39  */
  40 class UniformPropertyMapping
  41 {
  42 public:
  43   using Hash = unsigned long;
  44
  45   /**
  46    * Constructor
  47    */
  48   UniformPropertyMapping(ConstString theUniformName, const PropertyInputImpl* thePropertyPtr)
  49   : propertyPtr(thePropertyPtr),
  50     uniformName(theUniformName),
  51     uniformNameHash(0u),
  52     uniformNameHashNoArray(0u),
  53     arrayIndex(0u)
  54   {
  55     // Look for array index closing bracket
  56     auto pos = theUniformName.GetStringView().rfind("]");
  57
  58     // If found, extract the array index and store it
  59     if(pos != std::string::npos)
  60     {
  61       auto pos0  = theUniformName.GetStringView().rfind("[", pos);
  62       arrayIndex = atoi(theUniformName.GetCString() + pos0 + 1);
  63       // Calculate hash from name without array index
  64       uniformNameHashNoArray = Dali::CalculateHash(theUniformName.GetStringView().substr(0, pos0).data());
  65     }
  66     uniformName     = theUniformName;
  67     uniformNameHash = Dali::CalculateHash(theUniformName.GetCString());
  68   }
  69
  70   UniformPropertyMapping() = default;
  71
  72   const PropertyInputImpl* propertyPtr{nullptr};
  73   ConstString              uniformName{};
  74   Hash                     uniformNameHash{0u};
  75   Hash                     uniformNameHashNoArray{0u};
  76   int32_t                  arrayIndex{0u};
  77 };
  78
  79 /**
  80  * The UniformMap class is used to map uniform names to property values. It is available
  81  * in all of the classes responsible for rendering:
  82  * Actor, Renderer, Geometry, TextureSet, Shader.
  83  *
  84  * It can be observed for changes to the mapping table.
  85  */
  86 class UniformMap
  87 {
  88 public:
  89   using SizeType = uint32_t;
  90
  91   class Observer
  92   {
  93   public:
  94     /**
  95      * Inform observer that uniform mappings have been changed
  96      * @param mappings
  97      */
  98     virtual void UniformMappingsChanged(const UniformMap& mappings) = 0;
  99
 100   protected:
 101     /**
 102      * Virtual destructor, no deletion through this interface
 103      */
 104     virtual ~Observer() = default;
 105   };
 106
 107   /**
 108    * Add an observer that watches for changes in the mappings
 109    */
 110   void AddObserver(Observer& observer);
 111
 112   /**
 113    * Remove an observer
 114    */
 115   void RemoveObserver(Observer& observer);
 116
 117   /**
 118    * Add a map to the mappings table.
 119    */
 120   void Add(UniformPropertyMapping map);
 121
 122   /**
 123    * Remove a map from the mappings table
 124    */
 125   void Remove(ConstString uniformName);
 126
 127   /**
 128    * Find a property given the uniform name.
 129    * @return The address of the property if it's in the map, or NULL otherwise.
 130    */
 131   const PropertyInputImpl* Find(ConstString uniformName);
 132
 133   /**
 134    * Get the count of uniforms in the map
 135    * @return The number of uniform mappings
 136    */
 137   SizeType Count() const;
 138
 139   /**
 140    * @pre index must be in the range 0 :: Count()-1
 141    * @param[in] index The index of the element to fetch
 142    * @return reference to the element in the map
 143    */
 144   const UniformPropertyMapping& operator[](SizeType index) const;
 145
 146 private:
 147   /**
 148    * Helper to call the observers when the mappings have changed
 149    */
 150   void MappingChanged();
 151
 152 private:
 153   using UniformMapContainer = Dali::Vector<UniformPropertyMapping>;
 154   using UniformMapIter      = UniformMapContainer::Iterator;
 155   using Observers           = Dali::Vector<Observer*>;
 156   using ObserversIter       = Observers::Iterator;
 157
 158   UniformMapContainer mUniformMaps; // Owner container of uniform maps
 159
 160   Observers mObservers;
 161 };
 162
 163 } // namespace SceneGraph
 164 } // namespace Internal
 165 } // namespace Dali
 166
 167 #endif // DALI_INTERNAL_SCENE_GRAPH_UNIFORM_MAP_H