Support the blur radius of the ColorVisual
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / devel-api / visuals / visual-properties-devel.h
index b70d254..8dfb3cc 100644 (file)
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_DEVEL_API_VISUALS_VISUAL_PROPERTIES_DEVEL_H
 
 /*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 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.
@@ -35,113 +35,63 @@ namespace DevelVisual
  */
 enum Type
 {
-  BORDER    = Dali::Toolkit::Visual::BORDER,
-  COLOR     = Dali::Toolkit::Visual::COLOR,
-  GRADIENT  = Dali::Toolkit::Visual::GRADIENT,
-  IMAGE     = Dali::Toolkit::Visual::IMAGE,
-  MESH      = Dali::Toolkit::Visual::MESH,
-  PRIMITIVE = Dali::Toolkit::Visual::PRIMITIVE,
-  WIREFRAME = Dali::Toolkit::Visual::WIREFRAME,
-
-  TEXT      = WIREFRAME + 1, ///< Renders text.
+  BORDER         = Dali::Toolkit::Visual::BORDER,
+  COLOR          = Dali::Toolkit::Visual::COLOR,
+  GRADIENT       = Dali::Toolkit::Visual::GRADIENT,
+  IMAGE          = Dali::Toolkit::Visual::IMAGE,
+  MESH           = Dali::Toolkit::Visual::MESH,
+  PRIMITIVE      = Dali::Toolkit::Visual::PRIMITIVE,
+  WIREFRAME      = Dali::Toolkit::Visual::WIREFRAME,
+  TEXT           = Dali::Toolkit::Visual::TEXT,
+  N_PATCH        = Dali::Toolkit::Visual::N_PATCH,
+  SVG            = Dali::Toolkit::Visual::SVG,
+  ANIMATED_IMAGE = Dali::Toolkit::Visual::ANIMATED_IMAGE,
+
+  ANIMATED_GRADIENT     = ANIMATED_IMAGE + 1,  ///< Renders an animated gradient.
+  ANIMATED_VECTOR_IMAGE = ANIMATED_IMAGE + 2,  ///< Renders an animated vector image.
 };
 
+/**
+ * @brief Visual Properties
+ */
 namespace Property
 {
-
 enum Type
 {
-  TYPE   = Dali::Toolkit::Visual::Property::TYPE,
-  SHADER = Dali::Toolkit::Visual::Property::SHADER,
+  TYPE                = Dali::Toolkit::Visual::Property::TYPE,
+  SHADER              = Dali::Toolkit::Visual::Property::SHADER,
+  TRANSFORM           = Dali::Toolkit::Visual::Property::TRANSFORM,
+  PREMULTIPLIED_ALPHA = Dali::Toolkit::Visual::Property::PREMULTIPLIED_ALPHA,
+  MIX_COLOR           = Dali::Toolkit::Visual::Property::MIX_COLOR,
+  OPACITY             = Dali::Toolkit::Visual::Property::OPACITY,
 
   /**
-   * @brief The transform used by the visual.
-   * @details Name "transform", type Property::Map.
-   *
-   * @note Optional.
-   * @see DevelVisual::Transform::Property
+   * @brief The fitting mode of the visual
+   * @details Name "fittingMode", type FittingMode (Property::INTEGER) or Property::STRING.
+   * @see DevelVisual::FittingMode
+   * @note The default is defined by the type of visual (if it's suitable to be stretched or not).
    */
-  TRANSFORM = SHADER + 1,
+  VISUAL_FITTING_MODE = OPACITY + 1,
 
   /**
-   * @brief Enables/disables premultiplied alpha.
-   * The premultiplied alpha is false by default unless this behaviour is modified
-   * by the derived Visual type.
-   *
-   * @details Name "premultipliedAlpha", type Property::Boolean.
-   *
+   * @brief The radius for the rounded corners of the visual
+   * @details Name "cornerRadius", type Property::FLOAT.
    * @note Optional.
    */
-  PREMULTIPLIED_ALPHA = SHADER + 2,
-
-  /**
-   * @brief Mix color is a blend color for any visual.
-   * @details Name "mixColor", type Property::VECTOR3 or Property::VECTOR4
-   *
-   * @note Optional
-   */
-  MIX_COLOR = SHADER + 3,
-
-  /**
-   * @brief Opacity is the alpha component of the mixColor, above.
-   * @details Name "opacity", type Property::FLOAT
-   *
-   * @note Optional
-   */
-  OPACITY = SHADER + 4
+  CORNER_RADIUS = OPACITY + 2,
 };
 
-} //namespace Property
-
-namespace Transform
-{
-
-namespace Property
-{
+} // namespace Property
 
-enum Type
+/**
+ * @brief The values of this enum determine how the visual should be fit to the view
+ */
+enum FittingMode
 {
-  /**
-   * @brief Offset of the visual. It can be either relative (percentage of the parent)
-   * or absolute (in world units).
-   * @details Name "offset", type Property::VECTOR2
-   */
-  OFFSET,
-
-  /**
-   * @brief Size of the visual. It can be either relative (percentage of the parent)
-   * or absolute (in world units).
-   * @details Name "size", type Property::VECTOR2
-   */
-  SIZE,
-
-  /**
-   * @brief The origin of the visual within its control area.
-   * @details Name "origin", type Align::Type (Property::INTEGER) or Property::STRING.
-   * @see Toolkit::Align
-   */
-  ORIGIN,
-
-  /**
-   * @brief The anchor-point of the visual
-   * @details Name "anchorPoint", type Align::Type (Property::INTEGER) or Property::STRING.
-   * @see Toolkit::Align
-   */
-  ANCHOR_POINT,
-
-  /**
-   * @brief Indicates which components of the offset and size are relative
-   * (percentage of the parent) or absolute (in world units).
-   * 0 indicates the component is relative, and 1 absolute.
-   * @details Name "offsetSizeMode", type Property::VECTOR4
-   */
-  OFFSET_SIZE_MODE
+  FIT_KEEP_ASPECT_RATIO,  ///< The visual should be scaled to fit, preserving aspect ratio
+  FILL,                   ///< The visual should be stretched to fill, not preserving aspect ratio
 };
 
-} //namespace Property
-
-} // namespace Transform
-
 } // namespace DevelVisual
 
 } // namespace Toolkit