X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;ds=sidebyside;f=dali-toolkit%2Finternal%2Fvisuals%2Fimage%2Fimage-visual.h;h=cd22ebcd435cbc22c60355044924c98bbcc8f55a;hb=c211a7d84885dca19c90b4656055002865e6fce2;hp=3079c93562d42efa17e837e0e1e0e3b44e117ee1;hpb=193fa3dcbfa6b46bb9d3d1c079f2ca4eb25747a1;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/internal/visuals/image/image-visual.h b/dali-toolkit/internal/visuals/image/image-visual.h index 3079c93..cd22ebc 100644 --- a/dali-toolkit/internal/visuals/image/image-visual.h +++ b/dali-toolkit/internal/visuals/image/image-visual.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_INTERNAL_IMAGE_VISUAL_H /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2016 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. @@ -18,16 +18,17 @@ * */ -// INTERNAL INCLUDES -#include -#include - // EXTERNAL INCLUDES +#include #include #include #include #include +// INTERNAL INCLUDES +#include +#include + namespace Dali { @@ -79,16 +80,37 @@ class ImageVisual: public Visual::Base, public ConnectionTracker, public AtlasUp public: /** - * @brief Constructor. + * @brief Create a new image visual. + * + * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object + * @return A smart-pointer to the newly allocated visual. + */ + static ImageVisualPtr New( VisualFactoryCache& factoryCache ); + + /** + * @brief Create a new image visual with a URL. + * + * The visual will load the Image asynchronously when the associated actor is put on stage, and destroy the image when it is off stage * * @param[in] factoryCache The VisualFactoryCache object + * @param[in] imageUrl The URL of the image resource to use + * @param[in] size The width and height to fit the loaded image to. + * @param[in] fittingMode The FittingMode of the resource to load + * @param[in] samplingMode The SamplingMode of the resource to load */ - ImageVisual( VisualFactoryCache& factoryCache ); + static ImageVisualPtr New( VisualFactoryCache& factoryCache, + const std::string& imageUrl, + ImageDimensions size = ImageDimensions(), + FittingMode::Type fittingMode = FittingMode::DEFAULT, + Dali::SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR ); /** - * @brief A reference counted object may only be deleted by calling Unreference(). + * @brief Create a new image visual with an Image type. + * + * @param[in] factoryCache The VisualFactoryCache object + * @param[in] image The image to use */ - ~ImageVisual(); + static ImageVisualPtr New( VisualFactoryCache& factoryCache, const Image& image ); public: // from Visual @@ -113,6 +135,44 @@ public: // from Visual virtual Dali::Property::Value DoGetProperty( Dali::Property::Index index ); protected: + + /** + * @brief Constructor. + * + * @param[in] factoryCache The VisualFactoryCache object + */ + ImageVisual( VisualFactoryCache& factoryCache ); + + /** + * @brief Constructor with a URL. + * + * The visual will load the Image asynchronously when the associated actor is put on stage, and destroy the image when it is off stage + * + * @param[in] factoryCache The VisualFactoryCache object + * @param[in] imageUrl The URL of the image resource to use + * @param[in] size The width and height to fit the loaded image to. + * @param[in] fittingMode The FittingMode of the resource to load + * @param[in] samplingMode The SamplingMode of the resource to load + */ + ImageVisual( VisualFactoryCache& factoryCache, + const std::string& imageUrl, + ImageDimensions size, + FittingMode::Type fittingMode, + Dali::SamplingMode::Type samplingMode ); + + /** + * @brief Constructor with an Image type. + * + * @param[in] factoryCache The VisualFactoryCache object + * @param[in] image The image to use + */ + ImageVisual( VisualFactoryCache& factoryCache, const Image& image ); + + /** + * @brief A reference counted object may only be deleted by calling Unreference(). + */ + virtual ~ImageVisual(); + /** * @copydoc Visual::Base::DoInitialize */ @@ -139,30 +199,6 @@ public: static Shader GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping ); /** - * @brief Sets the image of this visual to the resource at imageUrl - * The visual will load the Image asynchronously when the associated actor is put on stage, and destroy the image when it is off stage - * - * @param[in] actor The Actor the renderer is applied to if, empty if the renderer has not been applied to any Actor - * @param[in] imageUrl The URL of the image resource to use - * @param[in] size The width and height to fit the loaded image to. - * @param[in] fittingMode The FittingMode of the resource to load - * @param[in] samplingMode The SamplingMode of the resource to load - */ - void SetImage( Actor& actor, - const std::string& imageUrl, - ImageDimensions size=ImageDimensions(), - FittingMode::Type fittingMode = FittingMode::DEFAULT, - Dali::SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR ); - - /** - * @brief Sets the image to be rendered by this visual - * - * @param[in] actor The Actor the renderer is applied to if, empty if the renderer has not been applied to any Actor - * @param[in] image The image to use - */ - void SetImage( Actor& actor, const Image& image ); - - /** * @copydoc AtlasUploadObserver::UploadCompleted * * To avoid rendering garbage pixels, renderer should be added to actor after the resources are ready. @@ -209,14 +245,14 @@ private: /** * @brief Query whether resources requires to be loaded synchronously. - * @return Returns true if synchronoud resource loading is required, false otherwise. + * @return Returns true if synchronous resource loading is required, false otherwise. */ bool IsSynchronousResourceLoading() const; /** - * @brief Do the synchronous resource loading + * @brief Load the resource synchronously */ - void DoSynchronousResourceLoading(); + void LoadResourceSynchronously(); /** * Load the image.