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) 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
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/animation/animation.h>
  23 #include <dali/public-api/common/intrusive-ptr.h>
  24 #include <dali/public-api/images/image-operations.h>
  25 #include <dali/public-api/object/base-object.h>
  26 #include <dali/public-api/rendering/renderer.h>
  27 #include <dali/public-api/rendering/shader.h>
  28
  29 // INTERNAL INCLUDES
  30 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
  31 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
  32 #include <dali-toolkit/internal/visuals/transition-data-impl.h>
  33 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
  34 #include <dali-toolkit/devel-api/direction-enums.h>
  35 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  36 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
  37
  38 namespace Dali
  39 {
  40
  41 namespace Toolkit
  42 {
  43
  44 namespace Internal
  45 {
  46
  47 namespace Visual
  48 {
  49
  50 class EventObserver;
  51
  52 using FittingMode = DevelVisual::FittingMode;
  53
  54 /**
  55  * Base class for all Control rendering logic. A control may have multiple visuals.
  56  *
  57  * Note: The visual responds to the the Actor::COLOR by blending it with the 'Multiply' operator.
  58  *
  59  * The following properties are optional
  60  *
  61  * | %Property Name          | Type             |
  62  * |-------------------------|------------------|
  63  * | customShader            | MAP              |
  64  *
  65  * where custom-shader is a map with the following properties:
  66  * | %Property Name          | Type             |
  67  * |-------------------------|------------------|
  68  * | vertexShader            | STRING           |
  69  * | fragmentShader          | STRING           |
  70  * | subdivideGridX          | INT              |
  71  * | subdivideGridY          | INT              |
  72  * | shaderHints             | INT              |
  73  */
  74 class Base : public BaseObject
  75 {
  76 public:
  77
  78   /**
  79    * Setting the properties of the visual, this API should only called by the VisualFactory
  80    * @param[in] propertyMap The properties for the requested Visual object.
  81    */
  82   void SetProperties( const Property::Map& propertyMap );
  83
  84   /**
  85    * @copydoc Toolkit::Visual::Base::SetName
  86    */
  87   void SetName( const std::string& name );
  88
  89   /**
  90    * @copydoc Toolkit::Visual::Base::GetName
  91    */
  92   const std::string& GetName() const;
  93
  94   /**
  95    * @copydoc Toolkit::Visual::Base::SetSize
  96    */
  97   void SetTransformAndSize( const Property::Map& transform, Size controlSize );
  98
  99   /**
 100    * @brief Performs an action on the visual with the given action name and attributes.
 101    *
 102    * @param[in] actionName The name of the action to perform this API only takes an Index
 103    * @param[in] attributes The list of attributes for the action. ( optional for this data structure to have content )
 104    */
 105   void DoAction( const Dali::Property::Index actionName, const Dali::Property::Value attributes );
 106
 107   /**
 108    * @copydoc Toolkit::Visual::Base::GetHeightForWidth
 109    */
 110   virtual float GetHeightForWidth( float width );
 111
 112   /**
 113    * @copydoc Toolkit::Visual::Base::GetWidthForHeight
 114    */
 115   virtual float GetWidthForHeight( float height );
 116
 117   /**
 118    * @copydoc Toolkit::Visual::Base::GetNaturalSize
 119    */
 120   virtual void GetNaturalSize( Vector2& naturalSize );
 121
 122   /**
 123    * @copydoc Toolkit::Visual::Base::SetDepthIndex
 124    */
 125   void SetDepthIndex( int index );
 126
 127   /**
 128    * @copydoc Toolkit::Visual::Base::GetDepthIndex
 129    */
 130   int GetDepthIndex() const;
 131
 132   /**
 133    * @copydoc Toolkit::Visual::Base::SetOnScene
 134    * @pre Impl->mGeometry must be created before this method is called
 135    */
 136   void SetOnScene( Actor& actor );
 137
 138   /**
 139    * @copydoc Toolkit::Visual::Base::SetOffScene
 140    */
 141   void SetOffScene( Actor& actor );
 142
 143   /**
 144    * @copydoc Toolkit::Visual::Base::CreatePropertyMap
 145    */
 146   void CreatePropertyMap( Property::Map& map ) const;
 147
 148   /**
 149    * @brief Create a property map containing per-instance visual properties.
 150    *
 151    * This will enable creation of new visuals on control state change with
 152    * any alternative style properties and the relevant instance properties
 153    * (e.g. for image visual, the desired size, and for text visual, the actual text).
 154    * @param[in] map The property map into which to write
 155    */
 156   void CreateInstancePropertyMap( Property::Map& map ) const;
 157
 158   /**
 159    * @brief Set whether the Pre-multiplied Alpha Blending is required
 160    *
 161    * @param[in] preMultiplied whether alpha is pre-multiplied.
 162    */
 163   void EnablePreMultipliedAlpha( bool preMultiplied );
 164
 165   /**
 166    * @brief Query whether alpha is pre-multiplied.
 167    *
 168    * @return True is alpha is pre-multiplied, false otherwise.
 169    */
 170   bool IsPreMultipliedAlphaEnabled() const;
 171
 172   /**
 173    * @brief Sets properties of custom shader
 174    * @param[in] propertyMap Property map containing the custom shader data
 175    */
 176   void SetCustomShader( const Property::Map& propertyMap );
 177
 178   /**
 179    * @copydoc Toolkit::Visual::Base::SetProperty
 180    */
 181   void SetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
 182
 183   /**
 184    * @copydoc Toolkit::Visual::Base::GetProperty
 185    */
 186   Dali::Property::Value GetProperty( Dali::Property::Index index );
 187
 188   /**
 189    * Gets currently staged renderer, or an empty handle if not staged
 190    */
 191   Renderer GetRenderer();
 192
 193   /**
 194    * Sets the mix color ( including opacity )  of the visual.
 195    * @param[in] mixColor The new mix color
 196    */
 197   void SetMixColor( const Vector4& color );
 198
 199   /**
 200    * Sets the mix color of the visual.
 201    * @param[in] mixColor The new mix color
 202    */
 203   void SetMixColor( const Vector3& color );
 204
 205   /**
 206    * Animate the property if it exists in the visual or renderer.
 207    *
 208    * If it's a visual property such as mix color or a transform property,
 209    * saves the target value to the local data.
 210    *
 211    * If the visual isn't staged (i.e. it doesn't have a renderer),
 212    * then this will not add an animation.
 213    *
 214    * If the animator is valid and the transition handle is empty - it will
 215    * be created.
 216    *
 217    * @param[in] transition The animation to create or attach to
 218    * @param[in] animator The animation parameters of the property.
 219    */
 220   void AnimateProperty( Dali::Animation& transition,
 221                         Internal::TransitionData::Animator& animator );
 222
 223   /**
 224    * @brief Add an observer to watch for when the Visuals have events to notify
 225    * Currently only supports a single observer
 226    */
 227   void AddEventObserver( Visual::EventObserver& observer );
 228
 229   /**
 230    * @brief Remove an observer
 231    */
 232   void RemoveEventObserver( Visual::EventObserver& observer );
 233
 234   /**
 235    * @brief Called when the visuals resources are loaded / ready
 236    */
 237   void ResourceReady( Toolkit::Visual::ResourceStatus resourceStatus );
 238
 239   /**
 240    * @brief Called when the visuals resources are loaded / ready
 241    * @return true if ready, false otherwise
 242    */
 243   virtual bool IsResourceReady() const;
 244
 245   /**
 246    * @brief Get the loading state of the visual resource
 247    * @return Return the loading status (PREPARING, READY and FAILED) of visual resource
 248    */
 249   Toolkit::Visual::ResourceStatus GetResourceStatus() const;
 250
 251   /**
 252    * @brief Get the fitting mode for the visual
 253    */
 254   FittingMode GetFittingMode() const;
 255
 256   /**
 257    * @brief Get the actual Visual Object.
 258    * @return The actual visual object
 259    * @note Should be overridden by deriving controls if they are acting as a proxy to other visual objects.
 260    */
 261   virtual Base& GetVisualObject();
 262
 263   /**
 264    * @brief Query whether resources requires to be loaded synchronously.
 265    * @return Returns true if synchronous resource loading is required, false otherwise.
 266    */
 267   bool IsSynchronousLoadingRequired() const;
 268
 269   /**
 270    * @brief Get the type of this visual.
 271    *
 272    * @return The the type of this visual.
 273    */
 274   Toolkit::Visual::Type GetType() const;
 275
 276   /**
 277    * @brief Retrieve the property object associated with the property key.
 278    *
 279    * @param[in] key The Property key of the visual.
 280    * @return The Property object
 281    */
 282   Dali::Property GetPropertyObject(Dali::Property::Key key);
 283
 284 protected:
 285   /**
 286    * @brief Constructor.
 287    *
 288    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
 289    * @param[in] fittingMode The value that determines how the visual should be fit to the view
 290    * @param[in] type The type of the this visual
 291    */
 292   Base( VisualFactoryCache& factoryCache, FittingMode fittingMode, Toolkit::Visual::Type type );
 293
 294   /**
 295    * @brief A reference counted object may only be deleted by calling Unreference().
 296    */
 297   ~Base() override;
 298
 299   /**
 300    * @brief Second-phase constructor.
 301    */
 302   void Initialize();
 303
 304 protected:
 305   /**
 306    * @brief Called by Initialize() allowing sub classes to initialize them.
 307    */
 308   virtual void OnInitialize() = 0;
 309
 310   /**
 311    * @brief Called by CreatePropertyMap() allowing sub classes to respond to the CreatePropertyMap event
 312    *
 313    * @param[out] map The visual property map.
 314    */
 315   virtual void DoCreatePropertyMap( Property::Map& map ) const = 0;
 316
 317   /**
 318    * @brief Called by CreateInstancePropertyMap() allowing derived
 319    * classes to store instanced data (separate to styled data) that
 320    * needs copying between visuals on state change.
 321    *
 322    * @param[out] map The visual property map
 323    */
 324   virtual void DoCreateInstancePropertyMap( Property::Map& map ) const = 0;
 325
 326   /**
 327    * @brief Called by SetProperties() allowing sub classes to set their properties
 328    *
 329    * @param[in] propertyMap The properties for the requested Visual object.
 330    */
 331   virtual void DoSetProperties( const Property::Map& propertyMap ) = 0;
 332
 333   /**
 334    * @brief Called when transform or control size changes
 335    * ( Of use to SVG and Text visuals )
 336    */
 337   virtual void OnSetTransform() = 0;
 338
 339   /**
 340    * @brief Called by SetOnScene() allowing sub classes to respond to the SetOnScene event
 341    *
 342    * @note The derived class is required to create the renderer, and add it to the actor when all the resources are in place.
 343    *
 344    * @param[in] actor The actor applying this visual.
 345    */
 346   virtual void DoSetOnScene( Actor& actor ) = 0;
 347
 348   /**
 349    * @brief Called by SetOffScene() allowing sub classes to respond to the SetOffScene event
 350    *
 351    * @param[in] actor The actor applying this visual.
 352    */
 353   virtual void DoSetOffScene( Actor& actor );
 354
 355   /**
 356    * @brief Called by DoAction() allowing sub classes to do the given action.
 357    *
 358    * @param[in] actionId The action to perform
 359    * @param[in] attributes The list of attributes for the action. ( optional for this data structure to have content )
 360    */
 361   virtual void OnDoAction( const Property::Index actionId, const Property::Value& attributes );
 362
 363   /**
 364    * @brief Update the shader when some properties are changed.
 365    */
 366   virtual void UpdateShader()
 367   {
 368   }
 369
 370   /**
 371    * @brief Called by GetPropertyObject() allowing sub classes to respond to the GetPropertyObject event
 372    * @note The derived class is required to register the given property.
 373    * @param[in] key The key of the visual's property.
 374    * @return The Property object
 375    */
 376   virtual Dali::Property OnGetPropertyObject(Dali::Property::Key key)
 377   {
 378     Handle handle;
 379     return Dali::Property(handle, Property::INVALID_INDEX);
 380   }
 381
 382 protected:
 383
 384   /**
 385    * @brief Gets the on scene state for this Visual
 386    *
 387    * @return Returns true if this Visual is on the scene, false if it is off the scene
 388    */
 389   bool IsOnScene() const;
 390
 391   /**
 392    * @brief Query whether the corners of the visual requires to be rounded.
 393    *
 394    * @return Returns true if the rounded corner is required, false otherwise.
 395    */
 396   bool IsRoundedCornerRequired() const;
 397
 398 private:
 399
 400   /**
 401    * Register the mix color uniform on the Renderer and store the property index.
 402    * Note, this is not used by Color or Primitive Visuals, which will use their
 403    * own property index.
 404    */
 405   void RegisterMixColor();
 406
 407   /**
 408    * Find the matching property on the renderer or shader. If it's a shader
 409    * property, register it on the renderer in order to animate it for this
 410    * visual independently.
 411    * @param[in] key The key to match.
 412    * @return the matching index, or INVALID_INDEX if it's not found
 413    */
 414   Property::Index GetPropertyIndex( Property::Key key );
 415
 416   /**
 417    * Set up the transition. If no animation is required, then
 418    * transition will be untouched.
 419    *
 420    * @param[in] transition The transition to use or set up.
 421    * @param[in] animator The animation data to use
 422    * @param[in] index The property index on the renderer to animate
 423    * @param[in] initialValue The optional initial value
 424    * @param[in] targetValue The target value to use
 425    */
 426   void SetupTransition( Dali::Animation& transition,
 427                         Internal::TransitionData::Animator& animator,
 428                         Property::Index index,
 429                         Property::Value& initialValue,
 430                         Property::Value& targetValue );
 431
 432   /**
 433    * Animate the opacity property - Special handling to
 434    * ensure that the blend mode is set to ON whilst animating,
 435    * and set back to AUTO if it's opaque at the end of the
 436    * animation.
 437    *
 438    * @param[in] transition The transition to use or set up.
 439    * @param[in] animator The animation data to use
 440    */
 441   void AnimateOpacityProperty( Dali::Animation& transition,
 442                                Internal::TransitionData::Animator& animator );
 443
 444   /**
 445    * Animate the renderer property - no special handling
 446    *
 447    * @param[in] transition The transition to use or set up.
 448    * @param[in] animator The animation data to use
 449    */
 450   void AnimateRendererProperty( Dali::Animation& transition,
 451                                 Internal::TransitionData::Animator& animator );
 452
 453   /**
 454    * Animate the mix color property.
 455    *
 456    * If the animator is a vec3, then it only animates the color
 457    * channels without animating the opacity.  If it's a vec4, then it
 458    * runs 2 animators, one for the the vec3 mixColor, and one for the
 459    * opacity. (They are separate uniforms in the shader )
 460    *
 461    * @param[in] transition The transition to use or set up.
 462    * @param[in] animator The animation data to use
 463    */
 464   void AnimateMixColorProperty( Dali::Animation& transition,
 465                                 Internal::TransitionData::Animator& animator );
 466
 467   // Undefined
 468   Base( const Visual::Base& visual );
 469
 470   // Undefined
 471   Base& operator=( const Visual::Base& visual );
 472
 473 protected:
 474   struct Impl;
 475   Impl* mImpl;
 476   VisualFactoryCache& mFactoryCache;
 477 };
 478
 479 typedef IntrusivePtr<Base> BasePtr;
 480
 481 } // namspace Visual
 482
 483 } // namespace Internal
 484
 485 inline const Internal::Visual::Base& GetImplementation(const Toolkit::Visual::Base& visualBase )
 486 {
 487   DALI_ASSERT_ALWAYS( visualBase && "visual base handle is empty" );
 488
 489   const BaseObject& handle = visualBase.GetBaseObject();
 490
 491   return static_cast<const Internal::Visual::Base&>(handle);
 492 }
 493
 494 inline Internal::Visual::Base& GetImplementation(Toolkit::Visual::Base& visualBase)
 495 {
 496   DALI_ASSERT_ALWAYS( visualBase && "visual base handle is empty" );
 497
 498   BaseObject& handle = visualBase.GetBaseObject();
 499
 500   return static_cast<Internal::Visual::Base&>(handle);
 501 }
 502
 503 } // namespace Toolkit
 504
 505 } // namespace Dali
 506
 507 #endif // DALI_TOOLKIT_INTERNAL_VISUAL_H