dali-toolkit/devel-api/visuals/arc-visual-properties-devel.h

   1 #ifndef DALI_TOOLKIT_ARC_VISUAL_PROPERTIES_DEVEL_H
   2 #define DALI_TOOLKIT_ARC_VISUAL_PROPERTIES_DEVEL_H
   3
   4 /*
   5  * Copyright (c) 2020 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/toolkit-property-index-ranges.h>
  23
  24 namespace Dali
  25 {
  26 namespace Toolkit
  27 {
  28 namespace DevelArcVisual
  29 {
  30 /**
  31  * @brief ArcVisual Properties.
  32  */
  33 namespace Property
  34 {
  35 /**
  36  * @brief Enumeration for the instance of properties belonging to the ArcVisual.
  37  */
  38 enum
  39 {
  40   /**
  41    * @brief The thickness of the arc.
  42    * @details Name "thickness", type Property::FLOAT.
  43    * @note Mandatory.
  44    */
  45   THICKNESS = VISUAL_PROPERTY_START_INDEX,
  46
  47   /**
  48    * @brief The start angle where the arc begins in degrees.
  49    * @details Name "startAngle", type Property::FLOAT.
  50    * @note Optional. If not specified, the default is 0.
  51    */
  52   START_ANGLE,
  53
  54   /**
  55    * @brief The sweep angle of the arc in degrees.
  56    * @details Name "sweepAngle", type Property::FLOAT.
  57    * The arc starts at a specified start angle and sweeps clockwise, drawing slices of pie.
  58    * @note Optional. If not specified, the default is 360.
  59    */
  60   SWEEP_ANGLE,
  61
  62   /**
  63    * @brief The cap of the arc.
  64    * @details Name "cap", Type Cap::Type (Property::INTEGER)
  65    * It specifies the shape of the endpoints.
  66    * @note Optional. If not specified, the default is Cap::BUTT.
  67    */
  68   CAP,
  69 };
  70
  71 } // namespace Property
  72
  73 /**
  74  * @brief Enumeration for the cap style.
  75  */
  76 namespace Cap
  77 {
  78 enum Type
  79 {
  80   BUTT, ///< The arc does not extend beyond its two endpoints.
  81   ROUND ///< The arc will be extended by a half circle with the center at the end.
  82 };
  83
  84 } // namespace Cap
  85
  86 } // namespace DevelArcVisual
  87
  88 } // namespace Toolkit
  89
  90 } // namespace Dali
  91
  92 #endif // DALI_TOOLKIT_ARC_VISUAL_PROPERTIES_DEVEL_H