[dali_2.3.21] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / border / border-visual.h
index c1e30d8..42ebe69 100644 (file)
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_INTERNAL_BORDER_VISUAL_H
 
 /*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,6 +19,7 @@
  */
 
 // EXTERNAL INCLUDES
+#include <dali/public-api/common/intrusive-ptr.h>
 #include <dali/public-api/rendering/geometry.h>
 
 // INTERNAL INCLUDES
 
 namespace Dali
 {
-
 namespace Toolkit
 {
-
 namespace Internal
 {
+class BorderVisual;
+typedef IntrusivePtr<BorderVisual> BorderVisualPtr;
 
 /**
  * The visual which renders a solid color to the control's quad border fixed to a specified size.
@@ -44,77 +45,62 @@ namespace Internal
  * | borderSize      | FLOAT       |
  * | antiAliasing    | BOOLEAN     |
  */
-
 class BorderVisual : public Visual::Base
 {
 public:
-
   /**
-   * @brief Constructor.
+   * @brief Create a new border visual.
    *
    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
+   * @param[in] properties A Property::Map containing settings for this visual
+   * @return A smart-pointer to the newly allocated visual.
    */
-  BorderVisual( VisualFactoryCache& factoryCache );
-
-  /**
-   * @brief A reference counted object may only be deleted by calling Unreference().
-   */
-  virtual ~BorderVisual();
+  static BorderVisualPtr New(VisualFactoryCache& factoryCache, const Property::Map& properties);
 
 protected:
-
   /**
-   * @copydoc Visual::Base::DoInitialize
+   * @brief Constructor.
+   *
+   * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
    */
-  virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap );
+  BorderVisual(VisualFactoryCache& factoryCache);
 
   /**
-   * @copydoc Visual::Base::DoSetOnStage
+   * @brief A reference counted object may only be deleted by calling Unreference().
    */
-  virtual void DoSetOnStage( Actor& actor );
+  virtual ~BorderVisual();
 
   /**
-   * @copydoc Visual::Base::CreatePropertyMap
+   * @copydoc Visual::Base::OnInitialize
    */
-  virtual void DoCreatePropertyMap( Property::Map& map ) const;
+  void OnInitialize() override;
 
   /**
-   * @copydoc Visual::Base::DoSetProperty
+   * @copydoc Visual::Base::DoSetProperties
    */
-  virtual void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
+  void DoSetProperties(const Property::Map& propertyMap) override;
 
   /**
-   * @copydoc Visual::Base::DoGetProperty
+   * @copydoc Visual::Base::DoSetOnScene
    */
-  virtual Dali::Property::Value DoGetProperty( Dali::Property::Index index );
-
-public:
+  void DoSetOnScene(Actor& actor) override;
 
   /**
-   * Set the color of the border.
-   * @param[in] color The border color.
+   * @copydoc Visual::Base::CreatePropertyMap
    */
-  void SetBorderColor( const Vector4& color);
+  void DoCreatePropertyMap(Property::Map& map) const override;
 
   /**
-   * Set the size of the border.
-   * @param[in] size The border size.
+   * @copydoc Visual::Base::CreateInstancePropertyMap
    */
-  void SetBorderSize( float size );
+  void DoCreateInstancePropertyMap(Property::Map& map) const override;
 
   /**
-   * Enable/Disable the anti-aliasing.
-   * @param[in] enable Whether the anti-aliasing be enabled or not.
+   * @copydoc Visual::Base::OnSetTransform
    */
-  void RequireAntiAliasing( bool antiAliasing );
+  void OnSetTransform() override;
 
 private:
-
-  /**
-   * @brief Initialize the renderer with the geometry and shader from the cache, if not available, create and save to the cache for sharing.
-   */
-  void InitializeRenderer();
-
   /**
    * Request the border shader from the factory cache. If fail, create tha shader and add it to cache.
    * @return The border shader.
@@ -127,14 +113,20 @@ private:
    */
   Geometry CreateBorderGeometry();
 
+  /**
+   * Helper method to set individual values by index key.
+   * @param[in] index The index key of the value
+   * @param[in] value The value
+   */
+  void DoSetProperty(Property::Index index, const Property::Value& value);
+
   // Undefined
-  BorderVisual( const BorderVisual& borderRenderer );
+  BorderVisual(const BorderVisual& borderRenderer);
 
   // Undefined
-  BorderVisual& operator=( const BorderVisual& borderRenderer );
+  BorderVisual& operator=(const BorderVisual& borderRenderer);
 
 private:
-
   Vector4 mBorderColor;
   float   mBorderSize;