DALi Version 1.9.9

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

diff --git a/dali-toolkit/devel-api/visuals/image-visual-properties-devel.h b/dali-toolkit/devel-api/visuals/image-visual-properties-devel.h
index 306880b..e6e5303 100644 (file)
--- a/dali-toolkit/devel-api/visuals/image-visual-properties-devel.h
+++ b/dali-toolkit/devel-api/visuals/image-visual-properties-devel.h
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_DEVEL_API_VISUALS_IMAGE_VISUAL_PROPERTIES_DEVEL_H
 
 /*
- * Copyright (c) 2019 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.
@@ -86,11 +86,16 @@ enum Type
   /**
    * @brief The playing range the AnimatedVectorImageVisual will use.
    *
-   * Animation will play between the values specified. The array can only have two values, and more will be ignored.
+   * Animation will play between the values specified. The array can have two integer values.
+   * Or it can have one or two strings, which are markers. More will be ignored.
    * Both values should be between 0 and the total frame number, otherwise they will be ignored.
    * If the range provided is not in proper order ( minimum, maximum ), it will be reordered.
    *
-   * @details Name "playRange", Type Property::ARRAY of Property::INTEGER
+   * A marker has its start frame and end frame.
+   * Animation will play between the start frame and the end frame of the marker if one marker is specified.
+   * Or animation will play between the start frame of the first marker and the end frame of the second marker if two markers are specified.
+   *
+   * @details Name "playRange", Type Property::ARRAY of Property::INTEGER or Property::ARRAY of Property::STRING.
    * @note Default 0 and the total frame number.
    */
   PLAY_RANGE = ORIENTATION_CORRECTION + 4,
@@ -117,7 +122,7 @@ enum Type
   TOTAL_FRAME_NUMBER = ORIENTATION_CORRECTION + 7,
 
   /**
-   * @brief  The stop behavior the AnimatedVectorImageVisual will use.
+   * @brief  The stop behavior the AnimatedImageVisual and AnimatedVectorImageVisual will use.
    * @details Name "stopBehavior", Type StopBehavior::Type (Property::INTEGER)
    * @note Default value is StopBehavior::CURRENT_FRAME.
    */
@@ -128,7 +133,16 @@ enum Type
    * @details Name "loopingMode", Type LoopingMode::Type (Property::INTEGER)
    * @note Default value is LoopingMode::RESTART.
    */
-  LOOPING_MODE = ORIENTATION_CORRECTION + 9
+  LOOPING_MODE = ORIENTATION_CORRECTION + 9,
+
+  /**
+   * @brief The content information the AnimatedVectorImageVisual will use.
+   * @details Name "contentInfo", Type Property::MAP.
+   * The map contains the layer name as a key and Property::Array as a value.
+   * And the array contains 2 integer values which are the frame numbers, the start frame number and the end frame number of the layer.
+   * @note This property is read-only.
+   */
+  CONTENT_INFO = ORIENTATION_CORRECTION + 10
 };
 
 } //namespace Property