dali/devel-api/events/rotation-gesture-detector.h

   1 #ifndef DALI_ROTATION_GESTURE_DETECTOR_H
   2 #define DALI_ROTATION_GESTURE_DETECTOR_H
   3
   4 /*
   5  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/events/gesture-detector.h>
  23 #include <dali/public-api/signals/dali-signal.h>
  24
  25 namespace Dali
  26 {
  27
  28 namespace Internal DALI_INTERNAL
  29 {
  30 class RotationGestureDetector;
  31 }
  32
  33 struct RotationGesture;
  34
  35 /**
  36  * @brief This class looks for a rotation gesture involving two touches.
  37  *
  38  * It measures the relative rotation of two touch points & emits a signal
  39  * when this changes. Please see RotationGesture for more information.
  40  *
  41  * The application programmer can use this gesture detector as follows:
  42  * @code
  43  * RotationGestureDetector detector = RotationGestureDetector::New();
  44  * detector.Attach( myActor );
  45  * detector.DetectedSignal().Connect( this, &MyApplication::OnRotation );
  46  * @endcode
  47  *
  48  * @see RotationGesture
  49  *
  50  * Signals
  51  * | %Signal Name      | Method                |
  52  * |-------------------|-----------------------|
  53  * | rotationDetected  | @ref DetectedSignal() |
  54  */
  55 class DALI_CORE_API RotationGestureDetector : public GestureDetector
  56 {
  57 public: // Typedefs
  58
  59   /**
  60    * @brief Signal type.
  61    */
  62   typedef Signal< void ( Actor, const RotationGesture& ) > DetectedSignalType;
  63
  64 public: // Creation & Destruction
  65
  66   /**
  67    * @brief Creates an uninitialized RotationGestureDetector; this can be initialized with RotationGestureDetector::New().
  68    *
  69    * Calling member functions with an uninitialized RotationGestureDetector handle is not allowed.
  70    */
  71   RotationGestureDetector();
  72
  73   /**
  74    * @brief Creates an initialized RotationGestureDetector.
  75    *
  76    * @return A handle to a newly allocated Dali resource
  77    */
  78   static RotationGestureDetector New();
  79
  80   /**
  81    * @brief Downcasts a handle to RotationGestureDetector handle.
  82    *
  83    * If handle points to a RotationGestureDetector object, the
  84    * downcast produces valid handle. If not, the returned handle is left uninitialized.
  85    * @param[in] handle Handle to an object
  86    * @return Handle to a RotationGestureDetector object or an uninitialized handle
  87    */
  88   static RotationGestureDetector DownCast( BaseHandle handle );
  89
  90   /**
  91    * @brief Destructor.
  92    *
  93    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  94    */
  95   ~RotationGestureDetector();
  96
  97   /**
  98    * @brief This copy constructor is required for (smart) pointer semantics.
  99    *
 100    * @param[in] handle A reference to the copied handle
 101    */
 102   RotationGestureDetector(const RotationGestureDetector& handle);
 103
 104   /**
 105    * @brief This assignment operator is required for (smart) pointer semantics.
 106    *
 107    * @param[in] rhs A reference to the copied handle
 108    * @return A reference to this
 109    */
 110   RotationGestureDetector& operator=(const RotationGestureDetector& rhs);
 111
 112 public: // Signals
 113
 114   /**
 115    * @brief This signal is emitted when the rotation gesture is detected on the attached actor.
 116    *
 117    * A callback of the following type may be connected:
 118    * @code
 119    *   void YourCallbackName( Actor actor, const RotationGesture& gesture );
 120    * @endcode
 121    * @return The signal to connect to
 122    * @pre The gesture detector has been initialized.
 123    */
 124   DetectedSignalType& DetectedSignal();
 125
 126 public: // Not intended for Application developers
 127
 128   /// @cond internal
 129   /**
 130    * @brief This constructor is used by RotationGestureDetector::New() methods.
 131    *
 132    * @param[in] internal A pointer to a newly allocated Dali resource
 133    */
 134   explicit DALI_INTERNAL RotationGestureDetector(Internal::RotationGestureDetector* internal);
 135   /// @endcond
 136
 137 };
 138
 139 } // namespace Dali
 140
 141 #endif // DALI_ROTATION_GESTURE_DETECTOR_H