1 #ifndef __DALI_TOOLKIT_INTERNAL_CUBE_TRANSITION_EFFECT_H__
2 #define __DALI_TOOLKIT_INTERNAL_CUBE_TRANSITION_EFFECT_H__
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
24 #include <dali/dali.h>
25 #include <dali-toolkit/public-api/transition-effects/cube-transition-effect.h>
33 class CubeTransitionEffect;
39 * Create a image with size of viewAreaSize
40 * with the effect image as its center part and (0,0,0,1) at other parts
42 class FullAreaImageCreator : public ShaderEffect
48 * Create an uninitialized FullAreaImageCreator
49 * this can be initialized with FullAreaImageCreator::New()
51 FullAreaImageCreator(){}
56 virtual ~FullAreaImageCreator(){}
59 * Create an initialized FullAreaImageCreator.
60 * @return A handle to a newly allocated Dali resource.
62 static FullAreaImageCreator New()
64 std::string vertexShader(
65 "uniform vec4 uRegion; \n"
68 " gl_Position = uProjection * uModelView * vec4(aPosition, 1.0);\n"
69 " vTexCoord.s = (aTexCoord.s - uRegion.s) / uRegion.p;"
70 " vTexCoord.t = ( 1.0 - aTexCoord.t - uRegion.t) / uRegion.q;"
74 std::string fragmentShader(
75 "uniform vec4 uRegion; \n"
78 " if( vTexCoord.s > 0.0 && vTexCoord.s < 1.0 && vTexCoord.t > 0.0 && vTexCoord.t < 1.0) \n"
80 " gl_FragColor = texture2D( sEffect, vTexCoord ) * uColor ; \n"
84 " gl_FragColor = vec4( 0.0, 0.0, 0.0, 1.0 ); \n"
89 ShaderEffect shaderEffectCustom = ShaderEffect::New(vertexShader, fragmentShader);
90 FullAreaImageCreator handle( shaderEffectCustom );
96 * Set up the position and size of the effect texture
97 * @param[in] viewArea the size of full-area image to create
98 * @param[in] size the size of effect texture
100 void SetRegionSize( const Vector2& viewArea, const Vector2& size )
102 Vector2 sizeRatio( std::min(1.f, size.x / viewArea.x), std::min(1.f, size.y / viewArea.y) );
103 Vector4 region( (1.f-sizeRatio.x)*0.5f,
104 (1.f-sizeRatio.y)*0.5f,
107 SetUniform( "uRegion", region );
112 FullAreaImageCreator( ShaderEffect handle )
113 : ShaderEffect( handle )
121 * CubeTransitionEffect implementation class
123 class CubeTransitionEffect : public Dali::BaseObject, public ConnectionTracker
131 ~CubeTransitionEffect();
134 * @copydoc Toolkit::CubeTransitionEffect::SetTransitionDuration
136 void SetTransitionDuration( float duration );
139 * @copydoc Toolkit::CubeTransitionEffect::GetTransitionDuration
141 float GetTransitionDuration() const;
144 * @copydoc Toolkit::CubeTransitionEffect::SetCubeDisplacement
146 void SetCubeDisplacement( float displacement );
149 * @copydoc Toolkit::CubeTransitionEffect::GetCubeDisplacement
151 float GetCubeDisplacement() const;
154 * @copydoc Toolkit::CubeTransitionEffect::GetRoot
159 * @copydoc Toolkit::CubeTransitionEffect::IsTransiting
164 * @copydoc Toolkit::CubeTransitionEffect::SetFirstImage
166 void SetCurrentImage(ImageActor imageActor);
169 * @copydoc Toolkit::CubeTransitionEffect::SetTargetImage
171 void SetTargetImage(ImageActor imageActor);
174 * @copydoc Toolkit::CubeTransitionEffect::StartTransition(bool)
176 void StartTransition( bool toNextImage = true );
179 * @copydoc Toolkit::CubeTransitionEffect::StartTransition(Vector2, Vector2)
181 void StartTransition( Vector2 panPosition, Vector2 panDisplacement );
184 * @copydoc Toolkit::CubeTransitionEffect::PauseTransition()
186 void PauseTransition();
189 * @copydoc Toolkit::CubeTransitionEffect::ResumeTransition()
191 void ResumeTransition();
194 * @copydoc Toolkit::CubeTransitionEffect::StopTransition()
196 void StopTransition();
201 * @copydoc Toolkit::CubeTransitionEffect::TransitionCompletedSignal()
203 Toolkit::CubeTransitionEffect::TransitionCompletedSignalV2& TransitionCompletedSignal();
208 * Construct a new CubeTransitionEffect object
209 * Called in the constructor of subclasses
210 * @param[in] numRows How many rows of cubes
211 * @param[in] numColumns How many columns of cubes
212 * @param[in] viewAreaSize The size of view area for this transition effect
214 CubeTransitionEffect( unsigned int numRows, unsigned int numColumns, Size viewAreaSize );
217 * Initialization steps: creating a layer, two groups of tiles,
218 * and one group of actors (cubes) serving as parents of every two tiles (one from each image).
225 * Create an image actor to serve as a face of the cube
226 * @param[in] image The image to display.
227 * @param[in] color The color to set to the actor
228 * @return The tile actor created
230 ImageActor CreateTile( Image image, const Vector4& color );
233 * Set Image content to tiles
234 * As only when the image ready, can we get correct image attributes
235 * so inside this function, the process needs to be passed to callBack of image resource loading succeed.
236 * @param[in] imageActor The imageActor whose image content will be set to the tiles
238 void SetImage(ImageActor imageActor);
241 * Callback function of image resource loading succeed
242 * Set image and pixelArea to tiles
243 * @param[in] image The image content of the imageActor for transition
245 void OnImageLoaded(Image image);
248 * Callback function of transition animation finished
249 * Hide transition layer, show current imageActor, and set isAnimating flag to false
250 * @param[in] source The cube transition animation
252 void OnTransitionFinished(Animation& source);
255 * This method is called after the CubeTransitionEffect has been initialized. Derived classes should do
256 * any second phase initialization by overriding this method.
258 virtual void OnInitialize() { }
261 * This method is called after the a new transition is activated.
262 * Derived classes should do any specialized transition process by overriding this method.
263 * @param[in] panPosition The press down position of panGesture
264 * @param[in] panDisplacement The displacement vector of panGesture
266 virtual void OnStartTransition( Vector2 panPosition, Vector2 panDisplacement ) {}
269 * This method is called when the transition is forced stop in the middle of animation.
270 * Derived classed should set the rotation status of the cubes to the same as the final state when the animation is finished completely.
271 * So that the next transition would be started correctly.
273 virtual void OnStopTransition() {}
278 unsigned int mNumRows;
279 unsigned int mNumColumns;
281 ActorContainer mBoxes;
282 std::vector< ImageActor > mTiles[2];
287 ImageActor mCurrentImage;
288 unsigned int mContainerIndex; //have the value 0 or 1, refer to mTiles[0] or mTiles[1]
290 bool mChangeTurningDirection;
291 bool mIsToNextImage; //if true, cubes rotate counter-clockwise; else clockwise
292 bool mIsImageLoading;
294 float mAnimationDuration;
295 Animation mAnimation;
299 float mCubeDisplacement;
301 bool mFirstTransition;
303 RenderTask mOffScreenTask;
304 FrameBufferImage mOffScreenBuffer[2];
305 ImageActor mEmptyImage;
306 FullAreaImageCreator mFullImageCreator;
307 unsigned int mBufferIndex;
309 static const Vector4 FULL_BRIGHTNESS;
310 static const Vector4 HALF_BRIGHTNESS;
314 Toolkit::CubeTransitionEffect::TransitionCompletedSignalV2 mTransitionCompletedSignalV2;
318 } // namespace Internal
320 // Helpers for public-api forwarding methods
322 inline Internal::CubeTransitionEffect& GetImpl(Dali::Toolkit::CubeTransitionEffect& obj)
324 DALI_ASSERT_ALWAYS(obj);
326 Dali::BaseObject& handle = obj.GetBaseObject();
328 return static_cast<Internal::CubeTransitionEffect&>(handle);
331 inline const Internal::CubeTransitionEffect& GetImpl(const Dali::Toolkit::CubeTransitionEffect& obj)
333 DALI_ASSERT_ALWAYS(obj);
335 const Dali::BaseObject& handle = obj.GetBaseObject();
337 return static_cast<const Internal::CubeTransitionEffect&>(handle);
340 } // namespace Toolkit
344 #endif /* __DALI_TOOLKIT_INTERNAL_CUBE_TRANSITION_EFFECT_H__ */