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    * Setting the properties of the visual, this API should only called by the VisualFactory
  70    * @param[in] propertyMap The properties for the requested Visual object.
  71    */
  72   void SetProperties( const Property::Map& propertyMap );
  73
  74   /**
  75    * @copydoc Toolkit::Visual::Base::SetName
  76    */
  77   void SetName( const std::string& name );
  78
  79   /**
  80    * @copydoc Toolkit::Visual::Base::GetName
  81    */
  82   const std::string& GetName();
  83
  84   /**
  85    * @copydoc Toolkit::Visual::Base::SetSize
  86    */
  87   void SetTransformAndSize( const Property::Map& transform, Size controlSize );
  88
  89   /**
  90    * @copydoc Toolkit::Visual::Base::GetHeightForWidth
  91    */
  92   virtual float GetHeightForWidth( float width ) const;
  93
  94   /**
  95    * @copydoc Toolkit::Visual::Base::GetNaturalSize
  96    */
  97   virtual void GetNaturalSize( Vector2& naturalSize );
  98
  99   /**
 100    * @copydoc Toolkit::Visual::Base::SetDepthIndex
 101    */
 102   void SetDepthIndex( float index );
 103
 104   /**
 105    * @copydoc Toolkit::Visual::Base::GetDepthIndex
 106    */
 107   float GetDepthIndex() const;
 108
 109   /**
 110    * @copydoc Toolkit::Visual::Base::SetOnStage
 111    * @pre Impl->mGeometry must be created before this method is called
 112    */
 113   void SetOnStage( Actor& actor );
 114
 115   /**
 116    * @copydoc Toolkit::Visual::Base::SetOffStage
 117    */
 118   void SetOffStage( Actor& actor );
 119
 120   /**
 121    * @copydoc Toolkit::Visual::Base::CreatePropertyMap
 122    */
 123   void CreatePropertyMap( Property::Map& map ) const;
 124
 125   /**
 126    * @brief Set whether the Pre-multiplied Alpha Blending is required
 127    *
 128    * @param[in] preMultipled whether alpha is pre-multiplied.
 129    */
 130   void EnablePreMultipliedAlpha( bool preMultipled );
 131
 132   /**
 133    * @brief Query whether alpha is pre-multiplied.
 134    *
 135    * @return True is alpha is pre-multiplied, false otherwise.
 136    */
 137   bool IsPreMultipliedAlphaEnabled() const;
 138
 139   /**
 140    * @brief Sets properties of custom shader
 141    * @param[in] propertyMap Property map containing the custom shader data
 142    */
 143   void SetCustomShader( const Property::Map& propertyMap );
 144
 145   /**
 146    * @copydoc Toolkit::Visual::Base::SetProperty
 147    */
 148   void SetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
 149
 150   /**
 151    * @copydoc Toolkit::Visual::Base::GetProperty
 152    */
 153   Dali::Property::Value GetProperty( Dali::Property::Index index );
 154
 155 protected:
 156
 157   /**
 158    * @brief Constructor.
 159    *
 160    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
 161    */
 162   Base( VisualFactoryCache& factoryCache );
 163
 164   /**
 165    * @brief A reference counted object may only be deleted by calling Unreference().
 166    */
 167   virtual ~Base();
 168
 169 protected:
 170   /**
 171    * @brief Called by CreatePropertyMap() allowing sub classes to respond to the CreatePropertyMap event
 172    *
 173    * @param[out] map The visual property map.
 174    */
 175   virtual void DoCreatePropertyMap( Property::Map& map ) const = 0;
 176
 177   /**
 178    * @brief Called by SetProperties() allowing sub classes to set their properties
 179    *
 180    * @param[in] propertyMap The properties for the requested Visual object.
 181    */
 182   virtual void DoSetProperties( const Property::Map& propertyMap ) = 0;
 183
 184   /**
 185    * @brief Called when transform or control size changes
 186    * ( Of use to SVG and Text visuals )
 187    */
 188   virtual void OnSetTransform() = 0;
 189
 190 protected:
 191
 192   /**
 193    * @brief Called by SetOnStage() allowing sub classes to respond to the SetOnStage event
 194    *
 195    * @note The derived class is required to create the renderer, and add it to the actor when all the resources are in place.
 196    *
 197    * @param[in] actor The actor applying this visual.
 198    */
 199   virtual void DoSetOnStage( Actor& actor )=0;
 200
 201   /**
 202    * @brief Called by SetOffStage() allowing sub classes to respond to the SetOffStage event
 203    *
 204    * @param[in] actor The actor applying this visual.
 205    */
 206   virtual void DoSetOffStage( Actor& actor );
 207
 208 protected:
 209
 210   /**
 211    * @brief Gets the on stage state for this Visual
 212    *
 213    * @return Returns true if this Visual is on stage, false if it is off the stage
 214    */
 215   bool IsOnStage() const;
 216
 217   /**
 218    * @brief Gets whether the Dali::Renderer is from a shared cache (and therefore any modifications will affect other users of that renderer)
 219    *
 220    * @return Returns true if the renderer is from shared cache, false otherwise
 221    */
 222   bool IsFromCache() const;
 223
 224 private:
 225
 226   // Undefined
 227   Base( const Visual::Base& visual );
 228
 229   // Undefined
 230   Base& operator=( const Visual::Base& visual );
 231
 232 protected:
 233   struct Impl;
 234   Impl* mImpl;
 235   VisualFactoryCache& mFactoryCache;
 236 };
 237
 238 typedef IntrusivePtr<Base> BasePtr;
 239
 240 } // namspace Visual
 241
 242 } // namespace Internal
 243
 244 inline const Internal::Visual::Base& GetImplementation(const Toolkit::Visual::Base& visualBase )
 245 {
 246   DALI_ASSERT_ALWAYS( visualBase && "visual base handle is empty" );
 247
 248   const BaseObject& handle = visualBase.GetBaseObject();
 249
 250   return static_cast<const Internal::Visual::Base&>(handle);
 251 }
 252
 253 inline Internal::Visual::Base& GetImplementation(Toolkit::Visual::Base& visualBase)
 254 {
 255   DALI_ASSERT_ALWAYS( visualBase && "visual base handle is empty" );
 256
 257   BaseObject& handle = visualBase.GetBaseObject();
 258
 259   return static_cast<Internal::Visual::Base&>(handle);
 260 }
 261
 262 } // namespace Toolkit
 263
 264 } // namespace Dali
 265
 266 #endif // DALI_TOOLKIT_INTERNAL_VISUAL_H