2 * Copyright (c) 2014 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.
22 #include "../shared/view.h"
23 #include <dali/dali.h>
24 #include <dali-toolkit/dali-toolkit.h>
27 using namespace Dali::Toolkit;
31 const char * const BACKGROUND_IMAGE( DALI_IMAGE_DIR "background-default.png" );
32 const char * const TOOLBAR_IMAGE( DALI_IMAGE_DIR "top-bar.png" );
33 const char * const APPLICATION_TITLE( "ScrollView" );
34 const char * const EFFECT_DEPTH_IMAGE( DALI_IMAGE_DIR "icon-scroll-view-depth.png" );
35 const char * const EFFECT_INNER_CUBE_IMAGE( DALI_IMAGE_DIR "icon-scroll-view-inner-cube.png" );
36 const char * const EFFECT_CAROUSEL_IMAGE( DALI_IMAGE_DIR "icon-scroll-view-carousel.png" );
38 const Vector3 ICON_SIZE(100.0f, 100.0f, 0.0f);
40 const char* EFFECT_MODE_NAME[] = {
48 const char * const IMAGE_PATHS[] = {
49 DALI_IMAGE_DIR "gallery-medium-1.jpg",
50 DALI_IMAGE_DIR "gallery-medium-2.jpg",
51 DALI_IMAGE_DIR "gallery-medium-3.jpg",
52 DALI_IMAGE_DIR "gallery-medium-4.jpg",
53 DALI_IMAGE_DIR "gallery-medium-5.jpg",
54 DALI_IMAGE_DIR "gallery-medium-6.jpg",
55 DALI_IMAGE_DIR "gallery-medium-7.jpg",
56 DALI_IMAGE_DIR "gallery-medium-8.jpg",
57 DALI_IMAGE_DIR "gallery-medium-9.jpg",
58 DALI_IMAGE_DIR "gallery-medium-10.jpg",
59 DALI_IMAGE_DIR "gallery-medium-11.jpg",
60 DALI_IMAGE_DIR "gallery-medium-12.jpg",
61 DALI_IMAGE_DIR "gallery-medium-13.jpg",
62 DALI_IMAGE_DIR "gallery-medium-14.jpg",
63 DALI_IMAGE_DIR "gallery-medium-15.jpg",
64 DALI_IMAGE_DIR "gallery-medium-16.jpg",
65 DALI_IMAGE_DIR "gallery-medium-17.jpg",
66 DALI_IMAGE_DIR "gallery-medium-18.jpg",
67 DALI_IMAGE_DIR "gallery-medium-19.jpg",
68 DALI_IMAGE_DIR "gallery-medium-20.jpg",
69 DALI_IMAGE_DIR "gallery-medium-21.jpg",
70 DALI_IMAGE_DIR "gallery-medium-22.jpg",
71 DALI_IMAGE_DIR "gallery-medium-23.jpg",
72 DALI_IMAGE_DIR "gallery-medium-24.jpg",
73 DALI_IMAGE_DIR "gallery-medium-25.jpg",
74 DALI_IMAGE_DIR "gallery-medium-26.jpg",
75 DALI_IMAGE_DIR "gallery-medium-27.jpg",
76 DALI_IMAGE_DIR "gallery-medium-28.jpg",
77 DALI_IMAGE_DIR "gallery-medium-29.jpg",
78 DALI_IMAGE_DIR "gallery-medium-30.jpg",
79 DALI_IMAGE_DIR "gallery-medium-31.jpg",
80 DALI_IMAGE_DIR "gallery-medium-32.jpg",
81 DALI_IMAGE_DIR "gallery-medium-33.jpg",
82 DALI_IMAGE_DIR "gallery-medium-34.jpg",
83 DALI_IMAGE_DIR "gallery-medium-35.jpg",
84 DALI_IMAGE_DIR "gallery-medium-36.jpg",
85 DALI_IMAGE_DIR "gallery-medium-37.jpg",
86 DALI_IMAGE_DIR "gallery-medium-38.jpg",
87 DALI_IMAGE_DIR "gallery-medium-39.jpg",
88 DALI_IMAGE_DIR "gallery-medium-40.jpg",
89 DALI_IMAGE_DIR "gallery-medium-41.jpg",
90 DALI_IMAGE_DIR "gallery-medium-42.jpg",
91 DALI_IMAGE_DIR "gallery-medium-43.jpg",
92 DALI_IMAGE_DIR "gallery-medium-44.jpg",
93 DALI_IMAGE_DIR "gallery-medium-45.jpg",
94 DALI_IMAGE_DIR "gallery-medium-46.jpg",
95 DALI_IMAGE_DIR "gallery-medium-47.jpg",
96 DALI_IMAGE_DIR "gallery-medium-48.jpg",
97 DALI_IMAGE_DIR "gallery-medium-49.jpg",
98 DALI_IMAGE_DIR "gallery-medium-50.jpg",
99 DALI_IMAGE_DIR "gallery-medium-51.jpg",
100 DALI_IMAGE_DIR "gallery-medium-52.jpg",
101 DALI_IMAGE_DIR "gallery-medium-53.jpg",
106 const char * const GetNextImagePath()
108 static const char * const * imagePtr = &IMAGE_PATHS[0];
110 if ( *(++imagePtr) == NULL )
112 imagePtr = &IMAGE_PATHS[0];
118 const int PAGE_COLUMNS = 10; ///< Number of Pages going across (columns)
119 const int PAGE_ROWS = 1; ///< Number of Pages going down (rows)
120 const int IMAGE_ROWS = 5; ///< Number of Images going down (rows) with a Page
122 // 3D Effect constants
123 const Vector3 ANGLE_CUBE_PAGE_ROTATE(Math::PI * 0.2f, Math::PI * 0.2f, 0.0f); ///< Cube page rotates as if it has ten sides with the camera positioned inside
124 const Vector2 ANGLE_CUSTOM_CUBE_SWING(-Math::PI * 0.45f, -Math::PI * 0.45f); ///< outer cube pages swing 90 degrees as they pan offscreen
125 const Vector2 ANGLE_SPIRAL_SWING_IN(Math::PI * 0.45f, Math::PI * 0.45f);
126 const Vector2 ANGLE_SPIRAL_SWING_OUT(Math::PI * 0.3f, Math::PI * 0.3f);
128 // Depth Effect constants
129 const Vector2 POSITION_EXTENT_DEPTH_EFFECT(0.5f, 2.5f); ///< Extent of X & Y position to alter function exponent.
130 const Vector2 OFFSET_EXTENT_DEPTH_EFFECT(1.0f, 1.0f); ///< Function exponent offset constant.
131 const float POSITION_SCALE_DEPTH_EFFECT(1.5f); ///< Position scaling.
132 const float SCALE_EXTENT_DEPTH_EFFECT(0.5f); ///< Maximum scale factor when Actors scrolled one page away (50% size)
134 // 3D Effect constants
135 const Vector2 ANGLE_SWING_3DEFFECT(Math::PI_2 * 0.75, Math::PI_2 * 0.75f); ///< Angle Swing in radians
136 const Vector2 POSITION_SWING_3DEFFECT(0.25f, 0.25f); ///< Position Swing relative to stage size.
137 const Vector3 ANCHOR_3DEFFECT_STYLE0(-105.0f, 30.0f, -240.0f); ///< Rotation Anchor position for 3D Effect (Style 0)
138 const Vector3 ANCHOR_3DEFFECT_STYLE1(65.0f, -70.0f, -300.0f); ///< Rotation Anchor position for 3D Effect (Style 1)
141 const unsigned int IMAGE_THUMBNAIL_WIDTH = 256; ///< Width of Thumbnail Image in texels
142 const unsigned int IMAGE_THUMBNAIL_HEIGHT = 256; ///< Height of Thumbnail Image in texels
144 const float SPIN_DURATION = 5.0f; ///< Times to spin an Image by upon touching, each spin taking a second.
146 const float EFFECT_SNAP_DURATION(0.66f); ///< Scroll Snap Duration for Effects
147 const float EFFECT_FLICK_DURATION(0.5f); ///< Scroll Flick Duration for Effects
149 } // unnamed namespace
152 * This example shows how to do custom Scroll Effects
154 class ExampleController : public ConnectionTracker
160 * @param application class, stored as reference
162 ExampleController( Application& application )
163 : mApplication( application ),
166 mEffectMode(CubeEffect)
168 // Connect to the Application's Init and orientation changed signal
169 mApplication.InitSignal().Connect(this, &ExampleController::OnInit);
174 // Nothing to do here; everything gets deleted automatically
178 * This method gets called once the main loop of application is up and running
180 void OnInit(Application& app)
182 Stage stage = Dali::Stage::GetCurrent();
183 stage.KeyEventSignal().Connect(this, &ExampleController::OnKeyEvent);
185 // Hide the indicator bar
186 mApplication.GetWindow().ShowIndicator(Dali::Window::INVISIBLE);
188 // Creates a default view with a default tool bar.
189 // The view is added to the stage.
190 mContentLayer = DemoHelper::CreateView( app,
197 mEffectIcon[ DepthEffect ] = Image::New( EFFECT_DEPTH_IMAGE );
198 mEffectIcon[ CubeEffect ] = Image::New( EFFECT_INNER_CUBE_IMAGE );
199 mEffectIcon[ PageCarouselEffect ] = Image::New( EFFECT_CAROUSEL_IMAGE );
200 mEffectIcon[ PageCubeEffect ] = Image::New( EFFECT_CAROUSEL_IMAGE );
201 mEffectIcon[ PageSpiralEffect ] = Image::New( EFFECT_CAROUSEL_IMAGE );
203 // Create a effect change button. (right of toolbar)
204 mEffectChangeButton = Toolkit::PushButton::New();
205 mEffectChangeButton.ClickedSignal().Connect( this, &ExampleController::OnEffectTouched );
206 mToolBar.AddControl( mEffectChangeButton, DemoHelper::DEFAULT_VIEW_STYLE.mToolBarButtonPercentage, Toolkit::Alignment::HorizontalRight, DemoHelper::DEFAULT_MODE_SWITCH_PADDING );
208 // Create the content layer.
211 // Hack to force screen refresh.
212 Animation animation = Animation::New(1.0f);
213 animation.AnimateTo(Property(mContentLayer, Actor::POSITION), Vector3::ZERO );
220 * Adds content to the ContentLayer. This is everything we see
221 * excluding the toolbar at the top.
223 void AddContentLayer()
225 Stage stage = Stage::GetCurrent();
226 Vector2 stageSize = stage.GetSize();
228 mScrollView = ScrollView::New();
229 mScrollView.SetAnchorPoint(AnchorPoint::CENTER);
230 mScrollView.SetParentOrigin(ParentOrigin::CENTER);
231 mContentLayer.Add( mScrollView );
232 mScrollView.SetSize( stageSize );
233 mScrollView.SetAxisAutoLock( true );
234 mScrollView.SetAxisAutoLockGradient( 1.0f );
236 mScrollView.ScrollStartedSignal().Connect( this, &ExampleController::OnScrollStarted );
237 mScrollView.ScrollCompletedSignal().Connect( this, &ExampleController::OnScrollCompleted );
239 for(int row = 0;row<PAGE_ROWS;row++)
241 for(int column = 0;column<PAGE_COLUMNS;column++)
243 Actor page = CreatePage();
245 page.SetPosition( column * stageSize.x, row * stageSize.y );
246 mScrollView.Add( page );
248 mPages.push_back(page);
256 * Updates the ScrollView and it's children based
257 * on the current effect.
261 std::stringstream ss(APPLICATION_TITLE);
262 ss << APPLICATION_TITLE << ": " << EFFECT_MODE_NAME[mEffectMode];
265 mEffectChangeButton.SetBackgroundImage( mEffectIcon[ mEffectMode ] );
267 // remove old Effect if exists.
268 if(mScrollViewEffect)
270 mScrollView.RemoveEffect(mScrollViewEffect);
273 // apply new Effect to ScrollView
274 ApplyEffectToScrollView();
276 for(ActorIter pageIter = mPages.begin(); pageIter != mPages.end(); ++pageIter)
278 Actor page = *pageIter;
279 ApplyEffectToPage( page );
281 unsigned int numChildren = (*pageIter).GetChildCount();
282 for(unsigned int i=0; i<numChildren; ++i)
284 Actor image = (*pageIter).GetChildAt(i);
286 // Remove old effect's manual constraints.
287 image.RemoveConstraints();
289 // Apply new effect's manual constraints.
290 ApplyEffectToActor( image, page );
296 * Creates a page using a source of images.
300 Actor page = Actor::New();
301 page.ApplyConstraint( Constraint::New<Vector3>( Actor::SIZE, ParentSource( Actor::SIZE ), EqualToConstraint() ) );
302 page.SetParentOrigin( ParentOrigin::CENTER );
303 page.SetAnchorPoint( AnchorPoint::CENTER );
305 Stage stage = Stage::GetCurrent();
306 Vector2 stageSize = stage.GetSize();
308 const float margin = 10.0f;
310 // Calculate the number of images going across (columns) within a page, according to the screen resolution and dpi.
311 int imageColumns = round(IMAGE_ROWS * (stageSize.x / stage.GetDpi().x) / (stageSize.y / stage.GetDpi().y));
312 const Vector3 imageSize((stageSize.x / imageColumns) - margin, (stageSize.y / IMAGE_ROWS) - margin, 0.0f);
314 for(int row = 0;row<IMAGE_ROWS;row++)
316 for(int column = 0;column<imageColumns;column++)
318 ImageActor image = CreateImage( GetNextImagePath() );
320 image.SetParentOrigin( ParentOrigin::CENTER );
321 image.SetAnchorPoint( AnchorPoint::CENTER );
323 Vector3 position( margin * 0.5f + (imageSize.x + margin) * column - stageSize.width * 0.5f,
324 margin * 0.5f + (imageSize.y + margin) * row - stageSize.height * 0.5f,
326 image.SetPosition( position + imageSize * 0.5f );
327 image.SetSize( imageSize );
337 * Applies effect to scrollView
339 void ApplyEffectToScrollView()
344 Stage stage = Stage::GetCurrent();
345 Vector2 stageSize = stage.GetSize();
347 switch( mEffectMode )
351 mScrollViewEffect = ScrollViewDepthEffect::New();
352 mScrollView.SetScrollSnapDuration(EFFECT_SNAP_DURATION);
353 mScrollView.SetScrollFlickDuration(EFFECT_FLICK_DURATION);
354 mScrollView.SetScrollSnapAlphaFunction(AlphaFunctions::EaseOut);
355 mScrollView.SetScrollFlickAlphaFunction(AlphaFunctions::EaseOut);
356 mScrollView.RemoveConstraintsFromChildren();
362 mScrollViewEffect = ScrollViewCubeEffect::New();
363 mScrollView.SetScrollSnapDuration(EFFECT_SNAP_DURATION);
364 mScrollView.SetScrollFlickDuration(EFFECT_FLICK_DURATION);
365 mScrollView.SetScrollSnapAlphaFunction(AlphaFunctions::EaseOutBack);
366 mScrollView.SetScrollFlickAlphaFunction(AlphaFunctions::EaseOutBack);
367 mScrollView.RemoveConstraintsFromChildren();
371 case PageCarouselEffect:
373 mScrollViewEffect = ScrollViewPageCarouselEffect::New();
374 mScrollView.SetScrollSnapDuration(EFFECT_SNAP_DURATION);
375 mScrollView.SetScrollFlickDuration(EFFECT_FLICK_DURATION);
376 mScrollView.SetScrollSnapAlphaFunction(AlphaFunctions::EaseOut);
377 mScrollView.SetScrollFlickAlphaFunction(AlphaFunctions::EaseOut);
378 mScrollView.RemoveConstraintsFromChildren();
384 mScrollViewEffect = ScrollViewPageCubeEffect::New();
385 mScrollView.SetScrollSnapDuration(EFFECT_SNAP_DURATION);
386 mScrollView.SetScrollFlickDuration(EFFECT_FLICK_DURATION);
387 mScrollView.SetScrollSnapAlphaFunction(AlphaFunctions::EaseOut);
388 mScrollView.SetScrollFlickAlphaFunction(AlphaFunctions::EaseOut);
389 mScrollView.RemoveConstraintsFromChildren();
393 case PageSpiralEffect:
395 mScrollViewEffect = ScrollViewPageSpiralEffect::New();
396 mScrollView.SetScrollSnapDuration(EFFECT_SNAP_DURATION);
397 mScrollView.SetScrollFlickDuration(EFFECT_FLICK_DURATION);
398 mScrollView.SetScrollSnapAlphaFunction(AlphaFunctions::EaseOut);
399 mScrollView.SetScrollFlickAlphaFunction(AlphaFunctions::EaseOut);
400 mScrollView.RemoveConstraintsFromChildren();
410 if( mScrollViewEffect )
412 mScrollView.ApplyEffect(mScrollViewEffect);
415 mScrollView.SetWrapMode(wrap);
417 RulerPtr rulerX = CreateRuler(snap ? stageSize.width : 0.0f);
418 RulerPtr rulerY = new DefaultRuler;
419 rulerX->SetDomain(RulerDomain(0.0f, stageSize.x * PAGE_COLUMNS, !wrap));
422 mScrollView.SetRulerX( rulerX );
423 mScrollView.SetRulerY( rulerY );
427 * Creates a Ruler that snaps to a specified grid size.
428 * If that grid size is 0.0 then this ruler does not
431 * @param[in] gridSize (optional) The grid size for the ruler,
432 * (Default = 0.0 i.e. no snapping)
433 * @return The ruler is returned.
435 RulerPtr CreateRuler(float gridSize = 0.0f)
437 if(gridSize <= Math::MACHINE_EPSILON_0)
439 return new DefaultRuler();
441 return new FixedRuler(gridSize);
446 * Applies effect to the pages within scroll view.
448 * @param[in] page The page Actor to apply effect to.
450 void ApplyEffectToPage(Actor page)
452 page.RemoveConstraints();
453 page.ApplyConstraint( Constraint::New<Vector3>( Actor::SIZE, ParentSource( Actor::SIZE ), EqualToConstraint() ) );
455 switch( mEffectMode )
457 case PageCarouselEffect:
459 ScrollViewPageCarouselEffect effect = ScrollViewPageCarouselEffect::DownCast( mScrollViewEffect );
460 effect.ApplyToPage( page );
466 ScrollViewPageCubeEffect effect = ScrollViewPageCubeEffect::DownCast( mScrollViewEffect );
467 effect.ApplyToPage( page, ANGLE_SWING_3DEFFECT );
471 case PageSpiralEffect:
473 ScrollViewPageSpiralEffect effect = ScrollViewPageSpiralEffect::DownCast( mScrollViewEffect );
474 effect.ApplyToPage( page, ANGLE_SWING_3DEFFECT );
487 * Applies effect to child which resides in page (which in turn resides in scrollview)
489 * @note Page is typically the Parent of child, although in
490 * some scenarios Page is simply a container which has a child as
493 * @param[in] child The child actor to apply effect to
494 * @param[in] page The page which this child is inside
496 void ApplyEffectToActor( Actor child, Actor page )
498 switch( mEffectMode )
502 ApplyDepthEffectToActor( child );
508 ApplyCubeEffectToActor( child );
520 * Applies depth effect to the child which resides in page (which in turn resides in scrollview)
522 * @param[in] child The child actor to apply depth effect to
524 void ApplyDepthEffectToActor( Actor child )
526 ScrollViewDepthEffect depthEffect = ScrollViewDepthEffect::DownCast(mScrollViewEffect);
527 depthEffect.ApplyToActor( child,
528 POSITION_EXTENT_DEPTH_EFFECT,
529 OFFSET_EXTENT_DEPTH_EFFECT,
530 POSITION_SCALE_DEPTH_EFFECT,
531 SCALE_EXTENT_DEPTH_EFFECT );
534 void ApplyCubeEffectToActor( Actor child )
539 anchor = ANCHOR_3DEFFECT_STYLE0;
543 anchor = ANCHOR_3DEFFECT_STYLE1;
546 ScrollViewCubeEffect cubeEffect = ScrollViewCubeEffect::DownCast(mScrollViewEffect);
547 cubeEffect.ApplyToActor( child,
549 ANGLE_SWING_3DEFFECT,
550 POSITION_SWING_3DEFFECT * Vector2(Stage::GetCurrent().GetSize()));
554 * Creates an Image (Helper)
556 * @param[in] filename the path of the image.
557 * @param[in] width the width of the image in texels
558 * @param[in] height the height of the image in texels.
560 ImageActor CreateImage( const std::string& filename, unsigned int width = IMAGE_THUMBNAIL_WIDTH, unsigned int height = IMAGE_THUMBNAIL_HEIGHT )
562 ImageAttributes attributes;
564 attributes.SetSize(width, height);
565 attributes.SetScalingMode(ImageAttributes::ShrinkToFit);
566 Image img = Image::New(filename, attributes);
567 ImageActor actor = ImageActor::New(img);
568 actor.SetName( filename );
569 actor.SetParentOrigin(ParentOrigin::CENTER);
570 actor.SetAnchorPoint(AnchorPoint::CENTER);
572 actor.TouchedSignal().Connect( this, &ExampleController::OnTouchImage );
577 * When scroll starts (i.e. user starts to drag scrollview),
578 * note this state (mScrolling = true)
579 * @param[in] position Current Scroll Position
581 void OnScrollStarted( const Vector3& position )
587 * When scroll starts (i.e. user stops dragging scrollview, and scrollview has snapped to destination),
588 * note this state (mScrolling = false)
589 * @param[in] position Current Scroll Position
591 void OnScrollCompleted( const Vector3& position )
597 * Upon Touching an image (Release), make it spin
598 * (provided we're not scrolling).
599 * @param[in] actor The actor touched
600 * @param[in] event The TouchEvent.
602 bool OnTouchImage( Actor actor, const TouchEvent& event )
604 if( (event.points.size() > 0) && (!mScrolling) )
606 TouchPoint point = event.points[0];
607 if(point.state == TouchPoint::Up)
609 // Spin the Image a few times.
610 Animation animation = Animation::New(SPIN_DURATION);
611 animation.RotateBy( actor, Degree(360.0f * SPIN_DURATION), Vector3::XAXIS, AlphaFunctions::EaseOut);
619 * Signal handler, called when the 'Effect' button has been touched.
621 * @param[in] button The button that was pressed.
623 bool OnEffectTouched(Button button)
625 mEffectMode = static_cast<EffectMode>((static_cast<int>(mEffectMode) + 1) % static_cast<int>(Total));
631 * Sets/Updates the title of the View
632 * @param[in] title The new title for the view.
634 void SetTitle(const std::string& title)
639 * Main key event handler
641 void OnKeyEvent(const KeyEvent& event)
643 if(event.state == KeyEvent::Down)
645 if( IsKey( event, Dali::DALI_KEY_ESCAPE) || IsKey( event, Dali::DALI_KEY_BACK) )
654 Application& mApplication; ///< Application instance
655 Toolkit::View mView; ///< The View instance.
656 Toolkit::ToolBar mToolBar; ///< The View's Toolbar.
657 Layer mContentLayer; ///< The content layer (contains game actors)
658 ScrollView mScrollView; ///< ScrollView UI Component
659 bool mScrolling; ///< ScrollView scrolling state (true = scrolling, false = stationary)
660 ScrollViewEffect mScrollViewEffect; ///< ScrollView Effect instance.
661 ActorContainer mPages; ///< Keeps track of all the pages for applying effects.
664 * Enumeration of different effects this scrollview can operate under.
668 DepthEffect, ///< Depth Effect
669 CubeEffect, ///< Cube effect
670 PageCarouselEffect, ///< Page carousel effect
671 PageCubeEffect, ///< Page cube effect
672 PageSpiralEffect, ///< Page spiral effect
677 EffectMode mEffectMode; ///< Current Effect mode
679 Image mEffectIcon[Total]; ///< Icons for the effect button
680 Toolkit::PushButton mEffectChangeButton; ///< Effect Change Button
683 int main(int argc, char **argv)
685 Application app = Application::New(&argc, &argv);
686 ExampleController test(app);