Add GetVisualProperty to Control

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / devel-api / visuals / visual-properties-devel.h

diff --git a/dali-toolkit/devel-api/visuals/visual-properties-devel.h b/dali-toolkit/devel-api/visuals/visual-properties-devel.h
index ec53128..6a5f51d 100644 (file)
--- a/dali-toolkit/devel-api/visuals/visual-properties-devel.h
+++ b/dali-toolkit/devel-api/visuals/visual-properties-devel.h
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_DEVEL_API_VISUALS_VISUAL_PROPERTIES_DEVEL_H
 
 /*
- * Copyright (c) 2018 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.
@@ -23,13 +23,10 @@
 
 namespace Dali
 {
-
 namespace Toolkit
 {
-
 namespace DevelVisual
 {
-
 /**
  * @brief All the visual types.
  */
@@ -47,7 +44,9 @@ enum Type
   SVG            = Dali::Toolkit::Visual::SVG,
   ANIMATED_IMAGE = Dali::Toolkit::Visual::ANIMATED_IMAGE,
 
-  ANIMATED_GRADIENT = ANIMATED_IMAGE + 1,  //< Renders an animated gradient.
+  ANIMATED_GRADIENT     = ANIMATED_IMAGE + 1, ///< Renders an animated gradient.
+  ANIMATED_VECTOR_IMAGE = ANIMATED_IMAGE + 2, ///< Renders an animated vector image.
+  ARC                   = ANIMATED_IMAGE + 3, ///< Renders an arc.
 };
 
 /**
@@ -71,6 +70,22 @@ enum Type
    * @note The default is defined by the type of visual (if it's suitable to be stretched or not).
    */
   VISUAL_FITTING_MODE = OPACITY + 1,
+
+  /**
+   * @brief The radius for the rounded corners of the visual
+   * @details Name "cornerRadius", type Property::FLOAT, animatable
+   * @note Optional.
+   */
+  CORNER_RADIUS = OPACITY + 2,
+
+  /**
+   * @brief Whether the corner radius value is relative (percentage [0.0f to 1.0f] of the visual size) or absolute (in world units).
+   * @details Name "cornerRadiusPolicy", type Property::INTEGER.
+   * @see Policy::Type
+   * @note By default, it is ABSOLUTE to the visual's size.
+   *       If it it RELATIVE, the corner radius value is relative to the smaller of the visual width and visual height.
+   */
+  CORNER_RADIUS_POLICY = OPACITY + 3,
 };
 
 } // namespace Property
@@ -80,10 +95,50 @@ enum Type
  */
 enum FittingMode
 {
-  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
+  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
+  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.
+  CENTER,                     ///< The visual should keep original size of image. It is not scaled and not strecthed.
+  FIT_HEIGHT,                 ///< The visual should be scaled to fit, preserving aspect ratio. Height is scaled proportionately to maintain aspect ratio. It will be deprecated.
+  FIT_WIDTH                   ///< The visual should be scaled to fit, preserving aspect ratio. Width is scaled proportionately to maintain aspect ratio. It will be deprecated.
+};
+
+/**
+ * @brief Devel Visual Transform for the offset or size.
+ */
+namespace Transform
+{
+/**
+ * @brief Visual Transform Property.
+ */
+namespace Property
+{
+/**
+ * @brief Enumeration for the type of Transform Property.
+ */
+enum Type
+{
+  SIZE_POLICY = Dali::Toolkit::Visual::Transform::Property::SIZE_POLICY,
+
+  /**
+   * @brief Extra size value that will be added to the computed visual size.
+   * @details Name "extraSize", type Vector2.
+   *
+   * @note It is an absolute value.
+   *       The property can be used when a user want to set a visual size as a combined value of `relative` and `absolute`.
+   *       For example, when a user want to set a visual size to (ControlSize * 2 + 10),
+   *       The transform map will be,
+   *       transformMap.Add( Transform::Property::SIZE, Vector2( 2.0f, 2.0f ) )
+   *                   .Add( Transform::Property::SIZE_POLICY, Vector2( Transform::Policy::Relative, Transform::Policy::Relative ) )
+   *                   .Add( Transform::Property::EXTRA_SIZE, Vector2( 10.0f, 10.0f ) );
+   */
+  EXTRA_SIZE = SIZE_POLICY + 1,
 };
 
+} // namespace Property
+
+} // namespace Transform
+
 } // namespace DevelVisual
 
 } // namespace Toolkit