2 * Copyright (c) 2016 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include "animated-image-visual.h"
22 #include <dali/devel-api/adaptor-framework/gif-loading.h>
25 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
26 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
27 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
28 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
29 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
30 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
31 #include <dali-toolkit/internal/visuals/image/image-visual.h>
32 #include <dali-toolkit/devel-api/image-loader/image-atlas.h>
46 DALI_ENUM_TO_STRING_TABLE_BEGIN( WRAP_MODE )
47 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, DEFAULT )
48 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, CLAMP_TO_EDGE )
49 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, REPEAT )
50 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, MIRRORED_REPEAT )
51 DALI_ENUM_TO_STRING_TABLE_END( WRAP_MODE )
53 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
57 AnimatedImageVisualPtr AnimatedImageVisual::New( VisualFactoryCache& factoryCache, const std::string& imageUrl, const Property::Map& properties )
59 AnimatedImageVisual* visual = new AnimatedImageVisual( factoryCache );
60 visual->mImageUrl = imageUrl;
61 visual->SetProperties( properties );
66 AnimatedImageVisualPtr AnimatedImageVisual::New( VisualFactoryCache& factoryCache, const std::string& imageUrl )
68 AnimatedImageVisual* visual = new AnimatedImageVisual( factoryCache );
69 visual->mImageUrl = imageUrl;
74 AnimatedImageVisual::AnimatedImageVisual( VisualFactoryCache& factoryCache )
75 : Visual::Base( factoryCache ),
77 mPixelArea( FULL_TEXTURE_RECT ),
80 mCurrentFrameIndex( 0 ),
81 mWrapModeU( WrapMode::DEFAULT ),
82 mWrapModeV( WrapMode::DEFAULT )
85 AnimatedImageVisual::~AnimatedImageVisual()
89 void AnimatedImageVisual::GetNaturalSize( Vector2& naturalSize )
91 if( mImageSize.GetWidth() == 0 && mImageSize.GetHeight() == 0)
93 mImageSize = Dali::GetGifImageSize( mImageUrl );
96 naturalSize.width = mImageSize.GetWidth();
97 naturalSize.height = mImageSize.GetHeight();
100 void AnimatedImageVisual::DoCreatePropertyMap( Property::Map& map ) const
104 map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::DevelVisual::ANIMATED_IMAGE );
106 if( !mImageUrl.empty() )
108 map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl );
111 map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
112 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
113 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
116 void AnimatedImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
121 void AnimatedImageVisual::DoSetProperties( const Property::Map& propertyMap )
123 // url already passed in from constructor
125 Property::Value* pixelAreaValue = propertyMap.Find( Toolkit::ImageVisual::Property::PIXEL_AREA, PIXEL_AREA_UNIFORM_NAME );
128 pixelAreaValue->Get( mPixelArea );
131 Property::Value* wrapModeValueU = propertyMap.Find( Toolkit::ImageVisual::Property::WRAP_MODE_U, IMAGE_WRAP_MODE_U );
135 Scripting::GetEnumerationProperty( *wrapModeValueU, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, value );
136 mWrapModeU = Dali::WrapMode::Type( value );
139 Property::Value* wrapModeValueV = propertyMap.Find( Toolkit::ImageVisual::Property::WRAP_MODE_V, IMAGE_WRAP_MODE_V );
143 Scripting::GetEnumerationProperty( *wrapModeValueV, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, value );
144 mWrapModeV = Dali::WrapMode::Type( value );
148 void AnimatedImageVisual::DoSetOnStage( Actor& actor )
150 Texture texture = PrepareAnimatedImage();
151 if( texture ) // if the image loading is successful
153 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
154 Shader shader = ImageVisual::GetImageShader( mFactoryCache, true, defaultWrapMode );
156 Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
158 TextureSet textureSet = TextureSet::New();
159 textureSet.SetTexture( 0u, texture );
161 mImpl->mRenderer = Renderer::New( geometry, shader );
162 mImpl->mRenderer.SetTextures( textureSet );
164 // Register transform properties
165 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
167 if( !defaultWrapMode ) // custom wrap mode
169 Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
170 wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
171 mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
174 if( mPixelArea != FULL_TEXTURE_RECT )
176 mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
179 mCurrentFrameIndex = 0;
180 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, mTextureRectContainer[mCurrentFrameIndex] );
181 if( mFrameDelayContainer.Count() > 1 )
183 mFrameDelayTimer = Timer::New( mFrameDelayContainer[0] );
184 mFrameDelayTimer.TickSignal().Connect( this, &AnimatedImageVisual::DisplayNextFrame );
185 mFrameDelayTimer.Start();
188 actor.AddRenderer( mImpl->mRenderer );
192 void AnimatedImageVisual::DoSetOffStage( Actor& actor )
194 if( !mImpl->mRenderer )
199 if( mFrameDelayTimer )
201 mFrameDelayTimer.Stop();
202 mFrameDelayTimer.Reset();
205 mTextureRectContainer.Clear();
206 mFrameDelayContainer.Clear();
208 actor.RemoveRenderer( mImpl->mRenderer );
209 mImpl->mRenderer.Reset();
212 void AnimatedImageVisual::OnSetTransform()
214 if( mImpl->mRenderer )
216 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
220 Texture AnimatedImageVisual::PrepareAnimatedImage()
222 // load from image file
223 std::vector<Dali::PixelData> pixelDataList;
224 if( Dali::LoadAnimatedGifFromFile( mImageUrl.c_str() , pixelDataList, mFrameDelayContainer ) )
226 mImageSize.SetWidth( pixelDataList[0].GetWidth() );
227 mImageSize.SetHeight( pixelDataList[0].GetHeight() );
229 return Toolkit::ImageAtlas::PackToAtlas( pixelDataList, mTextureRectContainer );
235 bool AnimatedImageVisual::DisplayNextFrame()
237 mCurrentFrameIndex = (mCurrentFrameIndex+1) % mFrameDelayContainer.Count();
238 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, mTextureRectContainer[mCurrentFrameIndex] );
239 if( mFrameDelayTimer.GetInterval() != mFrameDelayContainer[mCurrentFrameIndex] )
241 mFrameDelayTimer.SetInterval( mFrameDelayContainer[mCurrentFrameIndex] );
248 } // namespace Internal
250 } // namespace Toolkit