Moved Gesture::State and -::Type to gesture-enumerations.h.

[platform/core/uifw/dali-core.git] / dali / public-api / events / rotation-gesture.h

diff --git a/dali/public-api/events/rotation-gesture.h b/dali/public-api/events/rotation-gesture.h
index fa3894f..e3020f6 100644 (file)
--- a/dali/public-api/events/rotation-gesture.h
+++ b/dali/public-api/events/rotation-gesture.h
@@ -26,70 +26,104 @@
 namespace Dali
 {
 
+namespace Internal DALI_INTERNAL
+{
+class RotationGesture;
+}
+
 /**
  * @brief A RotationGesture is emitted when the user moves two fingers that are opposite each other
  * in a rotational/circular gesture.
  *
  * This gesture can be in one of three states; when the rotation gesture is first detected, its
- * state is set to Gesture::Started.  After this, if there is change in the gesture, the state will
- * be Gesture::Continuing. Finally, when the gesture ends, the state of the gesture changes to
- * Gesture::Finished.
+ * state is set to GestureState::STARTED.  After this, if there is change in the gesture, the state will
+ * be GestureState::CONTINUING. Finally, when the gesture ends, the state of the gesture changes to
+ * GestureState::FINISHED.
  *
  * A rotation gesture will continue to be sent to the actor under the center point of the rotation
  * until the rotation ends.
- * @SINCE_1_9.27
+ * @SINCE_1_9.28
  */
-struct DALI_CORE_API RotationGesture: public Gesture
+class DALI_CORE_API RotationGesture: public Gesture
 {
-  // Construction & Destruction
+public:
 
   /**
-   * @brief Default Constructor.
-   * @SINCE_1_9.27
-   * @param[in] state The state of the gesture
+   * @brief Creates an uninitialized RotationGesture handle.
+   *
+   * Calling member functions with an uninitialized Actor handle is not allowed.
+   * @SINCE_1_9.28
    */
-  RotationGesture( Gesture::State state );
+  RotationGesture();
 
   /**
    * @brief Copy constructor.
-   * @SINCE_1_9.27
+   * @SINCE_1_9.28
    * @param[in] rhs A reference to the copied handle
    */
   RotationGesture( const RotationGesture& rhs );
 
   /**
+   * @brief Move constructor.
+   * @SINCE_1_9.28
+   * @param[in] rhs A reference to the moved handle
+   */
+  RotationGesture( RotationGesture&& rhs );
+
+  /**
    * @brief Assignment operator.
-   * @SINCE_1_9.27
+   * @SINCE_1_9.28
    * @param[in] rhs A reference to the copied handle
    * @return A reference to this
    */
   RotationGesture& operator=( const RotationGesture& rhs );
 
   /**
-   * @brief Virtual destructor.
-   * @SINCE_1_9.27
+   * @brief Move assignment operator.
+   * @SINCE_1_9.28
+   * @param[in] rhs A reference to the moved handle
+   * @return A reference to this
    */
-  virtual ~RotationGesture();
+  RotationGesture& operator=( RotationGesture&& rhs );
 
-  // Data
+  /**
+   * @brief Non virtual destructor.
+   * @SINCE_1_9.28
+   */
+  ~RotationGesture();
 
   /**
    * @brief The overall rotation from the start of the rotation gesture till the latest rotation gesture.
-   * @SINCE_1_9.27
+   * @SINCE_1_9.28
+   * @return The rotation from the start of the rotation gesture till the latest rotation gesture.
    */
-  Radian rotation;
+  const Radian& GetRotation() const;
 
   /**
    * @brief The center point of the two points that caused the rotation gesture in screen coordinates.
-   * @SINCE_1_9.27
+   * @SINCE_1_9.28
+   * @return The center point in screen coordinates
    */
-  Vector2 screenCenterPoint;
+  const Vector2& GetScreenCenterPoint() const;
 
   /**
    * @brief The center point of the two points that caused the rotation gesture in local actor coordinates.
-   * @SINCE_1_9.27
+   * @SINCE_1_9.28
+   * @return The center point in local actor coordinates
+   */
+  const Vector2& GetLocalCenterPoint() const;
+
+public: // Not intended for application developers
+
+  /// @cond internal
+  /**
+   * @brief This constructor is used internally to Create an initialized RotationGesture handle.
+   *
+   * @param[in] rotationGesture A pointer to a newly allocated Dali resource
+   * @SINCE_1_9.28
    */
-  Vector2 localCenterPoint;
+  explicit DALI_INTERNAL RotationGesture( Internal::RotationGesture* rotationGesture );
+  /// @endcond
 };
 
 } // namespace Dali