2 * Copyright (c) 2019 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 <dali-toolkit/dali-toolkit.h>
21 #include <dali/devel-api/events/rotation-gesture.h>
22 #include <dali/devel-api/events/rotation-gesture-detector.h>
25 using namespace Dali::Toolkit;
29 const Property::Value BACKGROUND
31 { Toolkit::Visual::Property::TYPE, Visual::GRADIENT },
32 { GradientVisual::Property::STOP_COLOR, Property::Array{ Vector4( 167.0f, 207.0f, 223.0f, 255.0f ) / 255.0f,
33 Vector4( 0.0f, 64.0f, 137.0f, 255.0f ) / 255.0f } },
34 { GradientVisual::Property::START_POSITION, Vector2( 0.0f, -0.5f ) },
35 { GradientVisual::Property::END_POSITION, Vector2( 0.0f, 0.5f ) }
38 const Property::Value CONTROL_BACKGROUND
40 { Toolkit::Visual::Property::TYPE, Visual::GRADIENT },
41 { GradientVisual::Property::STOP_COLOR, Property::Array{ Vector4( 234.0f, 185.0f, 45.0f, 255.0f ) / 255.0f,
42 Vector4( 199.0f, 152.0f, 16.0f, 255.0f ) / 255.0f } },
43 { GradientVisual::Property::CENTER, Vector2::ZERO },
44 { GradientVisual::Property::RADIUS, 0.5f }
47 const float HELP_ANIMATION_DURATION( 25.0f );
48 const float HELP_ANIMATION_SEGMENT_TIME( 5.0f );
49 const float HELP_ANIMATION_TRANSITION_DURATION( 0.75f );
50 const Vector2 HELP_TEXT_POSITION_MULTIPLIER( 0.25f, 0.13f );
52 const float SHAKY_ANIMATION_DURATION( 0.1f );
53 const float SHAKY_ANIMATION_SEGMENT_TIME( 0.05f );
54 const float SHAKY_ANIMATION_ANGLE( 1.0f );
56 const float TOUCH_MODE_ANIMATION_DURATION( 0.1f );
57 const Vector4 TOUCH_MODE_COLOR( 1.0f, 0.7f, 0.7f, 1.0f );
59 const float PAN_MODE_CHANGE_ANIMATION_DURATION( 0.25f );
60 const Vector3 PAN_MODE_START_ANIMATION_SCALE( 1.2f, 1.2f, 1.0f );
61 const Vector3 PAN_MODE_END_ANIMATION_SCALE( 0.8f, 0.8f, 1.0f );
63 const float TAP_ANIMATION_DURATION( 0.5f );
64 const Vector4 TAP_ANIMATION_COLOR( 0.8f, 0.5, 0.2f, 0.6f );
66 const Vector3 MINIMUM_SCALE( Vector3::ONE );
67 const Vector3 MAXIMUM_SCALE( Vector3::ONE * 2.0f );
68 const float SCALE_BACK_ANIMATION_DURATION( 0.25f );
69 const float ROTATE_BACK_ANIMATION_DURATION( 0.25f );
72 * @brief Shows the given string between the given start and end times.
74 * Appropriately animates the string into and out of the scene.
76 * @param[in] string The label to display, this is an rvalue reference & will be moved
77 * @param[in] parent The parent to add the label to
78 * @param[in] animation The animation to add the animators created in this function
79 * @param[in] startTime When to start the animators
80 * @param[in] endTime When to end the animators
82 void AddHelpInfo( const std::string&& string, Actor parent, Animation animation, float startTime, float endTime )
84 Actor text = TextLabel::New( std::move( string ) );
85 Vector3 position( Stage::GetCurrent().GetSize() * HELP_TEXT_POSITION_MULTIPLIER );
87 text.SetAnchorPoint( AnchorPoint::TOP_CENTER );
88 text.SetParentOrigin( ParentOrigin::TOP_CENTER );
89 text.SetPosition( position );
90 text.SetOpacity( 0.0f );
91 text.SetProperty( TextLabel::Property::HORIZONTAL_ALIGNMENT, Text::HorizontalAlignment::CENTER );
92 text.SetProperty( TextLabel::Property::MULTI_LINE, true );
96 TimePeriod timePeriod( startTime, HELP_ANIMATION_TRANSITION_DURATION );
97 animation.AnimateTo( Property( text, Actor::Property::COLOR_ALPHA ), 1.0f, timePeriod );
98 animation.AnimateBy( Property( text, Actor::Property::POSITION_X ), -position.x, timePeriod );
101 timePeriod.delaySeconds = endTime;
102 animation.AnimateTo( Property( text, Actor::Property::COLOR_ALPHA ), 0.0f, timePeriod );
103 animation.AnimateBy( Property( text, Actor::Property::POSITION_X ), -position.x, timePeriod );
106 } // unnamed namespace
109 * @brief This example shows how to use the different gesture detectors available.
111 * - Tapping on the control shows a small rotation animation.
112 * - A Long press on the control puts it into Pan Mode.
113 * - When in Pan mode, the control can be panned (moved).
114 * - When the pan ends, we exit the Pan mode via an animation.
115 * - Pinching the control changes the scale of the control.
117 class GestureExample : public ConnectionTracker
122 * @brief Constructor.
124 * @param[in] application Reference to the application
126 GestureExample( Application &application )
127 : mApplication( application )
129 // Connect to the Application's Init signal
130 application.InitSignal().Connect( this, &GestureExample::Create );
136 * @brief Creates the scene as described in this class' description.
138 * @param[in] application Reference to the application class
140 void Create( Application& application )
142 // Get a handle to the stage & connect to the key event signal
143 Stage stage = Stage::GetCurrent();
144 stage.KeyEventSignal().Connect(this, &GestureExample::OnKeyEvent);
146 // Create a background with a linear gradient which matches parent size & is placed in the center.
147 Actor background = Control::New();
148 background.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS );
149 background.SetParentOrigin( ParentOrigin::CENTER );
150 background.SetProperty( Control::Property::BACKGROUND, BACKGROUND );
151 stage.Add( background );
153 // Create a control with a circular gradient that we'll use for the gestures and be a quarter of the size of the stage.
154 Actor touchControl = Control::New();
155 touchControl.SetSize( stage.GetSize() * 0.25f );
156 touchControl.SetParentOrigin( ParentOrigin::CENTER );
157 touchControl.SetProperty( Control::Property::BACKGROUND, CONTROL_BACKGROUND );
158 background.Add( touchControl );
160 // Connect to the touch signal
161 touchControl.TouchSignal().Connect( this, &GestureExample::OnTouch );
162 touchControl.SetLeaveRequired( true );
164 // Create a long press gesture detector, attach the actor & connect
165 mLongPressDetector = LongPressGestureDetector::New();
166 mLongPressDetector.Attach( touchControl );
167 mLongPressDetector.DetectedSignal().Connect( this, &GestureExample::OnLongPress );
169 // Create a pan gesture detector, attach the actor & connect
170 mPanDetector = PanGestureDetector::New();
171 mPanDetector.Attach( touchControl );
172 mPanDetector.DetectedSignal().Connect( this, &GestureExample::OnPan );
174 // Create a tap gesture detector, attach the actor & connect
175 mTapDetector = TapGestureDetector::New();
176 mTapDetector.Attach( touchControl );
177 mTapDetector.DetectedSignal().Connect( this, &GestureExample::OnTap );
179 // Create a pinch gesture detector, attach the actor & connect
180 mPinchDetector = PinchGestureDetector::New();
181 mPinchDetector.Attach( touchControl );
182 mPinchDetector.DetectedSignal().Connect( this, &GestureExample::OnPinch );
184 // Create a rotation gesture detector, attach the actor & connect
185 mRotationDetector = RotationGestureDetector::New();
186 mRotationDetector.Attach( touchControl );
187 mRotationDetector.DetectedSignal().Connect( this, &GestureExample::OnRotation );
189 // Create an animation which shakes the actor when in Pan mode
190 mShakeAnimation = Animation::New( SHAKY_ANIMATION_DURATION );
191 mShakeAnimation.AnimateBy( Property( touchControl, Actor::Property::ORIENTATION ),
192 Quaternion( Degree( SHAKY_ANIMATION_ANGLE ), Vector3::ZAXIS ),
193 AlphaFunction::BOUNCE,
194 TimePeriod( 0.0f, SHAKY_ANIMATION_SEGMENT_TIME ) );
195 mShakeAnimation.AnimateBy( Property( touchControl, Actor::Property::ORIENTATION ),
196 Quaternion( Degree( -SHAKY_ANIMATION_ANGLE ), Vector3::ZAXIS ),
197 AlphaFunction::BOUNCE,
198 TimePeriod( SHAKY_ANIMATION_SEGMENT_TIME, SHAKY_ANIMATION_SEGMENT_TIME ) );
200 // Animate help information
201 // Here we just animate some text on the screen to show tips on how to use this example
202 // The help animation loops
203 Animation helpAnimation = Animation::New( HELP_ANIMATION_DURATION );
205 float startTime( 0.0f );
206 float endTime( startTime + HELP_ANIMATION_SEGMENT_TIME );
208 AddHelpInfo( "Tap image for animation", background, helpAnimation, startTime, endTime );
209 AddHelpInfo( "Press & Hold image to drag", background, helpAnimation, startTime += HELP_ANIMATION_SEGMENT_TIME, endTime += HELP_ANIMATION_SEGMENT_TIME );
210 AddHelpInfo( "Pinch image to resize", background, helpAnimation, startTime += HELP_ANIMATION_SEGMENT_TIME, endTime += HELP_ANIMATION_SEGMENT_TIME );
211 AddHelpInfo( "Move fingers in a circular motion on image to rotate", background, helpAnimation, startTime += HELP_ANIMATION_SEGMENT_TIME, endTime += HELP_ANIMATION_SEGMENT_TIME );
212 helpAnimation.SetLooping( true );
213 helpAnimation.Play();
217 * @brief Called when our actor is touched.
219 * @param[in] actor The touched actor
220 * @param[in] touch The touch event
222 bool OnTouch( Actor actor, const TouchData& touch )
224 switch( touch.GetState( 0 ) )
226 case PointState::DOWN:
228 // When we get a touch point, change the color of the actor.
230 Animation anim = Animation::New( TOUCH_MODE_ANIMATION_DURATION );
231 anim.AnimateTo( Property( actor, Actor::Property::COLOR ), TOUCH_MODE_COLOR );
236 case PointState::LEAVE:
238 case PointState::INTERRUPTED:
242 // If we're not panning, change the color back to normal.
244 Animation anim = Animation::New( TOUCH_MODE_ANIMATION_DURATION );
245 anim.AnimateTo( Property( actor, Actor::Property::COLOR ), Vector4::ONE );
248 // Stop the shake animation from looping.
249 mShakeAnimation.SetLooping( false );
263 * @brief Called when a long-press gesture is detected on our control.
265 * @param[in] actor The actor that's been long-pressed
266 * @param[in] longPress The long-press gesture information
268 void OnLongPress( Actor actor, const LongPressGesture& longPress )
270 switch( longPress.state )
272 case Gesture::Started:
274 // When we first receive a long press, change state to pan mode.
276 // Do a small animation to indicate to the user that we are in pan mode.
277 Animation anim = Animation::New( PAN_MODE_CHANGE_ANIMATION_DURATION );
278 anim.AnimateTo( Property( actor, Actor::Property::SCALE ), actor.GetCurrentScale() * PAN_MODE_START_ANIMATION_SCALE, AlphaFunction::BOUNCE );
282 // Start the shake animation so the user knows when they are in pan mode.
283 mShakeAnimation.SetLooping( true );
284 mShakeAnimation.Play();
288 case Gesture::Finished:
289 case Gesture::Cancelled:
291 // We get this state when all touches are released after a long press. We end pan mode...
304 * @brief Called when a pan gesture is detected on our control.
306 * @param[in] actor The actor that's been panned
307 * @param[in] pan The pan gesture information
309 void OnPan( Actor actor, const PanGesture& pan )
311 if( mPanMode || mPanStarted )
313 // When we are in Pan mode, just move the actor by the displacement.
315 // As the displacement is in local actor coords, we will have to multiply the displacement by the
316 // actor's scale so that it moves the correct amount in the parent's coordinate system.
317 Vector3 scaledDisplacement( pan.displacement );
318 scaledDisplacement *= actor.GetCurrentScale();
320 Vector3 currentPosition;
321 actor.GetProperty( Actor::Property::POSITION ).Get( currentPosition );
323 Vector3 newPosition = currentPosition + scaledDisplacement;
324 actor.SetPosition( newPosition );
328 case Gesture::Started:
334 case Gesture::Finished:
335 case Gesture::Cancelled:
337 // If we cancel or finish the pan, do an animation to indicate this and stop the shake animation.
339 Animation anim = Animation::New( PAN_MODE_CHANGE_ANIMATION_DURATION );
340 anim.AnimateTo( Property( actor, Actor::Property::COLOR ), Vector4::ONE );
341 anim.AnimateTo( Property( actor, Actor::Property::SCALE ), actor.GetCurrentScale() * PAN_MODE_END_ANIMATION_SCALE, AlphaFunction::BOUNCE );
343 // Move actor back to center if we're out of bounds
344 Vector2 halfStageSize = Stage::GetCurrent().GetSize() * 0.5f;
345 if( ( std::abs( newPosition.x ) > halfStageSize.width ) ||
346 ( std::abs( newPosition.y ) > halfStageSize.height ) )
348 anim.AnimateTo( Property( actor, Actor::Property::POSITION ), Vector3::ZERO, AlphaFunction::EASE_IN );
352 mShakeAnimation.SetLooping( false );
366 * @brief Called when a tap gesture is detected on our control.
368 * @param[in] actor The actor that's been tapped
369 * @param[in] tap The tap gesture information
371 void OnTap( Actor actor, const TapGesture& tap )
373 // Do a short animation to show a tap has happened.
375 Animation anim = Animation::New( TAP_ANIMATION_DURATION );
376 anim.AnimateBy( Property( actor, Actor::Property::ORIENTATION ), Quaternion( ANGLE_360, Vector3::ZAXIS ) );
377 anim.AnimateTo( Property( actor, Actor::Property::SCALE ), Vector3::ONE, AlphaFunction::LINEAR );
378 anim.AnimateTo( Property( actor, Actor::Property::COLOR ), TAP_ANIMATION_COLOR, AlphaFunction::BOUNCE );
379 anim.AnimateTo( Property( actor, Actor::Property::POSITION ), Vector3::ZERO, AlphaFunction::EASE_OUT_SQUARE );
384 * @brief Called when a pinch gesture is detected on our control.
386 * @param[in] actor The actor that's been pinched
387 * @param[in] pinch The pinch gesture information
389 void OnPinch( Actor actor, const PinchGesture& pinch )
391 switch( pinch.state )
393 case Gesture::Started:
395 // Starting scale is required so that we know what to multiply the pinch.scale by.
396 mStartingScale = actor.GetCurrentScale();
400 case Gesture::Finished:
401 case Gesture::Cancelled:
403 Vector3 scale( actor.GetCurrentScale() );
405 // Ensure the actor sizes itself to be within the limits defined.
406 if ( scale.x < MINIMUM_SCALE.x )
408 scale = MINIMUM_SCALE;
410 else if ( scale.x > MAXIMUM_SCALE.x )
412 scale = MAXIMUM_SCALE;
415 // Do an animation to come back to go back to the limits.
416 Animation anim = Animation::New( SCALE_BACK_ANIMATION_DURATION );
417 anim.AnimateTo( Property( actor, Actor::Property::SCALE ), scale, AlphaFunction::LINEAR );
428 actor.SetScale( mStartingScale * pinch.scale );
432 * @brief Called when a rotation gesture is detected on our control.
434 * @param[in] actor The actor that's been pinched
435 * @param[in] rotation The rotation gesture information
437 void OnRotation( Actor actor, const RotationGesture& rotation )
439 switch( rotation.state )
441 case Gesture::Started:
443 // Starting orientation is required so that we know what to multiply the rotation.rotation by.
444 mStartingOrientation = actor.GetCurrentOrientation();
448 case Gesture::Finished:
449 case Gesture::Cancelled:
451 // Do an animation to come back to go back to the original orientation.
452 Animation anim = Animation::New( ROTATE_BACK_ANIMATION_DURATION );
453 anim.AnimateTo( Property( actor, Actor::Property::ORIENTATION ), Quaternion::IDENTITY, AlphaFunction::LINEAR );
464 actor.SetOrientation( mStartingOrientation * Quaternion( rotation.rotation, Vector3::ZAXIS ) );
468 * @brief Called when any key event is received.
470 * Will use this to quit the application if Back or the Escape key is received.
471 * @param[in] event The key event information
473 void OnKeyEvent( const KeyEvent& event )
475 if( event.state == KeyEvent::Down )
477 if( IsKey( event, Dali::DALI_KEY_ESCAPE ) || IsKey( event, Dali::DALI_KEY_BACK ) )
485 Application& mApplication;
487 PanGestureDetector mPanDetector;
488 LongPressGestureDetector mLongPressDetector;
489 TapGestureDetector mTapDetector;
490 PinchGestureDetector mPinchDetector;
491 RotationGestureDetector mRotationDetector;
493 Vector3 mStartingScale; ///< Set to the scale of the control when pinch starts.
494 Quaternion mStartingOrientation; ///< Set to the orientation of the control when the rotation starts.
495 Animation mShakeAnimation; ///< "Shake" animation to show when we are in panning mode.
496 bool mPanMode = false; ///< Set to true when we have long-pressed to put us into panning mode.
497 bool mPanStarted = false; ///< Set to true to state that panning has started.
500 int DALI_EXPORT_API main( int argc, char **argv )
502 Application application = Application::New( &argc, &argv );
503 GestureExample controller( application );
504 application.MainLoop();