Rename OnStage signals and related internal changes
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / primitive / primitive-visual.h
index bc57a9b..806f594 100644 (file)
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_INTERNAL_PRIMITIVE_VISUAL_H
 
 /*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2019 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.
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
+// EXTERNAL INCLUDES
+#include <dali/public-api/common/intrusive-ptr.h>
 
 // INTERNAL INCLUDES
+#include <dali-toolkit/public-api/visuals/primitive-visual-properties.h>
 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
 
 namespace Dali
@@ -57,6 +60,9 @@ namespace Toolkit
 namespace Internal
 {
 
+class PrimitiveVisual;
+typedef IntrusivePtr< PrimitiveVisual > PrimitiveVisualPtr;
+
 /**
  * The visual which renders a simple 3D shape to the control's quad
  *
@@ -73,11 +79,11 @@ namespace Internal
  * | %Property Name    | Type        | Shapes Affected                          |
  * |-------------------|-------------|------------------------------------------|
  * | shapeColor        | VECTOR4     | all                                      |
- * | slices            | INTEGER     | sphere, cone, conical frustrum, cylinder |
+ * | slices            | INTEGER     | sphere, cone, conical frustum, cylinder  |
  * | stacks            | INTEGER     | sphere                                   |
- * | scaleTopRadius    | FLOAT       | conical frustrum                         |
- * | scaleBottomRadius | FLOAT       | cone, conical frustrum                   |
- * | scaleHeight       | FLOAT       | cone, conical frustrum, cylinder         |
+ * | scaleTopRadius    | FLOAT       | conical frustum                          |
+ * | scaleBottomRadius | FLOAT       | cone, conical frustum                    |
+ * | scaleHeight       | FLOAT       | cone, conical frustum, cylinder          |
  * | scaleRadius       | FLOAT       | cylinder                                 |
  * | scaleDimensions   | VECTOR3     | cube, octahedron, bevelled cube          |
  * | bevelPercentage   | FLOAT       | bevelled cube                            |
@@ -96,64 +102,62 @@ class PrimitiveVisual: public Visual::Base
 public:
 
   /**
-   * @brief Constructor.
+   * @brief Create a new primitive 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.
    */
-  PrimitiveVisual( VisualFactoryCache& factoryCache );
+  static PrimitiveVisualPtr New( VisualFactoryCache& factoryCache, const Property::Map& properties );
+
+public:  // from Visual
 
   /**
-   * @brief A reference counted object may only be deleted by calling Unreference().
+   * @copydoc Visual::Base::GetNaturalSize
    */
-  virtual ~PrimitiveVisual();
-
-public:  // from Visual
+  void GetNaturalSize( Vector2& naturalSize ) override;
 
   /**
-   * @copydoc Visual::SetSize
+   * @copydoc Visual::Base::CreatePropertyMap
    */
-  virtual void SetSize( const Vector2& size );
+  void DoCreatePropertyMap( Property::Map& map ) const override;
 
   /**
-   * @copydoc Visual::SetClipRect
+   * @copydoc Visual::Base::CreateInstancePropertyMap
    */
-  virtual void SetClipRect( const Rect<int>& clipRect );
+  void DoCreateInstancePropertyMap( Property::Map& map ) const override;
+
+protected:
 
   /**
-   * @copydoc Visual::SetOffset
+   * @brief Constructor.
+   *
+   * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
    */
-  virtual void SetOffset( const Vector2& offset );
+  PrimitiveVisual( VisualFactoryCache& factoryCache );
 
   /**
-   * @copydoc Visual::CreatePropertyMap
+   * @brief A reference counted object may only be deleted by calling Unreference().
    */
-  virtual void DoCreatePropertyMap( Property::Map& map ) const;
+  virtual ~PrimitiveVisual();
 
-protected:
+  /**
+   * @copydoc Visual::Base::DoSetProperties
+   */
+  void DoSetProperties( const Property::Map& propertyMap ) override;
 
   /**
-   * @copydoc Visual::DoInitialize
+   * @copydoc Visual::Base::DoSetOnScene
    */
-  virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap );
+  void DoSetOnScene( Actor& actor ) override;
 
   /**
-   * @copydoc Visual::DoSetOnStage
+   * @copydoc Visual::Base::OnSetTransform
    */
-  virtual void DoSetOnStage( Actor& actor );
+  void OnSetTransform() override;
 
 private:
 
-  enum PrimitiveType
-  {
-    SPHERE,
-    CONE,
-    CONICAL_FRUSTRUM,
-    CYLINDER,
-    CUBE,
-    OCTAHEDRON,
-    BEVELLED_CUBE
-  };
-
   //Simple struct to store the position and normal of a single vertex.
   struct Vertex
   {
@@ -321,8 +325,6 @@ private:
   Shader mShader;
   Geometry mGeometry;
 
-  std::string mShape;            //Shape to render, as string.
-  Vector4 mColor;                //Color of shape.
   Vector3 mObjectDimensions;     //Dimensions of shape, scaled to be between 0.0 and 1.0.
 
   Vector3 mSceneCenter;
@@ -342,7 +344,7 @@ private:
   int     mSlices;               ///< Number of slices to use when creating certain objects.
   int     mStacks;               ///< Number of stacks to use when creating certain objects.
 
-  PrimitiveType mPrimitiveType;  //Shape to render, as enum.
+  Toolkit::PrimitiveVisual::Shape::Type mPrimitiveType;  //Shape to render, as enum.
 };
 
 } // namespace Internal