X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fcontrols%2Frenderers%2Fimage%2Fimage-renderer.h;h=8498e54812cf5f78065e0f3b5219c9db11c1a27e;hp=bbaa13988c1837ad807403e9010262d5edc51ec9;hb=f3da11c2818c6d17706fbb2417f21b602b3190f5;hpb=299e8f55adab64025e446c5dcd1e87f050e43f82 diff --git a/dali-toolkit/internal/controls/renderers/image/image-renderer.h b/dali-toolkit/internal/controls/renderers/image/image-renderer.h index bbaa139..8498e54 100644 --- a/dali-toolkit/internal/controls/renderers/image/image-renderer.h +++ b/dali-toolkit/internal/controls/renderers/image/image-renderer.h @@ -24,6 +24,7 @@ // EXTERNAL INCLUDES #include #include +#include namespace Dali { @@ -42,40 +43,42 @@ typedef IntrusivePtr< ImageRenderer > ImageRendererPtr; * * The following properties are optional * - * | %Property Name | Type | - * |---------------------------|------------------| - * | image-url | STRING | - * | image-fitting-mode | STRING | - * | image-sampling-mode | STRING | - * | image-desired-width | INT | - * | image-desired-height | INT | + * | %Property Name | Type | + * |-------------------------|------------------| + * | imageUrl | STRING | + * | imageFittingMode | STRING | + * | imageSamplingMode | STRING | + * | imageDesiredWidth | INT | + * | imageDesiredHeight | INT | * - * where image-fitting-mode should be one of the following fitting modes: - * "shrink-to-fit" - * "scale-to-fill" - * "fit-width" - * "fit-height" + * where imageFittingMode should be one of the following fitting modes: + * "shrinkToFit" + * "scaleToFill" + * "fitWidth" + * "fitHeight" * "default" * - * where image-sampling-mode should be one of the following sampling modes: + * where imageSamplingMode should be one of the following sampling modes: * "box" * "nearest" * "linear" - * "box-then-nearest" - * "box-then-linear" - * "no-filter" - * "dont-care" + * "boxThenNearest" + * "boxThenLinear" + * "noFilter" + * "dontCare" * "default" * */ -class ImageRenderer: public ControlRenderer +class ImageRenderer: public ControlRenderer, public ConnectionTracker { public: /** * @brief Constructor. + * + * @param[in] factoryCache A pointer pointing to the RendererFactoryCache object */ - ImageRenderer(); + ImageRenderer( RendererFactoryCache& factoryCache ); /** * @brief A reference counted object may only be deleted by calling Unreference(). @@ -85,14 +88,14 @@ public: public: // from ControlRenderer /** - * @copydoc ControlRenderer::Initialize + * @copydoc ControlRenderer::SetSize */ - virtual void Initialize( RendererFactoryCache& factoryCache, const Property::Map& propertyMap ); + virtual void SetSize( const Vector2& size ); /** - * @copydoc ControlRenderer::SetSize + * @copydoc ControlRenderer::GetNaturalSize */ - virtual void SetSize( const Vector2& size ); + virtual void GetNaturalSize( Vector2& naturalSize ) const; /** * @copydoc ControlRenderer::SetClipRect @@ -107,10 +110,15 @@ public: // from ControlRenderer /** * @copydoc ControlRenderer::CreatePropertyMap */ - virtual void CreatePropertyMap( Property::Map& map ) const; + virtual void DoCreatePropertyMap( Property::Map& map ) const; protected: /** + * @copydoc ControlRenderer::DoInitialize + */ + virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap ); + + /** * @copydoc ControlRenderer::DoSetOnStage */ virtual void DoSetOnStage( Actor& actor ); @@ -123,52 +131,70 @@ protected: public: /** - * Request the geometry and shader from the cache, if not available, create and save to the cache for sharing. - * - * @param[in] factoryCache A pointer pointing to the RendererFactoryCache object - */ - void Initialize( RendererFactoryCache& factoryCache ); - - /** * @brief Sets the image of this renderer to the resource at imageUrl * The renderer 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 to to image resource to use */ - void SetImage( const std::string& imageUrl ); + void SetImage( Actor& actor, const std::string& imageUrl ); /** * @brief Sets the image of this renderer to the resource at imageUrl * The renderer 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 to to image resource to use * @param[in] desiredWidth The desired width of the resource to load * @param[in] desiredHeight The desired height of the resource to load * @param[in] fittingMode The FittingMode of the resource to load * @param[in] samplingMode The SamplingMode of the resource to load */ - void SetImage( const std::string& imageUrl, int desiredWidth, int desiredHeight, Dali::FittingMode::Type fittingMode, Dali::SamplingMode::Type samplingMode ); + void SetImage( Actor& actor, const std::string& imageUrl, int desiredWidth, int desiredHeight, Dali::FittingMode::Type fittingMode, Dali::SamplingMode::Type samplingMode ); /** * @brief Sets the image of this renderer to use * + * @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( Image image ); + void SetImage( Actor& actor, const Image& image ); + +private: /** - * @brief Gets the image this renderer uses + * @brief Applies the image to the material used for this renderer * - * @return The image this renderer uses, which may be null if the image is set from a URL string and the renderer is not set as onstage + * @param[in] image The Image to apply to the material used for this renderer */ - Image GetImage() const; + void ApplyImageToSampler( const Image& image ); -private: + /** + * @brief Initializes the Dali::Renderer from an image url string + * + * @param[in] imageUrl The image url string to intialize this ImageRenderer from + */ + void InitializeRenderer( const std::string& imageUrl ); + + /** + * @brief Initializes the Dali::Renderer from an image handle + * + * @param[in] image The image handle to intialize this ImageRenderer from + */ + void InitializeRenderer( const Image& image ); + + /** + * @brief Creates the Dali::Renderer (potentially from the renderer cache), initializing it + * + * @return Returns the created Dali::Renderer + */ + Renderer CreateRenderer() const; /** - * @brief Applies this renderer's image to the sampler to the material used for this renderer + * Callback function of image resource loading succeed + * @param[in] image The Image content that we attempted to load from mImageUrl */ - void ApplyImageToSampler(); + void OnImageLoaded( ResourceImage image ); private: Image mImage;