examples/clipping/clipping-example.cpp

   1 /*
   2  * Copyright (c) 2017 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  *
  16  */
  17
  18 // EXTERNAL INCLUDES
  19 #include <dali/dali.h>
  20 #include <dali-toolkit/dali-toolkit.h>
  21 #include <dali/devel-api/actors/actor-devel.h>
  22
  23 // INTERNAL INCLUDES
  24 #include "clipping-item-factory.h"
  25 #include "item-view-orientation-constraint.h"
  26
  27 using namespace Dali;
  28 using namespace Dali::Toolkit;
  29
  30 namespace
  31 {
  32 const char * const APPLICATION_TITLE( "Clipping Controls" );
  33 const Vector3 APPLICATION_TITLE_PARENT_ORIGIN( 0.5f, 0.03f, 0.5f ); // Set the parent origin to a small percentage below the top (so the demo will scale for different resolutions).
  34
  35 const Vector3 ITEM_VIEW_LAYOUT_SIZE_SCALE( 0.75f, 0.5f, 0.75f );
  36 const float ITEM_VIEW_BORDER_SIZE = 2.0f;
  37 const float ITEM_VIEW_MAXIMUM_ROTATION_IN_DEGREES = 20.0f;
  38 const float ITEM_VIEW_LAYOUT_POSITION_CHANGE_MULTIPLIER = 3.0f;
  39 const float ITEM_VIEW_ROTATION_ANIMATION_TIME = 0.2f;
  40
  41 const char * const BUTTON_LABEL( "Toggle Clipping Mode" );
  42 } // unnamed namespace
  43
  44 /**
  45  * @brief Demonstrates the control clipping of a UI Control.
  46  *
  47  * When an Actor is set to clip its children, the renderers have to be added manually in order to specify what its children
  48  * need to clip to. UI Controls automate the creation of the renderers/visuals when they are set to clip their children.
  49  *
  50  * This example displays an item-view whose clipping mode is toggled without the need for adding any renderers to it.
  51  *
  52  * Additionally, a constraint is used to modify the item-view's orientation.
  53  */
  54 class ClippingExample : public ConnectionTracker
  55 {
  56 public:
  57
  58   /**
  59    * @brief Constructor.
  60    * @param[in] application A reference to the Application class.
  61    */
  62   ClippingExample( Application& application )
  63   : mApplication( application )
  64   {
  65     // Connect to the Application's Init signal
  66     mApplication.InitSignal().Connect( this, &ClippingExample::Create );
  67   }
  68
  69 private:
  70
  71   /**
  72    * @brief Called to initialise the application content.
  73    * @param[in] application A reference to the Application class.
  74    */
  75   void Create( Application& application )
  76   {
  77     // Hide the indicator bar
  78     application.GetWindow().ShowIndicator( Dali::Window::INVISIBLE );
  79
  80     // Connect to the stage's key signal to allow Back and Escape to exit.
  81     Stage stage = Dali::Stage::GetCurrent();
  82     stage.KeyEventSignal().Connect( this, &ClippingExample::OnKeyEvent );
  83
  84     // Create a TextLabel for the application title.
  85     Toolkit::TextLabel label = Toolkit::TextLabel::New( APPLICATION_TITLE );
  86     label.SetAnchorPoint( AnchorPoint::TOP_CENTER );
  87     label.SetParentOrigin( APPLICATION_TITLE_PARENT_ORIGIN );
  88     label.SetProperty( Toolkit::TextLabel::Property::HORIZONTAL_ALIGNMENT, "CENTER" );
  89     label.SetProperty( Toolkit::TextLabel::Property::VERTICAL_ALIGNMENT, "CENTER" );
  90     label.SetProperty( Toolkit::TextLabel::Property::TEXT_COLOR, Color::WHITE );
  91     stage.Add( label );
  92
  93     // Create an item-view which clips its children.
  94     mItemView = ItemView::New( mClippingItemFactory );
  95     mItemView.SetParentOrigin( ParentOrigin::CENTER );
  96     mItemView.SetAnchorPoint( AnchorPoint::CENTER );
  97     mItemView.SetProperty( Actor::Property::CLIPPING_MODE, ClippingMode::CLIP_CHILDREN ); // Enable clipping. No need to create any renderers.
  98     stage.Add( mItemView );
  99
 100     // Create a Spiral Layout and add it to the Item View.
 101     mItemView.AddLayout( * DefaultItemLayout::New( DefaultItemLayout::SPIRAL ) );
 102     stage.GetRootLayer().SetBehavior( Layer::LAYER_3D ); // The item-view spiral layout requires Layer 3D behaviour.
 103
 104     // Calculate the size we would like our item-view layout to be, and then activate the layout.
 105     const Vector2 stageSize = stage.GetSize();
 106     const Vector3 itemViewLayoutSize( ITEM_VIEW_LAYOUT_SIZE_SCALE.x * stageSize.x, ITEM_VIEW_LAYOUT_SIZE_SCALE.y * stageSize.y, ITEM_VIEW_LAYOUT_SIZE_SCALE.z * stageSize.x );
 107     mItemView.ActivateLayout( 0, itemViewLayoutSize, 0.0f );
 108
 109     // Connect to the scroll started and completed signals to apply orientation constraints & animations.
 110     mItemView.ScrollStartedSignal().Connect( this, &ClippingExample::ScrollStarted );
 111     mItemView.ScrollCompletedSignal().Connect( this, &ClippingExample::ScrollCompleted );
 112
 113     // Create a constraint for the item-view which we apply when we start scrolling and remove when we stop.
 114     mItemViewOrientationConstraint = Constraint::New< Quaternion >( mItemView, Actor::Property::ORIENTATION, ItemViewOrientationConstraint( ITEM_VIEW_MAXIMUM_ROTATION_IN_DEGREES, ITEM_VIEW_LAYOUT_POSITION_CHANGE_MULTIPLIER ) );
 115     mItemViewOrientationConstraint.AddSource( LocalSource( ItemView::Property::LAYOUT_POSITION ) );
 116
 117     // Create a border around item-view (as item-view is clipping its children, we should NOT add this as a child of item-view).
 118     Control border = Control::New();
 119     border.SetParentOrigin( ParentOrigin::CENTER );
 120     border.SetAnchorPoint( AnchorPoint::CENTER );
 121     border.SetProperty( Control::Property::BACKGROUND,
 122                         Property::Map().Add( Toolkit::Visual::Property::TYPE, Visual::BORDER )
 123                                        .Add( BorderVisual::Property::COLOR, Color::WHITE )
 124                                        .Add( BorderVisual::Property::SIZE, 2.0f )
 125                                        .Add( BorderVisual::Property::ANTI_ALIASING, true ) );
 126     border.SetSize( Vector3( itemViewLayoutSize.x + ITEM_VIEW_BORDER_SIZE * 2.0f, itemViewLayoutSize.y + ITEM_VIEW_BORDER_SIZE * 2.0f, itemViewLayoutSize.z + ITEM_VIEW_BORDER_SIZE * 2.0f ) );
 127     stage.Add( border );
 128
 129     // Constrain the border's orientation to the orientation of item-view.
 130     Constraint constraint = Constraint::New< Quaternion >( border, Actor::Property::ORIENTATION, EqualToConstraint() );
 131     constraint.AddSource( Source( mItemView, Actor::Property::ORIENTATION ) );
 132     constraint.Apply();
 133
 134     // Create a button to toggle the clipping mode
 135     PushButton button = Toolkit::PushButton::New();
 136     button.SetParentOrigin( ParentOrigin::BOTTOM_CENTER );
 137     button.SetAnchorPoint( AnchorPoint::BOTTOM_CENTER );
 138     button.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::WIDTH );
 139     button.SetResizePolicy( ResizePolicy::USE_NATURAL_SIZE, Dimension::HEIGHT );
 140     button.SetProperty( Actor::Property::DRAW_MODE, DrawMode::OVERLAY_2D );
 141     button.SetProperty( Button::Property::LABEL, BUTTON_LABEL );
 142     button.ClickedSignal().Connect( this, &ClippingExample::OnButtonClicked );
 143     stage.Add( button );
 144   }
 145
 146   /**
 147    * @brief Called when the item-view starts to scroll.
 148    *
 149    * Here we want to apply the item-view constraint.
 150    */
 151   void ScrollStarted( const Vector2& /* currentScrollPosition */ )
 152   {
 153     mItemViewOrientationConstraint.Apply();
 154   }
 155
 156   /**
 157    * @brief Called when the item-view scrolling completes.
 158    *
 159    * Here we remove the item-view orientation constraint and perform an animation to return the item-view back to base-rotation.
 160    */
 161   void ScrollCompleted( const Vector2& /* currentScrollPosition */ )
 162   {
 163     Animation animation = Animation::New( ITEM_VIEW_ROTATION_ANIMATION_TIME );
 164     animation.AnimateTo( Property( mItemView, Actor::Property::ORIENTATION ), Quaternion( Degree( 0.0f ), Vector3::XAXIS ), AlphaFunction::EASE_IN_SINE );
 165     animation.Play();
 166
 167     mItemViewOrientationConstraint.Remove();
 168   }
 169
 170   /**
 171    * @brief Called when any key event is received
 172    *
 173    * Will use this to quit the application if Back or the Escape key is received
 174    * @param[in] event The key event information
 175    */
 176   void OnKeyEvent( const KeyEvent& event )
 177   {
 178     if( event.state == KeyEvent::Down )
 179     {
 180       if( IsKey( event, DALI_KEY_ESCAPE) || IsKey( event, DALI_KEY_BACK ) )
 181       {
 182         mApplication.Quit();
 183       }
 184     }
 185   }
 186
 187   /**
 188    * @brief Called when the button is clicked.
 189    *
 190    * Will use this to toggle between the clipping modes.
 191    * @param[in] button The button that has been clicked.
 192    */
 193   bool OnButtonClicked( Toolkit::Button button )
 194   {
 195     if( mItemView )
 196     {
 197       ClippingMode::Type currentMode = static_cast< ClippingMode::Type >( mItemView.GetProperty( Actor::Property::CLIPPING_MODE ).Get< int >() );
 198       mItemView.SetProperty( Actor::Property::CLIPPING_MODE, ( currentMode == ClippingMode::CLIP_CHILDREN ) ? ClippingMode::DISABLED : ClippingMode::CLIP_CHILDREN );
 199     }
 200     return true;
 201   }
 202
 203   // Data
 204
 205   Application& mApplication; ///< Reference to the application class.
 206   ItemView mItemView; ///< The item view which whose children we would like to clip.
 207   ClippingItemFactory mClippingItemFactory; ///< The ItemFactory used to create our items.
 208   Constraint mItemViewOrientationConstraint; ///< The constraint used to control the orientation of item-view.
 209 };
 210
 211 int DALI_EXPORT_API main( int argc, char **argv )
 212 {
 213   Application app = Application::New(&argc, &argv, DEMO_THEME_PATH);
 214   ClippingExample test(app);
 215   app.MainLoop();
 216   return 0;
 217 }