#define DALI_TOOLKIT_INTERNAL_ANIMATED_IMAGE_VISUAL_H
/*
- * Copyright (c) 2020 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 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.
*/
// EXTERNAL INCLUDES
+#include <dali/devel-api/adaptor-framework/animated-image-loading.h>
+#include <dali/public-api/adaptor-framework/timer.h>
#include <dali/public-api/common/dali-vector.h>
#include <dali/public-api/common/intrusive-ptr.h>
#include <dali/public-api/math/vector4.h>
#include <dali/public-api/object/weak-handle.h>
-#include <dali/public-api/adaptor-framework/timer.h>
-#include <dali/devel-api/adaptor-framework/animated-image-loading.h>
// INTERNAL INCLUDES
+#include <dali-toolkit/devel-api/visuals/animated-image-visual-actions-devel.h>
+#include <dali-toolkit/devel-api/visuals/image-visual-properties-devel.h>
+#include <dali-toolkit/internal/visuals/animated-image/image-cache.h>
#include <dali-toolkit/internal/visuals/visual-base-impl.h>
#include <dali-toolkit/internal/visuals/visual-url.h>
-#include <dali-toolkit/internal/visuals/animated-image/image-cache.h>
-#include <dali-toolkit/devel-api/visuals/animated-image-visual-actions-devel.h>
namespace Dali
{
-
namespace Toolkit
{
-
namespace Internal
{
-
class ImageVisualShaderFactory;
class AnimatedImageVisual;
-typedef IntrusivePtr< AnimatedImageVisual > AnimatedImageVisualPtr;
+typedef IntrusivePtr<AnimatedImageVisual> AnimatedImageVisualPtr;
/**
* The visual which renders an animated image
public ConnectionTracker,
public ImageCache::FrameReadyObserver
{
-
public:
-
/**
* @brief Create the animated image Visual using the image URL.
*
* @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, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties );
+ static AnimatedImageVisualPtr New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties);
/**
* @brief Create the animated image Visual using image URLs.
* @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, ImageVisualShaderFactory& shaderFactory, const Property::Array& imageUrls, const Property::Map& properties );
+ static AnimatedImageVisualPtr New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const Property::Array& imageUrls, const Property::Map& properties);
/**
* @brief Create the animated image visual using the image URL.
* @param[in] shaderFactory The ImageVisualShaderFactory object
* @param[in] imageUrl The URL to animated image resource to use
*/
- static AnimatedImageVisualPtr New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl );
-
-public: // from Visual
+ static AnimatedImageVisualPtr New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl);
+public: // from Visual
/**
* @copydoc Visual::Base::GetNaturalSize
*/
- void GetNaturalSize( Vector2& naturalSize ) override;
+ void GetNaturalSize(Vector2& naturalSize) override;
/**
* @copydoc Visual::Base::CreatePropertyMap
*/
- void DoCreatePropertyMap( Property::Map& map ) const override;
+ void DoCreatePropertyMap(Property::Map& map) const override;
/**
* @copydoc Visual::Base::CreateInstancePropertyMap
*/
- void DoCreateInstancePropertyMap( Property::Map& map ) const override;
+ void DoCreateInstancePropertyMap(Property::Map& map) const override;
/**
* @copydoc Visual::Base::OnDoAction
*/
- void OnDoAction( const Dali::Property::Index actionName, const Dali::Property::Value& attributes ) override;
+ void OnDoAction(const Dali::Property::Index actionName, const Dali::Property::Value& attributes) override;
protected:
-
/**
* @brief Constructor.
*
* @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
* @param[in] shaderFactory The ImageVisualShaderFactory object
*/
- AnimatedImageVisual( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory );
+ AnimatedImageVisual(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory);
/**
* @brief A reference counted object may only be deleted by calling Unreference().
*/
- virtual ~AnimatedImageVisual();
+ ~AnimatedImageVisual() override;
+
+ /**
+ * @copydoc Visual::Base::OnInitialize
+ */
+ void OnInitialize() override;
/**
* @copydoc Visual::Base::DoSetProperties
*/
- void DoSetProperties( const Property::Map& propertyMap ) override;
+ void DoSetProperties(const Property::Map& propertyMap) override;
/**
* 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 );
+ void DoSetProperty(Property::Index index, const Property::Value& value);
/**
* @copydoc Visual::Base::DoSetOnScene
*/
- void DoSetOnScene( Actor& actor ) override;
+ void DoSetOnScene(Actor& actor) override;
/**
* @copydoc Visual::Base::DoSetOffScene
*/
- void DoSetOffScene( Actor& actor ) override;
+ void DoSetOffScene(Actor& actor) override;
/**
* @copydoc Visual::Base::OnSetTransform
*/
void OnSetTransform() override;
+ /**
+ * @copydoc Visual::Base::UpdateShader
+ */
+ void UpdateShader() override;
+
+ /**
+ * @copydoc Visual::Base::GenerateShader
+ */
+ Shader GenerateShader() const override;
+
private:
/**
* Creates the renderer for the animated image
* placement actor, and starts the frame timer
* @param[in] textureSet The texture set to apply
*/
- void StartFirstFrame( TextureSet& textureSet );
+ void StartFirstFrame(TextureSet& textureSet);
/**
* Prepares the texture set for displaying
* Set the image size from the texture set
* @param[in] textureSet The texture set to get the size from
*/
- void SetImageSize( TextureSet& textureSet );
+ void SetImageSize(TextureSet& textureSet);
/**
* Called when the next frame is ready.
* @param[in] textureSet the texture set to apply
*/
- void FrameReady( TextureSet textureSet );
+ void FrameReady(TextureSet textureSet) override;
/**
* Display the next frame. It is called when the mFrameDelayTimer ticks.
* Initialize the animated image variables.
* @param[in] imageUrl The url of the animated image
*/
- void InitializeAnimatedImage( const VisualUrl& imageUrl );
+ void InitializeAnimatedImage(const VisualUrl& imageUrl);
+
+ /**
+ * Set the state of loading fail of an image or a frame.
+ * Returns TextureSet of broken image.
+ */
+ TextureSet SetLoadingFailed();
// Undefined
- AnimatedImageVisual( const AnimatedImageVisual& animatedImageVisual );
+ AnimatedImageVisual(const AnimatedImageVisual& animatedImageVisual);
// Undefined
- AnimatedImageVisual& operator=( const AnimatedImageVisual& animatedImageVisual );
+ AnimatedImageVisual& operator=(const AnimatedImageVisual& animatedImageVisual);
private:
-
- Timer mFrameDelayTimer;
- WeakHandle<Actor> mPlacementActor;
+ Timer mFrameDelayTimer;
+ WeakHandle<Actor> mPlacementActor;
ImageVisualShaderFactory& mImageVisualShaderFactory;
// Variables for Animated Image player
- Vector4 mPixelArea;
- VisualUrl mImageUrl;
+ Vector4 mPixelArea;
+ VisualUrl mImageUrl;
Dali::AnimatedImageLoading mAnimatedImageLoading; // Only needed for animated image
- uint32_t mCurrentFrameIndex; // Frame index into textureRects
+ uint32_t mFrameIndexForJumpTo; // 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;
+ 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
+ uint32_t mFrameCount; // Number of frames
ImageDimensions mImageSize;
- Dali::WrapMode::Type mWrapModeU:3;
- Dali::WrapMode::Type mWrapModeV:3;
- DevelAnimatedImageVisual::Action::Type mActionStatus:3;
- DevelImageVisual::StopBehavior::Type mStopBehavior:2;
- bool mStartFirstFrame:1;
- bool mIsJumpTo:1;
+ DevelAnimatedImageVisual::Action::Type mActionStatus;
+
+ Dali::WrapMode::Type mWrapModeU : 3;
+ Dali::WrapMode::Type mWrapModeV : 3;
+ DevelImageVisual::StopBehavior::Type mStopBehavior : 2;
+ bool mStartFirstFrame : 1;
+ bool mIsJumpTo : 1;
};
} // namespace Internal
projects / platform / core / uifw / dali-toolkit.git / blobdiff