dali-toolkit/devel-api/controls/canvas-view/canvas-view.h

   1 #ifndef DALI_TOOLKIT_CANVAS_VIEW_H
   2 #define DALI_TOOLKIT_CANVAS_VIEW_H
   3
   4 /*
   5  * Copyright (c) 2022 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 // INTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/controls/control.h>
  23
  24 // EXTERNAL INCLUDES
  25 #include <dali/devel-api/adaptor-framework/canvas-renderer/canvas-renderer-drawable.h>
  26 #include <dali/devel-api/adaptor-framework/canvas-renderer/canvas-renderer-shape.h>
  27
  28 namespace Dali
  29 {
  30 namespace Toolkit
  31 {
  32 namespace Internal DALI_INTERNAL
  33 {
  34 class CanvasView;
  35 }
  36 /**
  37  * @addtogroup dali_toolkit_controls_canvas_view
  38  * @{
  39  */
  40
  41 /**
  42  * @brief CanvasView is a class for displaying an vector primitives.
  43  *
  44  * @code
  45  *    auto myCanvasView = CanvasView::New( viewBox ) ); //The viewBox is the size of viewbox of CanvasView.
  46  *
  47  *    //Create shape and set properties.
  48  *    auto shape = Dali::CanvasRenderer::Shape::New();
  49  *    shape.AddRect( 0, 0, 10, 10, 0, 0 );
  50  *    shape.SetFillColor( Vector4( 1.0, 1.0, 1.0, 1.0 ) );
  51  *    myCanvasView.AddDrawable( shape );
  52  * @endcode
  53  *
  54  * @section CanvasViewProperties Properties
  55  * |%Property enum                    |String name          |Type            |Writable|Animatable|
  56  * |----------------------------------|---------------------|----------------|--------|----------|
  57  * | Property::VIEW_BOX               | viewBox             |  Vector2       | O      | X        |
  58  *
  59  */
  60 class DALI_TOOLKIT_API CanvasView : public Control
  61 {
  62 public:
  63   /**
  64    * @brief The start and end property ranges for this control.
  65    */
  66   enum PropertyRange
  67   {
  68     PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
  69   };
  70
  71   /**
  72    * @brief An enumeration of properties belonging to the CanvasView class.
  73    */
  74   struct Property
  75   {
  76     /**
  77      * @brief An enumeration of properties belonging to the CanvasView class.
  78      */
  79     enum
  80     {
  81       /**
  82        * @brief the viewbox of the CanvasView.
  83        * @details Name "viewBox", type Property::VECTOR2.
  84        */
  85       VIEW_BOX = PROPERTY_START_INDEX,
  86     };
  87   };
  88 public:
  89   /**
  90    * @brief Creates an uninitialized CanvasView.
  91    */
  92   CanvasView();
  93
  94   /**
  95    * @brief Creates an initialized CanvasView
  96    *
  97    * @return A handle to a newly allocated CanvasView
  98    */
  99   static CanvasView New();
 100
 101   /**
 102    * @brief Creates an initialized CanvasView
 103    *
 104    * @param [in] viewBox The width and height.
 105    * @return A handle to a newly allocated CanvasView
 106    */
 107   static CanvasView New(const Vector2& viewBox);
 108
 109   /**
 110    * @brief Destructor.
 111    *
 112    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 113    */
 114   ~CanvasView();
 115
 116   /**
 117    * @brief Copy constructor.
 118    *
 119    * @param[in] canvasView CanvasView to copy. The copied CanvasView will point at the same implementation
 120    */
 121   CanvasView(const CanvasView& canvasView);
 122
 123   /**
 124    * @brief Move constructor
 125    *
 126    * @param[in] rhs A reference to the moved handle
 127    */
 128   CanvasView(CanvasView&& rhs);
 129
 130   /**
 131    * @brief Assignment operator.
 132    *
 133    * @param[in] canvasView The CanvasView to assign from
 134    * @return The updated CanvasView
 135    */
 136   CanvasView& operator=(const CanvasView& canvasView);
 137
 138   /**
 139    * @brief Move assignment
 140    *
 141    * @param[in] rhs A reference to the moved handle
 142    * @return A reference to this
 143    */
 144   CanvasView& operator=(CanvasView&& rhs);
 145
 146   /**
 147    * @brief Downcasts a handle to CanvasView handle.
 148    *
 149    * If handle points to a CanvasView, the downcast produces valid handle.
 150    * If not, the returned handle is left uninitialized.
 151    *
 152    * @param[in] handle Handle to an object
 153    * @return Handle to a CanvasView or an uninitialized handle
 154    */
 155   static CanvasView DownCast(BaseHandle handle);
 156
 157   /**
 158    * @brief Add drawable object to the CanvasView.
 159    * This method is similar to registration. The added shape is drawn on the inner canvas.
 160    * @param[in] drawable the drawable object.
 161    */
 162   void AddDrawable(Dali::CanvasRenderer::Drawable& drawable);
 163
 164   /**
 165    * @brief Remove drawable object to the CanvasView.
 166    * This method is similar to deregistration.
 167    * @param[in] drawable the drawable object.
 168    * @return Returns True when it's successful. False otherwise.
 169    */
 170   bool RemoveDrawable(Dali::CanvasRenderer::Drawable& drawable);
 171
 172   /**
 173    * @brief Remove all drawable objects added to the CanvasView.
 174    */
 175   void RemoveAllDrawables();
 176
 177 public: // Not intended for application developers
 178   /// @cond internal
 179   /**
 180    * @brief Creates a handle using the Toolkit::Internal implementation.
 181    *
 182    * @param[in] implementation The CanvasView implementation
 183    */
 184   DALI_INTERNAL CanvasView(Internal::CanvasView& implementation);
 185
 186   /**
 187    * @brief Allows the creation of this CanvasView from an Internal::CustomActor pointer.
 188    *
 189    * @param[in] internal A pointer to the internal CustomActor
 190    */
 191   DALI_INTERNAL CanvasView(Dali::Internal::CustomActor* internal);
 192   /// @endcond
 193 };
 194
 195 /**
 196  * @}
 197  */
 198 } // namespace Toolkit
 199
 200 } // namespace Dali
 201
 202 #endif // DALI_TOOLKIT_CANVAS_VIEW_H