X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fvisuals%2Fanimated-image%2Fanimated-image-visual.h;h=0db91546f7d2c1b223d3badf0d23149ba68e7fb4;hb=eb4baa2fc615efbe5599e750faeedb2fcfaf5a94;hp=4e11ccea8abbc8535fa3256f57547fbce3d1c257;hpb=70ec62b390d2a16a7d007d127301ad246b95b45c;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/internal/visuals/animated-image/animated-image-visual.h b/dali-toolkit/internal/visuals/animated-image/animated-image-visual.h index 4e11cce..0db9154 100644 --- a/dali-toolkit/internal/visuals/animated-image/animated-image-visual.h +++ b/dali-toolkit/internal/visuals/animated-image/animated-image-visual.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_INTERNAL_ANIMATED_IMAGE_VISUAL_H /* - * Copyright (c) 2016 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. @@ -19,14 +19,18 @@ */ // EXTERNAL INCLUDES -#include #include +#include #include +#include #include +#include // INTERNAL INCLUDES #include #include +#include +#include namespace Dali { @@ -43,29 +47,41 @@ typedef IntrusivePtr< AnimatedImageVisual > AnimatedImageVisualPtr; /** * The visual which renders an animated image * - * The following property is essential + * One of the following properties is mandatory * * | %Property Name | Type | * |------------------- |-------------------| * | url | STRING | + * | urls | ARRAY of STRING | + * + * The remaining properties are optional * | pixelArea | VECTOR4 | * | wrapModeU | INTEGER OR STRING | * | wrapModeV | INTEGER OR STRING | + * | cacheSize | INTEGER | + * | batchSize | INTEGER | + * | frameDelay | INTEGER | * - * where pixelArea is a rectangular area. + * pixelArea is a rectangular area. * In its Vector4 value, the first two elements indicate the top-left position of the area, * and the last two elements are the area width and height respectively. * If not specified, the default value is [0.0, 0.0, 1.0, 1.0], i.e. the entire area of the image. * - * where wrapModeU and wrapModeV separately decide how the texture should be sampled when the u and v coordinate exceeds the range of 0.0 to 1.0. + * wrapModeU and wrapModeV separately decide how the texture should be sampled when the u and v coordinate exceeds the range of 0.0 to 1.0. * Its value should be one of the following wrap mode: * "DEFAULT" * "CLAMP_TO_EDGE" * "REPEAT" * "MIRRORED_REPEAT" + * + * cacheSize is used with multiple images - it determines how many images are kept pre-loaded + * batchSize is used with multiple images - it determines how many images to load on each frame + * frameDelay is used with multiple images - it is the number of milliseconds between each frame */ -class AnimatedImageVisual : public Visual::Base, public ConnectionTracker +class AnimatedImageVisual : public Visual::Base, + public ConnectionTracker, + public ImageCache::FrameReadyObserver { public: @@ -74,13 +90,23 @@ public: * @brief Create the animated image Visual using the image URL. * * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object - * @param[in] imageUrl The URL to svg resource to use + * @param[in] imageUrl The URL to gif resource to use * @param[in] properties A Property::Map containing settings for this visual * @return A smart-pointer to the newly allocated visual. */ static AnimatedImageVisualPtr New( VisualFactoryCache& factoryCache, const VisualUrl& imageUrl, const Property::Map& properties ); /** + * @brief Create the animated image Visual using image URLs. + * + * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object + * @param[in] imageUrls A Property::Array containing the URLs to the image resources + * @param[in] properties A Property::Map containing settings for this visual + * @return A smart-pointer to the newly allocated visual. + */ + static AnimatedImageVisualPtr New( VisualFactoryCache& factoryCache, const Property::Array& imageUrls, const Property::Map& properties ); + + /** * @brief Create the animated image visual using the image URL. * * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object @@ -105,6 +131,11 @@ public: // from Visual */ virtual void DoCreateInstancePropertyMap( Property::Map& map ) const; + /** + * @copydoc Visual::Base::OnDoAction + */ + virtual void OnDoAction( const Dali::Property::Index actionName, const Dali::Property::Value& attributes ) override; + protected: /** @@ -125,6 +156,13 @@ protected: virtual void DoSetProperties( const Property::Map& propertyMap ); /** + * Helper method to set individual values by index key. + * @param[in] index The index key of the value + * @param[in] value The value + */ + void DoSetProperty( Property::Index index, const Property::Value& value ); + + /** * @copydoc Visual::Base::DoSetOnStage */ virtual void DoSetOnStage( Actor& actor ); @@ -140,18 +178,52 @@ protected: virtual void OnSetTransform(); private: + /** + * Creates the renderer for the animated image + */ + void CreateRenderer(); /** - * Load the animated image and pack the frames into atlas. - * @return That atlas texture. + * Starts the Load of the first batch of URLs */ - Texture PrepareAnimatedImage(); + void LoadFirstBatch(); /** - * Display the next frame. It is called when the mFrameDelayTimes ticks. + * Adds the texture set to the renderer, and the renderer to the + * placement actor, and starts the frame timer + * @param[in] textureSet The texture set to apply + */ + void StartFirstFrame( TextureSet& textureSet ); + + /** + * Prepares the texture set for displaying + */ + TextureSet PrepareTextureSet(); + + /** + * Set the image size from the texture set + * @param[in] textureSet The texture set to get the size from + */ + void SetImageSize( TextureSet& textureSet ); + + /** + * Called when the next frame is ready. + * @param[in] textureSet the texture set to apply + */ + void FrameReady( TextureSet textureSet ); + + /** + * Display the next frame. It is called when the mFrameDelayTimer ticks. + * Returns true to ensure the timer continues running. */ bool DisplayNextFrame(); + /** + * Initialize the gif variables. + * @param[in] imageUrl The url of the animated gif + */ + void InitializeGif( const VisualUrl& imageUrl ); + // Undefined AnimatedImageVisual( const AnimatedImageVisual& animatedImageVisual ); @@ -161,15 +233,33 @@ private: private: Timer mFrameDelayTimer; - Dali::Vector mTextureRectContainer; + WeakHandle mPlacementActor; + + // Variables for GIF player Dali::Vector mFrameDelayContainer; Vector4 mPixelArea; VisualUrl mImageUrl; - + std::unique_ptr mGifLoading; // Only needed for animated gifs + uint32_t mCurrentFrameIndex; // Frame index into textureRects + + // Variables for Multi-Image player + ImageCache::UrlList* mImageUrls; + ImageCache* mImageCache; + uint16_t mCacheSize; + uint16_t mBatchSize; + uint16_t mFrameDelay; + int16_t mLoopCount; + int16_t mCurrentLoopIndex; + uint16_t mUrlIndex; + + // Shared variables + uint32_t mFrameCount; // Number of frames ImageDimensions mImageSize; - uint32_t mCurrentFrameIndex; + Dali::WrapMode::Type mWrapModeU:3; Dali::WrapMode::Type mWrapModeV:3; + DevelAnimatedImageVisual::Action::Type mActionStatus:2; + bool mStartFirstFrame:1; }; } // namespace Internal