dali/internal/event/common/property-buffer-impl.h

   1 #ifndef DALI_INTERNAL_PROPERTY_BUFFER_H
   2 #define DALI_INTERNAL_PROPERTY_BUFFER_H
   3
   4 /*
   5  * Copyright (c) 2016 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/public-api/common/dali-common.h> // DALI_ASSERT_ALWAYS
  23 #include <dali/public-api/common/intrusive-ptr.h> // Dali::IntrusivePtr
  24 #include <dali/public-api/object/base-object.h>
  25 #include <dali/public-api/object/property-map.h> // Dali::Property::Map
  26 #include <dali/internal/event/common/event-thread-services.h>
  27 #include <dali/internal/render/renderers/render-property-buffer.h>
  28
  29 namespace Dali
  30 {
  31 namespace Internal
  32 {
  33
  34 class PropertyBuffer;
  35 typedef IntrusivePtr<PropertyBuffer> PropertyBufferPtr;
  36
  37 /**
  38  * PropertyBuffer is an object that contains an array of structures of values that
  39  * can be accessed as properties.
  40  */
  41 class PropertyBuffer : public BaseObject
  42 {
  43 public:
  44
  45   /**
  46    * @copydoc PropertBuffer::New()
  47    */
  48   static PropertyBufferPtr New( Dali::Property::Map& format );
  49
  50   /**
  51    * @copydoc PropertBuffer::SetData()
  52    */
  53   void SetData( const void* data, std::size_t size );
  54
  55   /**
  56    * @copydoc PropertBuffer::GetSize()
  57    */
  58   std::size_t GetSize() const;
  59
  60 public: // Default property extensions from Object
  61
  62   /**
  63    * @brief Get the render thread side of the PropertyBuffer
  64    *
  65    * @return The render thread side of this PropertyBuffer
  66    */
  67   const Render::PropertyBuffer* GetRenderObject() const;
  68
  69 protected:
  70   /**
  71    * @brief Destructor
  72    */
  73   ~PropertyBuffer();
  74
  75 private: // implementation
  76   /**
  77    * @brief Default constructor
  78    */
  79   PropertyBuffer();
  80
  81   /**
  82    * Second stage initialization
  83    */
  84   void Initialize( Dali::Property::Map& format );
  85
  86 private: // unimplemented methods
  87   PropertyBuffer( const PropertyBuffer& );
  88   PropertyBuffer& operator=( const PropertyBuffer& );
  89
  90 private: // data
  91   EventThreadServices& mEventThreadServices;    ///<Used to send messages to the render thread via update thread
  92   Render::PropertyBuffer* mRenderObject; ///<Render side object
  93
  94   Property::Map mFormat;  ///< Format of the property buffer
  95   const Render::PropertyBuffer::Format* mBufferFormat;  ///< Metadata for the format of the property buffer
  96   unsigned int mSize; ///< Number of elements in the buffer
  97   Dali::Vector< char > mBuffer; // Data of the property-buffer
  98 };
  99
 100 /**
 101  * Get the implementation type from a Property::Type
 102  */
 103 template<Property::Type type> struct PropertyImplementationType
 104 {
 105   // typedef ... Type; not defined, only support types declared bellow
 106 };
 107 template<> struct PropertyImplementationType< Property::BOOLEAN > { typedef bool Type; };
 108 template<> struct PropertyImplementationType< Property::FLOAT > { typedef float Type; };
 109 template<> struct PropertyImplementationType< Property::INTEGER > { typedef int Type; };
 110 template<> struct PropertyImplementationType< Property::VECTOR2 > { typedef Vector2 Type; };
 111 template<> struct PropertyImplementationType< Property::VECTOR3 > { typedef Vector3 Type; };
 112 template<> struct PropertyImplementationType< Property::VECTOR4 > { typedef Vector4 Type; };
 113 template<> struct PropertyImplementationType< Property::MATRIX3 > { typedef Matrix3 Type; };
 114 template<> struct PropertyImplementationType< Property::MATRIX > { typedef Matrix Type; };
 115 template<> struct PropertyImplementationType< Property::RECTANGLE > { typedef Rect<int> Type; };
 116 template<> struct PropertyImplementationType< Property::ROTATION > { typedef Quaternion Type; };
 117
 118 unsigned int GetPropertyImplementationSize( Property::Type& propertyType );
 119
 120 } // namespace Internal
 121
 122 // Helpers for public-api forwarding methods
 123 inline Internal::PropertyBuffer& GetImplementation(Dali::PropertyBuffer& handle)
 124 {
 125   DALI_ASSERT_ALWAYS(handle && "PropertyBuffer handle is empty");
 126
 127   BaseObject& object = handle.GetBaseObject();
 128
 129   return static_cast<Internal::PropertyBuffer&>(object);
 130 }
 131
 132 inline const Internal::PropertyBuffer& GetImplementation(const Dali::PropertyBuffer& handle)
 133 {
 134   DALI_ASSERT_ALWAYS(handle && "PropertyBuffer handle is empty");
 135
 136   const BaseObject& object = handle.GetBaseObject();
 137
 138   return static_cast<const Internal::PropertyBuffer&>(object);
 139 }
 140
 141 } // namespace Dali
 142
 143 #endif // DALI_INTERNAL_PROPERTY_BUFFER_H