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

   1 #ifndef DALI_TOOLKIT_DEVEL_API_VISUALS_VISUAL_PROPERTIES_DEVEL_H
   2 #define DALI_TOOLKIT_DEVEL_API_VISUALS_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/visuals/visual-properties.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 namespace DevelVisual
  31 {
  32
  33 /**
  34  * @brief All the visual types.
  35  */
  36 enum Type
  37 {
  38   BORDER         = Dali::Toolkit::Visual::BORDER,
  39   COLOR          = Dali::Toolkit::Visual::COLOR,
  40   GRADIENT       = Dali::Toolkit::Visual::GRADIENT,
  41   IMAGE          = Dali::Toolkit::Visual::IMAGE,
  42   MESH           = Dali::Toolkit::Visual::MESH,
  43   PRIMITIVE      = Dali::Toolkit::Visual::PRIMITIVE,
  44   WIREFRAME      = Dali::Toolkit::Visual::WIREFRAME,
  45   TEXT           = Dali::Toolkit::Visual::TEXT,
  46   N_PATCH        = Dali::Toolkit::Visual::N_PATCH,
  47   SVG            = Dali::Toolkit::Visual::SVG,
  48   ANIMATED_IMAGE = Dali::Toolkit::Visual::ANIMATED_IMAGE,
  49
  50   ANIMATED_GRADIENT     = ANIMATED_IMAGE + 1,  ///< Renders an animated gradient.
  51   ANIMATED_VECTOR_IMAGE = ANIMATED_IMAGE + 2,  ///< Renders an animated vector image.
  52   ARC                   = ANIMATED_IMAGE + 3,  ///< Renders an arc.
  53 };
  54
  55 /**
  56  * @brief Visual Properties
  57  */
  58 namespace Property
  59 {
  60 enum Type
  61 {
  62   TYPE                = Dali::Toolkit::Visual::Property::TYPE,
  63   SHADER              = Dali::Toolkit::Visual::Property::SHADER,
  64   TRANSFORM           = Dali::Toolkit::Visual::Property::TRANSFORM,
  65   PREMULTIPLIED_ALPHA = Dali::Toolkit::Visual::Property::PREMULTIPLIED_ALPHA,
  66   MIX_COLOR           = Dali::Toolkit::Visual::Property::MIX_COLOR,
  67   OPACITY             = Dali::Toolkit::Visual::Property::OPACITY,
  68
  69   /**
  70    * @brief The fitting mode of the visual
  71    * @details Name "fittingMode", type FittingMode (Property::INTEGER) or Property::STRING.
  72    * @see DevelVisual::FittingMode
  73    * @note The default is defined by the type of visual (if it's suitable to be stretched or not).
  74    */
  75   VISUAL_FITTING_MODE = OPACITY + 1,
  76
  77   /**
  78    * @brief The radius for the rounded corners of the visual
  79    * @details Name "cornerRadius", type Property::FLOAT.
  80    * @note Optional.
  81    */
  82   CORNER_RADIUS = OPACITY + 2,
  83 };
  84
  85 } // namespace Property
  86
  87
  88 /**
  89  * @brief The values of this enum determine how the visual should be fit to the view
  90  */
  91 enum FittingMode
  92 {
  93   FIT_KEEP_ASPECT_RATIO,     ///< The visual should be scaled to fit, preserving aspect ratio
  94   FILL,                      ///< The visual should be stretched to fill, not preserving aspect ratio
  95   OVER_FIT_KEEP_ASPECT_RATIO,///< The visual should be scaled to fit, preserving aspect ratio. The visual will be filled without empty area, and outside is cropped away.
  96   CENTER,                    ///< The visual should keep original size of image. It is not scaled and not strecthed.
  97   FIT_HEIGHT,                ///< The visual should be scaled to fit, preserving aspect ratio. Height is scaled proportionately to maintain aspect ratio. It will be deprecated.
  98   FIT_WIDTH                  ///< The visual should be scaled to fit, preserving aspect ratio. Width is scaled proportionately to maintain aspect ratio. It will be deprecated.
  99 };
 100
 101 /**
 102  * @brief Devel Visual Transform for the offset or size.
 103  */
 104 namespace Transform
 105 {
 106
 107 /**
 108  * @brief Visual Transform Property.
 109  */
 110 namespace Property
 111 {
 112
 113 /**
 114  * @brief Enumeration for the type of Transform Property.
 115  */
 116 enum Type
 117 {
 118   SIZE_POLICY = Dali::Toolkit::Visual::Transform::Property::SIZE_POLICY,
 119
 120   /**
 121    * @brief Extra size value that will be added to the computed visual size.
 122    * @details Name "extraSize", type Vector2.
 123    *
 124    * @note It is an absolute value.
 125    *       The property can be used when a user want to set a visual size as a combined value of `relative` and `absolute`.
 126    *       For example, when a user want to set a visual size to (ControlSize * 2 + 10),
 127    *       The transform map will be,
 128    *       transformMap.Add( Transform::Property::SIZE, Vector2( 2.0f, 2.0f ) )
 129    *                   .Add( Transform::Property::SIZE_POLICY, Vector2( Transform::Policy::Relative, Transform::Policy::Relative ) )
 130    *                   .Add( Transform::Property::EXTRA_SIZE, Vector2( 10.0f, 10.0f ) );
 131    */
 132   EXTRA_SIZE = SIZE_POLICY + 1,
 133 };
 134
 135 } // namespace Property
 136
 137 } // namespace Transform
 138
 139 } // namespace DevelVisual
 140
 141 } // namespace Toolkit
 142
 143 } // namespace Dali
 144
 145 #endif // DALI_TOOLKIT_DEVEL_API_VISUALS_VISUAL_PROPERTIES_DEVEL_H