dali-toolkit/internal/visuals/visual-base-impl.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_VISUAL_H
   2 #define DALI_TOOLKIT_INTERNAL_VISUAL_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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/common/intrusive-ptr.h>
  23 #include <dali/public-api/images/image-operations.h>
  24 #include <dali/public-api/object/base-object.h>
  25 #include <dali/public-api/rendering/shader.h>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
  29 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
  30 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
  31
  32 namespace Dali
  33 {
  34
  35 namespace Toolkit
  36 {
  37
  38 namespace Internal
  39 {
  40
  41 namespace Visual
  42 {
  43
  44 /**
  45  * Base class for all Control rendering logic. A control may have multiple visuals.
  46  *
  47  * Note: The visual responds to the the Actor::COLOR by blending it with the 'Multiply' operator.
  48  *
  49  * The following properties are optional
  50  *
  51  * | %Property Name          | Type             |
  52  * |-------------------------|------------------|
  53  * | customShader            | MAP              |
  54  *
  55  * where custom-shader is a map with the following properties:
  56  * | %Property Name          | Type             |
  57  * |-------------------------|------------------|
  58  * | vertexShader            | STRING           |
  59  * | fragmentShader          | STRING           |
  60  * | subdivideGridX          | INT              |
  61  * | subdivideGridY          | INT              |
  62  * | shaderHints             | INT              |
  63  */
  64 class Base : public BaseObject
  65 {
  66 public:
  67
  68   /**
  69    *  Initialisation of the visual, this API should only called by the VisualFactory:
  70    *  request the geometry and shader from the cache, if not available, create and save to the cache for sharing;
  71    *  record the property values.
  72    *
  73    * @param[in] actor The Actor the visual is applied to if, empty if the visual has not been applied to any Actor
  74    * @param[in] propertyMap The properties for the requested Visual object.
  75    */
  76   void Initialize( Actor& actor, const Property::Map& propertyMap );
  77
  78   /**
  79    * @copydoc Toolkit::Visual::Base::SetSize
  80    */
  81   virtual void SetSize( const Vector2& size );
  82
  83   /**
  84    * @copydoc Toolkit::Visual::Base::GetSize
  85    */
  86   const Vector2& GetSize() const;
  87
  88   /**
  89    * @copydoc Toolkit::Visual::Base::GetHeightForWidth
  90    */
  91   virtual float GetHeightForWidth( float width ) const;
  92
  93   /**
  94    * @copydoc Toolkit::Visual::Base::GetNaturalSize
  95    */
  96   virtual void GetNaturalSize( Vector2& naturalSize ) const;
  97
  98   /**
  99    * @copydoc Toolkit::Visual::Base::SetDepthIndex
 100    */
 101   void SetDepthIndex( float index );
 102
 103   /**
 104    * @copydoc Toolkit::Visual::Base::GetDepthIndex
 105    */
 106   float GetDepthIndex() const;
 107
 108   /**
 109    * @copydoc Toolkit::Visual::Base::SetOnStage
 110    * @pre Impl->mGeometry must be created before this method is called
 111    */
 112   void SetOnStage( Actor& actor );
 113
 114   /**
 115    * @copydoc Toolkit::Visual::Base::SetOffStage
 116    */
 117   void SetOffStage( Actor& actor );
 118
 119   /**
 120    * @copydoc Toolkit::Visual::Base::CreatePropertyMap
 121    */
 122   void CreatePropertyMap( Property::Map& map ) const;
 123
 124   /**
 125    * @brief Set whether the Pre-multiplied Alpha Blending is required
 126    *
 127    * @param[in] preMultipled whether alpha is pre-multiplied.
 128    */
 129   void EnablePreMultipliedAlpha( bool preMultipled );
 130
 131   /**
 132    * @brief Query whether alpha is pre-multiplied.
 133    *
 134    * @return True is alpha is pre-multiplied, false otherwise.
 135    */
 136   bool IsPreMultipliedAlphaEnabled() const;
 137
 138   /**
 139    * @brief Sets properties of custom shader
 140    * @param[in] propertyMap Property map containing the custom shader data
 141    */
 142   void SetCustomShader( const Property::Map& propertyMap );
 143
 144   /**
 145    * @copydoc Toolkit::Visual::Base::SetProperty
 146    */
 147   void SetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
 148
 149   /**
 150    * @copydoc Toolkit::Visual::Base::GetProperty
 151    */
 152   Dali::Property::Value GetProperty( Dali::Property::Index index );
 153
 154 protected:
 155
 156   /**
 157    * @brief Constructor.
 158    *
 159    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
 160    */
 161   Base( VisualFactoryCache& factoryCache );
 162
 163   /**
 164    * @brief A reference counted object may only be deleted by calling Unreference().
 165    */
 166   virtual ~Base();
 167
 168 protected:
 169   /**
 170    * @brief Called by CreatePropertyMap() allowing sub classes to respond to the CreatePropertyMap event
 171    *
 172    * @param[out] map The visual property map.
 173    */
 174   virtual void DoCreatePropertyMap( Property::Map& map ) const = 0;
 175
 176   /**
 177    * @brief Called by Initialize() allowing sub classes to respond to the Initialize event
 178    *
 179    * @param[in] actor The Actor the visual is applied to if, empty if the visual has not been applied to any Actor
 180    * @param[in] propertyMap The properties for the requested Visual object.
 181    */
 182   virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap ) {}
 183
 184 protected:
 185
 186   /**
 187    * @brief Called by SetOnStage() allowing sub classes to respond to the SetOnStage event
 188    *
 189    * @note The derived class is required to create the renderer, and add it to the actor when all the resources are in place.
 190    *
 191    * @param[in] actor The actor applying this visual.
 192    */
 193   virtual void DoSetOnStage( Actor& actor )=0;
 194
 195   /**
 196    * @brief Called by SetOffStage() allowing sub classes to respond to the SetOffStage event
 197    *
 198    * @param[in] actor The actor applying this visual.
 199    */
 200   virtual void DoSetOffStage( Actor& actor );
 201
 202 protected:
 203
 204   /**
 205    * @brief Gets the on stage state for this Visual
 206    *
 207    * @return Returns true if this Visual is on stage, false if it is off the stage
 208    */
 209   bool IsOnStage() const;
 210
 211   /**
 212    * @brief Gets whether the Dali::Renderer is from a shared cache (and therefore any modifications will affect other users of that renderer)
 213    *
 214    * @return Returns true if the renderer is from shared cache, false otherwise
 215    */
 216   bool IsFromCache() const;
 217
 218 protected:
 219   /**
 220    * @brief Called by SetProperty(). To be overriden by derived clases in order to set properties.
 221    *
 222    * @param [in] index The index of the property.
 223    * @param [in] propertyValue The new value of the property.
 224    */
 225   virtual void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue ) = 0;
 226
 227   /**
 228    * @brief Called by GetProperty(). To be overriden by derived classes in order to retrieve properties.
 229    *
 230    * @param [in] index The index of the property.
 231    *
 232    * @return The property value.
 233    */
 234   virtual Dali::Property::Value DoGetProperty( Dali::Property::Index index ) = 0;
 235
 236 private:
 237
 238   // Undefined
 239   Base( const Visual::Base& visual );
 240
 241   // Undefined
 242   Base& operator=( const Visual::Base& visual );
 243
 244 protected:
 245   struct Impl;
 246   Impl* mImpl;
 247   VisualFactoryCache& mFactoryCache;
 248 };
 249
 250 typedef IntrusivePtr<Base> BasePtr;
 251
 252 } // namspace Visual
 253
 254 } // namespace Internal
 255
 256 inline const Internal::Visual::Base& GetImplementation(const Toolkit::Visual::Base& visualBase )
 257 {
 258   DALI_ASSERT_ALWAYS( visualBase && "visual base handle is empty" );
 259
 260   const BaseObject& handle = visualBase.GetBaseObject();
 261
 262   return static_cast<const Internal::Visual::Base&>(handle);
 263 }
 264
 265 inline Internal::Visual::Base& GetImplementation(Toolkit::Visual::Base& visualBase)
 266 {
 267   DALI_ASSERT_ALWAYS( visualBase && "visual base handle is empty" );
 268
 269   BaseObject& handle = visualBase.GetBaseObject();
 270
 271   return static_cast<Internal::Visual::Base&>(handle);
 272 }
 273
 274 } // namespace Toolkit
 275
 276 } // namespace Dali
 277
 278 #endif // DALI_TOOLKIT_INTERNAL_VISUAL_H