X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fdevel-api%2Fvisuals%2Fimage-visual-properties-devel.h;h=eb39aa6ad3e570f157b3ec3cf45f85d302bbf1fd;hp=ce15c21a0a17528d3a98cb98800081235909130f;hb=27de3fbcd7105d89cbe3854bcf908f80176b31f0;hpb=b56e45f7d2cf803ab0124448060149f16a6c088e 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 ce15c21..eb39aa6 100644 --- 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) 2017 Samsung Electronics Co., Ltd. + * Copyright (c) 2018 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. @@ -45,78 +45,54 @@ enum Type 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, /** - * @brief The border of the image - * @details Name "border", type Property::RECTANGLE or Property::VECTOR4 - * The border of the image in the order: left, right, bottom, top. + * @brief Overlays the auxiliary iamge on top of an NPatch image. * - * @note Optional. - * @note For N-Patch images only. - */ - BORDER = WRAP_MODE_V + 1, - - /** - * @brief Whether to use the texture atlas - * @details Name "atlasing", type Property::BOOLEAN, true to enable texture atlas + * The resulting visual image will be at least as large as the + * smallest possible n-patch or the auxiliary image, whichever is + * larger. * - * @note Optional. By default atlasing is off. + * @details Name "auxiliaryImage", Type Property::STRING, URL of the image. + * @note Default true */ - - ATLASING = WRAP_MODE_V + 2, + AUXILIARY_IMAGE = ORIENTATION_CORRECTION + 1, /** - * @brief URL of a masking image - * @details Name "alphaMaskUrl", type Property::STRING, URL of image to apply as - * a mask after image loading. If set after the main URL has finished loading, this - * may necessitate a re-load of the main image. The alpha mask image will be scaled - * on load to match the size of the main image, then applied to the pixel data - * before uploading to GL. - * @note Optional. + * @brief An alpha value for mixing between the masked main NPatch image and the auxiliary image + * @details Name "auxiliaryImageAlpha", Type Property::FLOAT, between 0 and 1 + * @note Default 0 */ - - ALPHA_MASK_URL = WRAP_MODE_V + 3, + AUXILIARY_IMAGE_ALPHA = ORIENTATION_CORRECTION + 2, /** - * @brief Defines the batch size for pre-loading images in the AnimatedImageVisual - * @details Name "batchSize", type Property::INTEGER, number of images to pre-load - * before starting to play. Default value: 1 + * @brief The number of times the AnimatedImageVisual will be looped. + * @details Name "loopCount", type Property::INTEGER. + * @note For Animated images only. Default -1. if < 0, loop unlimited. else, loop loopCount times. */ - BATCH_SIZE = WRAP_MODE_V + 4, + LOOP_COUNT = ORIENTATION_CORRECTION + 3, /** - * @brief Defines the cache size for loading images in the AnimatedImageVisual - * @details Name "cacheSize", type Property::INTEGER, number of images to keep - * cached ahead during playback. Default value: 1 + * @brief The playing range the AnimatedVectorImageVisual will use. * - * @note, cacheSize should be >= batchSize. - * If it isn't, then the cache will automatically be changed to batchSize. - * @note, because of the defaults, it is expected that the application developer - * tune the batch and cache sizes to their particular use case. - */ - CACHE_SIZE = WRAP_MODE_V + 5, - - /** - * @brief The number of milliseconds between each frame in the AnimatedImageVisual - * @details Name "frameDelay", type Property::INTEGER, The number of milliseconds between each frame. Note, this is only used with the URLS property above. - */ - FRAME_DELAY = WRAP_MODE_V + 6, - - /** - * @brief The scale factor to apply to the content image before masking - * @details Name "maskContentScale", type Property::FLOAT, The scale factor - * to apply to the content before masking. Note, scaled images are cropped to - * the same size as the alpha mask. - */ - MASK_CONTENT_SCALE = WRAP_MODE_V + 7, - - /** - * @brief Whether to crop image to mask or scale mask to fit image - * @details Name "cropToMask", type Property::BOOLEAN, True if the image should - * be cropped to match the mask size, or false if the image should remain the same size. - * Note, if this is false, then the mask is scaled to fit the image before being applied. + * Animation will play between the values specified. Both values should be between 0-1, + * 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::VECTOR2, between 0 and 1 + * @note Default 0 and 1 */ - CROP_TO_MASK = WRAP_MODE_V + 8, + PLAY_RANGE = ORIENTATION_CORRECTION + 4 };