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