2 * Copyright (c) 2015 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_CAROUSEL_IMAGE( DALI_IMAGE_DIR "icon-scroll-view-carousel.png" );
36 const Vector3 ICON_SIZE(100.0f, 100.0f, 0.0f);
38 const char* EFFECT_MODE_NAME[] = {
45 const char * const IMAGE_PATHS[] = {
46 DALI_IMAGE_DIR "gallery-medium-1.jpg",
47 DALI_IMAGE_DIR "gallery-medium-2.jpg",
48 DALI_IMAGE_DIR "gallery-medium-3.jpg",
49 DALI_IMAGE_DIR "gallery-medium-4.jpg",
50 DALI_IMAGE_DIR "gallery-medium-5.jpg",
51 DALI_IMAGE_DIR "gallery-medium-6.jpg",
52 DALI_IMAGE_DIR "gallery-medium-7.jpg",
53 DALI_IMAGE_DIR "gallery-medium-8.jpg",
54 DALI_IMAGE_DIR "gallery-medium-9.jpg",
55 DALI_IMAGE_DIR "gallery-medium-10.jpg",
56 DALI_IMAGE_DIR "gallery-medium-11.jpg",
57 DALI_IMAGE_DIR "gallery-medium-12.jpg",
58 DALI_IMAGE_DIR "gallery-medium-13.jpg",
59 DALI_IMAGE_DIR "gallery-medium-14.jpg",
60 DALI_IMAGE_DIR "gallery-medium-15.jpg",
61 DALI_IMAGE_DIR "gallery-medium-16.jpg",
62 DALI_IMAGE_DIR "gallery-medium-17.jpg",
63 DALI_IMAGE_DIR "gallery-medium-18.jpg",
64 DALI_IMAGE_DIR "gallery-medium-19.jpg",
65 DALI_IMAGE_DIR "gallery-medium-20.jpg",
66 DALI_IMAGE_DIR "gallery-medium-21.jpg",
67 DALI_IMAGE_DIR "gallery-medium-22.jpg",
68 DALI_IMAGE_DIR "gallery-medium-23.jpg",
69 DALI_IMAGE_DIR "gallery-medium-24.jpg",
70 DALI_IMAGE_DIR "gallery-medium-25.jpg",
71 DALI_IMAGE_DIR "gallery-medium-26.jpg",
72 DALI_IMAGE_DIR "gallery-medium-27.jpg",
73 DALI_IMAGE_DIR "gallery-medium-28.jpg",
74 DALI_IMAGE_DIR "gallery-medium-29.jpg",
75 DALI_IMAGE_DIR "gallery-medium-30.jpg",
76 DALI_IMAGE_DIR "gallery-medium-31.jpg",
77 DALI_IMAGE_DIR "gallery-medium-32.jpg",
78 DALI_IMAGE_DIR "gallery-medium-33.jpg",
79 DALI_IMAGE_DIR "gallery-medium-34.jpg",
80 DALI_IMAGE_DIR "gallery-medium-35.jpg",
81 DALI_IMAGE_DIR "gallery-medium-36.jpg",
82 DALI_IMAGE_DIR "gallery-medium-37.jpg",
83 DALI_IMAGE_DIR "gallery-medium-38.jpg",
84 DALI_IMAGE_DIR "gallery-medium-39.jpg",
85 DALI_IMAGE_DIR "gallery-medium-40.jpg",
86 DALI_IMAGE_DIR "gallery-medium-41.jpg",
87 DALI_IMAGE_DIR "gallery-medium-42.jpg",
88 DALI_IMAGE_DIR "gallery-medium-43.jpg",
89 DALI_IMAGE_DIR "gallery-medium-44.jpg",
90 DALI_IMAGE_DIR "gallery-medium-45.jpg",
91 DALI_IMAGE_DIR "gallery-medium-46.jpg",
92 DALI_IMAGE_DIR "gallery-medium-47.jpg",
93 DALI_IMAGE_DIR "gallery-medium-48.jpg",
94 DALI_IMAGE_DIR "gallery-medium-49.jpg",
95 DALI_IMAGE_DIR "gallery-medium-50.jpg",
96 DALI_IMAGE_DIR "gallery-medium-51.jpg",
97 DALI_IMAGE_DIR "gallery-medium-52.jpg",
98 DALI_IMAGE_DIR "gallery-medium-53.jpg",
103 const char * const GetNextImagePath()
105 static const char * const * imagePtr = &IMAGE_PATHS[0];
107 if ( *(++imagePtr) == NULL )
109 imagePtr = &IMAGE_PATHS[0];
115 const int PAGE_COLUMNS = 10; ///< Number of Pages going across (columns)
116 const int PAGE_ROWS = 1; ///< Number of Pages going down (rows)
117 const int IMAGE_ROWS = 5; ///< Number of Images going down (rows) with a Page
119 const unsigned int IMAGE_THUMBNAIL_WIDTH = 256; ///< Width of Thumbnail Image in texels
120 const unsigned int IMAGE_THUMBNAIL_HEIGHT = 256; ///< Height of Thumbnail Image in texels
122 const float SPIN_DURATION = 1.0f; ///< Times to spin an Image by upon touching, each spin taking a second.
124 const float EFFECT_SNAP_DURATION(0.66f); ///< Scroll Snap Duration for Effects
125 const float EFFECT_FLICK_DURATION(0.5f); ///< Scroll Flick Duration for Effects
127 } // unnamed namespace
130 * This example shows how to do custom Scroll Effects
132 class ExampleController : public ConnectionTracker
138 * @param application class, stored as reference
140 ExampleController( Application& application )
141 : mApplication( application ),
144 mEffectMode(PageCarouselEffect)
146 // Connect to the Application's Init and orientation changed signal
147 mApplication.InitSignal().Connect(this, &ExampleController::OnInit);
152 // Nothing to do here; everything gets deleted automatically
156 * This method gets called once the main loop of application is up and running
158 void OnInit(Application& app)
160 Stage stage = Dali::Stage::GetCurrent();
161 stage.KeyEventSignal().Connect(this, &ExampleController::OnKeyEvent);
163 // Hide the indicator bar
164 mApplication.GetWindow().ShowIndicator(Dali::Window::INVISIBLE);
166 // Creates a default view with a default tool bar.
167 // The view is added to the stage.
168 mContentLayer = DemoHelper::CreateView( app,
175 mEffectIcon[ PageCarouselEffect ] = ResourceImage::New( EFFECT_CAROUSEL_IMAGE );
176 mEffectIcon[ PageCubeEffect ] = ResourceImage::New( EFFECT_CAROUSEL_IMAGE );
177 mEffectIcon[ PageSpiralEffect ] = ResourceImage::New( EFFECT_CAROUSEL_IMAGE );
178 mEffectIcon[ PageWaveEffect ] = ResourceImage::New( EFFECT_CAROUSEL_IMAGE );
180 // Create a effect change button. (right of toolbar)
181 mEffectChangeButton = Toolkit::PushButton::New();
182 mEffectChangeButton.ClickedSignal().Connect( this, &ExampleController::OnEffectTouched );
183 mToolBar.AddControl( mEffectChangeButton, DemoHelper::DEFAULT_VIEW_STYLE.mToolBarButtonPercentage, Toolkit::Alignment::HorizontalRight, DemoHelper::DEFAULT_MODE_SWITCH_PADDING );
185 // Create the content layer.
188 // Hack to force screen refresh.
189 Animation animation = Animation::New(1.0f);
190 animation.AnimateTo(Property(mContentLayer, Actor::Property::POSITION), Vector3::ZERO );
197 * Adds content to the ContentLayer. This is everything we see
198 * excluding the toolbar at the top.
200 void AddContentLayer()
202 Stage stage = Stage::GetCurrent();
203 Vector2 stageSize = stage.GetSize();
205 mScrollView = ScrollView::New();
206 mScrollView.SetAnchorPoint(AnchorPoint::CENTER);
207 mScrollView.SetParentOrigin(ParentOrigin::CENTER);
208 mContentLayer.Add( mScrollView );
209 mScrollView.SetSize( stageSize );
210 mScrollView.SetAxisAutoLock( true );
211 mScrollView.SetAxisAutoLockGradient( 1.0f );
213 mScrollView.ScrollStartedSignal().Connect( this, &ExampleController::OnScrollStarted );
214 mScrollView.ScrollCompletedSignal().Connect( this, &ExampleController::OnScrollCompleted );
216 for(int row = 0;row<PAGE_ROWS;row++)
218 for(int column = 0;column<PAGE_COLUMNS;column++)
220 Actor page = CreatePage();
222 page.SetPosition( column * stageSize.x, row * stageSize.y );
223 mScrollView.Add( page );
225 mPages.push_back(page);
233 * Updates the ScrollView and it's children based
234 * on the current effect.
238 std::stringstream ss(APPLICATION_TITLE);
239 ss << APPLICATION_TITLE << ": " << EFFECT_MODE_NAME[mEffectMode];
242 mEffectChangeButton.SetBackgroundImage( mEffectIcon[ mEffectMode ] );
244 // remove old Effect if exists.
245 if(mScrollViewEffect)
247 mScrollView.RemoveEffect(mScrollViewEffect);
250 // apply new Effect to ScrollView
251 ApplyEffectToScrollView();
252 unsigned int pageCount(0);
253 for( std::vector< Actor >::iterator pageIter = mPages.begin(); pageIter != mPages.end(); ++pageIter)
255 Actor page = *pageIter;
256 ApplyEffectToPage( page, pageCount++ );
261 * Creates a page using a source of images.
265 Actor page = Actor::New();
266 page.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS );
267 page.SetParentOrigin( ParentOrigin::CENTER );
268 page.SetAnchorPoint( AnchorPoint::CENTER );
270 Stage stage = Stage::GetCurrent();
271 Vector2 stageSize = stage.GetSize();
273 const float margin = 10.0f;
275 // Calculate the number of images going across (columns) within a page, according to the screen resolution and dpi.
276 int imageColumns = round(IMAGE_ROWS * (stageSize.x / stage.GetDpi().x) / (stageSize.y / stage.GetDpi().y));
277 const Vector3 imageSize((stageSize.x / imageColumns) - margin, (stageSize.y / IMAGE_ROWS) - margin, 0.0f);
279 for(int row = 0;row<IMAGE_ROWS;row++)
281 for(int column = 0;column<imageColumns;column++)
283 ImageActor image = CreateImage( GetNextImagePath(), imageSize.x, imageSize.y );
285 image.SetParentOrigin( ParentOrigin::CENTER );
286 image.SetAnchorPoint( AnchorPoint::CENTER );
288 Vector3 position( margin * 0.5f + (imageSize.x + margin) * column - stageSize.width * 0.5f,
289 margin * 0.5f + (imageSize.y + margin) * row - stageSize.height * 0.5f,
291 image.SetPosition( position + imageSize * 0.5f );
292 image.SetSize( imageSize );
302 * Applies effect to scrollView
304 void ApplyEffectToScrollView()
309 Stage stage = Stage::GetCurrent();
310 Vector2 stageSize = stage.GetSize();
312 RulerPtr rulerX = CreateRuler(snap ? stageSize.width : 0.0f);
313 RulerPtr rulerY = new DefaultRuler;
314 rulerX->SetDomain(RulerDomain(0.0f, stageSize.x * PAGE_COLUMNS, !wrap));
317 Dali::Path path = Dali::Path::New();
318 Dali::Property::Array points;
320 Dali::Property::Array controlPoints;
321 controlPoints.Resize(4);
323 if( mEffectMode == PageCarouselEffect)
326 points[0] = Vector3( stageSize.x*0.75, 0.0f, -stageSize.x*0.75f);
327 points[1] = Vector3( 0.0f, 0.0f, 0.0f );
328 points[2] = Vector3( -stageSize.x*0.75f, 0.0f, -stageSize.x*0.75f);
329 path.SetProperty( Path::Property::POINTS, points );
331 controlPoints[0] = Vector3( stageSize.x*0.5f, 0.0f, 0.0f );
332 controlPoints[1] = Vector3( stageSize.x*0.5f, 0.0f, 0.0f );
333 controlPoints[2] = Vector3(-stageSize.x*0.5f, 0.0f, 0.0f );
334 controlPoints[3] = Vector3(-stageSize.x*0.5f, 0.0f, 0.0f );
335 path.SetProperty( Path::Property::CONTROL_POINTS, controlPoints );
337 forward = Vector3::ZERO;
339 else if( mEffectMode == PageCubeEffect)
341 points[0] = Vector3( stageSize.x*0.5, 0.0f, stageSize.x*0.5f);
342 points[1] = Vector3( 0.0f, 0.0f, 0.0f );
343 points[2] = Vector3( -stageSize.x*0.5f, 0.0f, stageSize.x*0.5f);
344 path.SetProperty( Path::Property::POINTS, points );
346 controlPoints[0] = Vector3( stageSize.x*0.5f, 0.0f, stageSize.x*0.3f );
347 controlPoints[1] = Vector3( stageSize.x*0.3f, 0.0f, 0.0f );
348 controlPoints[2] = Vector3(-stageSize.x*0.3f, 0.0f, 0.0f );
349 controlPoints[3] = Vector3(-stageSize.x*0.5f, 0.0f, stageSize.x*0.3f );
350 path.SetProperty( Path::Property::CONTROL_POINTS, controlPoints );
352 forward = Vector3(-1.0f,0.0f,0.0f);
354 else if( mEffectMode == PageSpiralEffect)
356 points[0] = Vector3( stageSize.x*0.5, 0.0f, -stageSize.x*0.5f);
357 points[1] = Vector3( 0.0f, 0.0f, 0.0f );
358 points[2] = Vector3( -stageSize.x*0.5f, 0.0f, -stageSize.x*0.5f);
359 path.SetProperty( Path::Property::POINTS, points );
361 controlPoints[0] = Vector3( stageSize.x*0.5f, 0.0f, 0.0f );
362 controlPoints[1] = Vector3( stageSize.x*0.5f, 0.0f, 0.0f );
363 controlPoints[2] = Vector3(-stageSize.x*0.5f, 0.0f, 0.0f );
364 controlPoints[3] = Vector3(-stageSize.x*0.5f, 0.0f, 0.0f );
365 path.SetProperty( Path::Property::CONTROL_POINTS, controlPoints );
367 forward = Vector3(-1.0f,0.0f,0.0f);
369 else if( mEffectMode == PageWaveEffect)
371 points[0] = Vector3( stageSize.x, 0.0f, -stageSize.x);
372 points[1] = Vector3( 0.0f, 0.0f, 0.0f );
373 points[2] = Vector3( -stageSize.x, 0.0f, -stageSize.x);
374 path.SetProperty( Path::Property::POINTS, points );
376 controlPoints[0] = Vector3( 0.0f, 0.0f, -stageSize.x );
377 controlPoints[1] = Vector3( stageSize.x*0.5f, 0.0f, 0.0f );
378 controlPoints[2] = Vector3( -stageSize.x*0.5f, 0.0f, 0.0f);
379 controlPoints[3] = Vector3(0.0f, 0.0f,-stageSize.x );
380 path.SetProperty( Path::Property::CONTROL_POINTS, controlPoints );
382 forward = Vector3(-1.0f,0.0f,0.0f);
385 mScrollViewEffect = ScrollViewPagePathEffect::New(path, forward,Toolkit::ScrollView::Property::SCROLL_FINAL_X, Vector3(stageSize.x,stageSize.y,0.0f),PAGE_COLUMNS);
386 mScrollView.SetScrollSnapDuration(EFFECT_SNAP_DURATION);
387 mScrollView.SetScrollFlickDuration(EFFECT_FLICK_DURATION);
388 mScrollView.SetScrollSnapAlphaFunction(AlphaFunction::EASE_OUT);
389 mScrollView.SetScrollFlickAlphaFunction(AlphaFunction::EASE_OUT);
390 mScrollView.RemoveConstraintsFromChildren();
392 rulerX = CreateRuler(snap ? stageSize.width * 0.5f : 0.0f);
395 rulerX->SetDomain(RulerDomain(0.0f, stageSize.x * 0.5f * PAGE_COLUMNS, !wrap));
399 rulerX->SetDomain(RulerDomain(0.0f, stageSize.x*0.5f* (PAGE_COLUMNS+1), !wrap));
402 unsigned int currentPage = mScrollView.GetCurrentPage();
403 if( mScrollViewEffect )
405 mScrollView.ApplyEffect(mScrollViewEffect);
408 mScrollView.SetWrapMode(wrap);
409 mScrollView.SetRulerX( rulerX );
410 mScrollView.SetRulerY( rulerY );
412 mScrollView.ScrollTo( currentPage, 0.0f );
416 * Creates a Ruler that snaps to a specified grid size.
417 * If that grid size is 0.0 then this ruler does not
420 * @param[in] gridSize (optional) The grid size for the ruler,
421 * (Default = 0.0 i.e. no snapping)
422 * @return The ruler is returned.
424 RulerPtr CreateRuler(float gridSize = 0.0f)
426 if(gridSize <= Math::MACHINE_EPSILON_0)
428 return new DefaultRuler();
430 return new FixedRuler(gridSize);
435 * Applies effect to the pages within scroll view.
437 * @param[in] page The page Actor to apply effect to.
439 void ApplyEffectToPage(Actor page, unsigned int pageOrder )
441 page.RemoveConstraints();
442 page.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS );
444 ScrollViewPagePathEffect effect = ScrollViewPagePathEffect::DownCast( mScrollViewEffect );
445 effect.ApplyToPage( page, pageOrder );
449 * Creates an Image (Helper)
451 * @param[in] filename the path of the image.
452 * @param[in] width the width of the image in texels
453 * @param[in] height the height of the image in texels.
455 ImageActor CreateImage( const std::string& filename, unsigned int width = IMAGE_THUMBNAIL_WIDTH, unsigned int height = IMAGE_THUMBNAIL_HEIGHT )
457 Image img = ResourceImage::New(filename, ImageDimensions( width, height ), Dali::FittingMode::SCALE_TO_FILL, Dali::SamplingMode::BOX_THEN_LINEAR );
459 ImageActor actor = ImageActor::New(img);
460 actor.SetName( filename );
461 actor.SetParentOrigin(ParentOrigin::CENTER);
462 actor.SetAnchorPoint(AnchorPoint::CENTER);
464 actor.TouchedSignal().Connect( this, &ExampleController::OnTouchImage );
469 * When scroll starts (i.e. user starts to drag scrollview),
470 * note this state (mScrolling = true)
471 * @param[in] position Current Scroll Position
473 void OnScrollStarted( const Vector2& position )
479 * When scroll starts (i.e. user stops dragging scrollview, and scrollview has snapped to destination),
480 * note this state (mScrolling = false)
481 * @param[in] position Current Scroll Position
483 void OnScrollCompleted( const Vector2& position )
489 * Upon Touching an image (Release), make it spin
490 * (provided we're not scrolling).
491 * @param[in] actor The actor touched
492 * @param[in] event The TouchEvent.
494 bool OnTouchImage( Actor actor, const TouchEvent& event )
496 if( (event.points.size() > 0) && (!mScrolling) )
498 TouchPoint point = event.points[0];
499 if(point.state == TouchPoint::Up)
501 // Spin the Image a few times.
502 Animation animation = Animation::New(SPIN_DURATION);
503 animation.AnimateBy( Property( actor, Actor::Property::ORIENTATION ), Quaternion( Radian( Degree(360.0f * SPIN_DURATION) ), Vector3::XAXIS ), AlphaFunction::EASE_OUT );
511 * Signal handler, called when the 'Effect' button has been touched.
513 * @param[in] button The button that was pressed.
515 bool OnEffectTouched(Button button)
517 mEffectMode = static_cast<EffectMode>((static_cast<int>(mEffectMode) + 1) % static_cast<int>(Total));
523 * Sets/Updates the title of the View
524 * @param[in] title The new title for the view.
526 void SetTitle(const std::string& title)
530 mTitleActor = DemoHelper::CreateToolBarLabel( "" );
531 // Add title to the tool bar.
532 mToolBar.AddControl( mTitleActor, DemoHelper::DEFAULT_VIEW_STYLE.mToolBarTitlePercentage, Alignment::HorizontalCenter );
535 mTitleActor.SetProperty( Toolkit::TextLabel::Property::TEXT, title );
539 * Main key event handler
541 void OnKeyEvent(const KeyEvent& event)
543 if(event.state == KeyEvent::Down)
545 if( IsKey( event, Dali::DALI_KEY_ESCAPE) || IsKey( event, Dali::DALI_KEY_BACK) )
554 Application& mApplication; ///< Application instance
555 Toolkit::Control mView; ///< The View instance.
556 Toolkit::ToolBar mToolBar; ///< The View's Toolbar.
557 TextLabel mTitleActor; ///< The Toolbar's Title.
558 Layer mContentLayer; ///< The content layer (contains game actors)
559 ScrollView mScrollView; ///< ScrollView UI Component
560 bool mScrolling; ///< ScrollView scrolling state (true = scrolling, false = stationary)
561 ScrollViewEffect mScrollViewEffect; ///< ScrollView Effect instance.
562 std::vector< Actor > mPages; ///< Keeps track of all the pages for applying effects.
565 * Enumeration of different effects this scrollview can operate under.
569 PageCarouselEffect, ///< Page carousel effect
570 PageCubeEffect, ///< Page cube effect
571 PageSpiralEffect, ///< Page spiral effect
572 PageWaveEffect, ///< Page wave effect
577 EffectMode mEffectMode; ///< Current Effect mode
579 Image mEffectIcon[Total]; ///< Icons for the effect button
580 Toolkit::PushButton mEffectChangeButton; ///< Effect Change Button
583 int main(int argc, char **argv)
585 Application app = Application::New(&argc, &argv, DALI_DEMO_THEME_PATH);
586 ExampleController test(app);