Add CURRENT_FRAME_NUMBER and TOTAL_FRAME_NUMBER properties to the AnimatedImageVisual

[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 e6e5303..413b556 100644 (file)
--- a/dali-toolkit/devel-api/visuals/image-visual-properties-devel.h
+++ b/dali-toolkit/devel-api/visuals/image-visual-properties-devel.h
@@ -23,38 +23,34 @@
 
 namespace Dali
 {
-
 namespace Toolkit
 {
-
 namespace DevelImageVisual
 {
-
 namespace Property
 {
-
 enum Type
 {
-  URL                 = Dali::Toolkit::ImageVisual::Property::URL,
-  FITTING_MODE        = Dali::Toolkit::ImageVisual::Property::FITTING_MODE,
-  SAMPLING_MODE       = Dali::Toolkit::ImageVisual::Property::SAMPLING_MODE,
-  DESIRED_WIDTH       = Dali::Toolkit::ImageVisual::Property::DESIRED_WIDTH,
-  DESIRED_HEIGHT      = Dali::Toolkit::ImageVisual::Property::DESIRED_HEIGHT,
-  SYNCHRONOUS_LOADING = Dali::Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING,
-  BORDER_ONLY         = Dali::Toolkit::ImageVisual::Property::BORDER_ONLY,
-  PIXEL_AREA          = Dali::Toolkit::ImageVisual::Property::PIXEL_AREA,
-  WRAP_MODE_U         = Dali::Toolkit::ImageVisual::Property::WRAP_MODE_U,
-  WRAP_MODE_V         = Dali::Toolkit::ImageVisual::Property::WRAP_MODE_V,
-  BORDER              = Dali::Toolkit::ImageVisual::Property::BORDER,
-  ATLASING            = Dali::Toolkit::ImageVisual::Property::ATLASING,
-  ALPHA_MASK_URL      = Dali::Toolkit::ImageVisual::Property::ALPHA_MASK_URL,
-  BATCH_SIZE          = Dali::Toolkit::ImageVisual::Property::BATCH_SIZE,
-  CACHE_SIZE          = Dali::Toolkit::ImageVisual::Property::CACHE_SIZE,
-  FRAME_DELAY         = Dali::Toolkit::ImageVisual::Property::FRAME_DELAY,
-  MASK_CONTENT_SCALE  = Dali::Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE,
-  CROP_TO_MASK        = Dali::Toolkit::ImageVisual::Property::CROP_TO_MASK,
-  LOAD_POLICY         = Dali::Toolkit::ImageVisual::Property::LOAD_POLICY,
-  RELEASE_POLICY      = Dali::Toolkit::ImageVisual::Property::RELEASE_POLICY,
+  URL                    = Dali::Toolkit::ImageVisual::Property::URL,
+  FITTING_MODE           = Dali::Toolkit::ImageVisual::Property::FITTING_MODE,
+  SAMPLING_MODE          = Dali::Toolkit::ImageVisual::Property::SAMPLING_MODE,
+  DESIRED_WIDTH          = Dali::Toolkit::ImageVisual::Property::DESIRED_WIDTH,
+  DESIRED_HEIGHT         = Dali::Toolkit::ImageVisual::Property::DESIRED_HEIGHT,
+  SYNCHRONOUS_LOADING    = Dali::Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING,
+  BORDER_ONLY            = Dali::Toolkit::ImageVisual::Property::BORDER_ONLY,
+  PIXEL_AREA             = Dali::Toolkit::ImageVisual::Property::PIXEL_AREA,
+  WRAP_MODE_U            = Dali::Toolkit::ImageVisual::Property::WRAP_MODE_U,
+  WRAP_MODE_V            = Dali::Toolkit::ImageVisual::Property::WRAP_MODE_V,
+  BORDER                 = Dali::Toolkit::ImageVisual::Property::BORDER,
+  ATLASING               = Dali::Toolkit::ImageVisual::Property::ATLASING,
+  ALPHA_MASK_URL         = Dali::Toolkit::ImageVisual::Property::ALPHA_MASK_URL,
+  BATCH_SIZE             = Dali::Toolkit::ImageVisual::Property::BATCH_SIZE,
+  CACHE_SIZE             = Dali::Toolkit::ImageVisual::Property::CACHE_SIZE,
+  FRAME_DELAY            = Dali::Toolkit::ImageVisual::Property::FRAME_DELAY,
+  MASK_CONTENT_SCALE     = Dali::Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE,
+  CROP_TO_MASK           = Dali::Toolkit::ImageVisual::Property::CROP_TO_MASK,
+  LOAD_POLICY            = Dali::Toolkit::ImageVisual::Property::LOAD_POLICY,
+  RELEASE_POLICY         = Dali::Toolkit::ImageVisual::Property::RELEASE_POLICY,
   ORIENTATION_CORRECTION = Dali::Toolkit::ImageVisual::Property::ORIENTATION_CORRECTION,
 
   /**
@@ -108,14 +104,14 @@ enum Type
   PLAY_STATE = ORIENTATION_CORRECTION + 5,
 
   /**
-   * @brief The current frame number the AnimatedVectorImageVisual will use.
+   * @brief The current frame number the AnimatedImageVisual and AnimatedVectorImageVisual will use.
    * @details Name "currentFrameNumber", Type Property::INTEGER, between [0, the maximum frame number] or between the play range if specified
    * @note This property is read-only.
    */
   CURRENT_FRAME_NUMBER = ORIENTATION_CORRECTION + 6,
 
   /**
-   * @brief The total frame number the AnimatedVectorImageVisual will use.
+   * @brief The total frame number the AnimatedImageVisual and AnimatedVectorImageVisual will use.
    * @details Name "totalFrameNumber", Type Property::INTEGER.
    * @note This property is read-only.
    */
@@ -142,7 +138,14 @@ enum Type
    * 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
+  CONTENT_INFO = ORIENTATION_CORRECTION + 10,
+
+  /**
+   * @brief Whether to redraw the image when the visual is scaled down.
+   * @details Name "redrawInScalingDown", type Property::BOOLEAN.
+   * @note It is used in the AnimatedVectorImageVisual. The default is true.
+   */
+  REDRAW_IN_SCALING_DOWN
 };
 
 } //namespace Property
@@ -152,12 +155,11 @@ enum Type
  */
 namespace PlayState
 {
-
 enum Type
 {
-  STOPPED,   ///< Animation has stopped
-  PLAYING,   ///< The animation is playing
-  PAUSED     ///< The animation is paused
+  STOPPED, ///< Animation has stopped
+  PLAYING, ///< The animation is playing
+  PAUSED   ///< The animation is paused
 };
 
 } // namespace PlayState
@@ -167,26 +169,24 @@ enum Type
  */
 namespace StopBehavior
 {
-
 enum Type
 {
-  CURRENT_FRAME,  ///< When the animation is stopped, the current frame is shown.
-  FIRST_FRAME,    ///< When the animation is stopped, the first frame is shown.
-  LAST_FRAME      ///< When the animation is stopped, the last frame is shown.
+  CURRENT_FRAME, ///< When the animation is stopped, the current frame is shown.
+  FIRST_FRAME,   ///< When the animation is stopped, the first frame is shown.
+  LAST_FRAME     ///< When the animation is stopped, the last frame is shown.
 };
 
-} // namespace StopBehavoir
+} // namespace StopBehavior
 
 /**
  * @brief Enumeration for what looping mode is in.
  */
 namespace LoopingMode
 {
-
 enum Type
 {
-  RESTART,      ///< When the animation arrives at the end in looping mode, the animation restarts from the beginning.
-  AUTO_REVERSE  ///< When the animation arrives at the end in looping mode, the animation reverses direction and runs backwards again.
+  RESTART,     ///< When the animation arrives at the end in looping mode, the animation restarts from the beginning.
+  AUTO_REVERSE ///< When the animation arrives at the end in looping mode, the animation reverses direction and runs backwards again.
 };
 
 } // namespace LoopingMode