/*
* Copyright(c) 2020 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
using System.ComponentModel;
namespace Tizen.NUI
{
///
/// A PanGesture is emitted when the user moves one or more fingers in a particular direction.
/// A pan gesture will end in the following ways:
/// - User releases the primary finger (the first touch).
/// - User has more fingers on the screen than the maximum specified.
/// - User has less fingers on the screen than the minimum specified.
/// - Cancelled by the system.
/// A pan gesture will continue to be sent to the actor under than initial pan until it ends.
///
/// 3
public class PanGesture : Gesture
{
///
/// The default constructor.
///
/// 3
public PanGesture() : this(Interop.PanGestureDetector.PanGesture_New(0), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
///
/// The constructor.
///
/// The state of the gesture
internal PanGesture(Gesture.StateType state) : this(Interop.PanGestureDetector.PanGesture_New((int)state), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
internal PanGesture(global::System.IntPtr cPtr, bool cMemoryOwn) : base(Interop.PanGestureDetector.PanGesture_SWIGUpcast(cPtr), cMemoryOwn)
{
}
///
/// The velocity at which the user is moving their fingers.
/// This is represented as a Vector2 and is the pixel movement per millisecond.
/// A positive x value shows that the user is panning to the right, a negative x value means the opposite.
/// A positive y value shows that the user is panning downwards, a negative y values means upwards.
///
/// 3
public Vector2 Velocity
{
get
{
return velocity;
}
}
///
/// This is a Vector2 showing how much the user has panned (dragged) since the last pan gesture or,
/// if the gesture has just started, then the amount panned since the user touched the screen.
/// A positive x value shows that the user is panning to the right, a negative x value means the opposite.
/// A positive y value shows that the user is panning downwards, a negative y value means upwards.
///
/// 3
public Vector2 Displacement
{
get
{
return displacement;
}
}
///
/// The current touch position of the primary touch point in local actor coordinates.
///
/// 3
public Vector2 Position
{
get
{
return position;
}
}
///
/// The velocity at which the user is moving their fingers.
/// This is represented as a Vector2 and is the pixel movement per millisecond.
/// A positive x value shows that the user is panning to the right, a negative x value means the opposite.
/// A positive y value shows that the user is panning downwards, a negative y values means upwards.
/// This value represents the screen coordinates.
///
/// 3
public Vector2 ScreenVelocity
{
get
{
return screenVelocity;
}
}
///
/// This is a Vector2 showing how much the user has panned (dragged) since the last pan gesture or,
/// if the gesture has just started, then the amount panned since the user touched the screen.
/// A positive x value shows that the user is panning to the right, a negative x value means the opposite.
/// A positive y value shows that the user is panning downwards, a negative y value means upwards.
/// This value is in screen coordinates.
///
/// 3
public Vector2 ScreenDisplacement
{
get
{
return screenDisplacement;
}
}
///
/// The current touch position of the primary touch point in screen coordinates.
///
/// 3
public Vector2 ScreenPosition
{
get
{
return screenPosition;
}
}
///
/// The total number of fingers touching the screen in a pan gesture.
///
/// 3
public uint NumberOfTouches
{
get
{
return numberOfTouches;
}
}
private Vector2 velocity
{
set
{
Interop.PanGestureDetector.PanGesture_velocity_set(swigCPtr, Vector2.getCPtr(value));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
get
{
global::System.IntPtr cPtr = Interop.PanGestureDetector.PanGesture_velocity_get(swigCPtr);
Vector2 ret = (cPtr == global::System.IntPtr.Zero) ? null : new Vector2(cPtr, false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
}
private Vector2 displacement
{
set
{
Interop.PanGestureDetector.PanGesture_displacement_set(swigCPtr, Vector2.getCPtr(value));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
get
{
global::System.IntPtr cPtr = Interop.PanGestureDetector.PanGesture_displacement_get(swigCPtr);
Vector2 ret = (cPtr == global::System.IntPtr.Zero) ? null : new Vector2(cPtr, false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
}
private Vector2 position
{
set
{
Interop.PanGestureDetector.PanGesture_position_set(swigCPtr, Vector2.getCPtr(value));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
get
{
global::System.IntPtr cPtr = Interop.PanGestureDetector.PanGesture_position_get(swigCPtr);
Vector2 ret = (cPtr == global::System.IntPtr.Zero) ? null : new Vector2(cPtr, false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
}
private Vector2 screenVelocity
{
set
{
Interop.PanGestureDetector.PanGesture_screenVelocity_set(swigCPtr, Vector2.getCPtr(value));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
get
{
global::System.IntPtr cPtr = Interop.PanGestureDetector.PanGesture_screenVelocity_get(swigCPtr);
Vector2 ret = (cPtr == global::System.IntPtr.Zero) ? null : new Vector2(cPtr, false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
}
private Vector2 screenDisplacement
{
set
{
Interop.PanGestureDetector.PanGesture_screenDisplacement_set(swigCPtr, Vector2.getCPtr(value));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
get
{
global::System.IntPtr cPtr = Interop.PanGestureDetector.PanGesture_screenDisplacement_get(swigCPtr);
Vector2 ret = (cPtr == global::System.IntPtr.Zero) ? null : new Vector2(cPtr, false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
}
private Vector2 screenPosition
{
set
{
Interop.PanGestureDetector.PanGesture_screenPosition_set(swigCPtr, Vector2.getCPtr(value));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
get
{
global::System.IntPtr cPtr = Interop.PanGestureDetector.PanGesture_screenPosition_get(swigCPtr);
Vector2 ret = (cPtr == global::System.IntPtr.Zero) ? null : new Vector2(cPtr, false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
}
private uint numberOfTouches
{
set
{
Interop.PanGestureDetector.PanGesture_numberOfTouches_set(swigCPtr, value);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
get
{
uint ret = Interop.PanGestureDetector.PanGesture_numberOfTouches_get(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
}
///
/// Returns the speed at which the user is moving their fingers.
/// This is the pixel movement per millisecond.
///
/// The speed of the pan (in pixels per millisecond).
/// 3
public float GetSpeed()
{
float ret = Interop.PanGestureDetector.PanGesture_GetSpeed(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
///
/// Returns the distance the user has panned (dragged) since the last pan gesture or,
/// if the gesture has just started, then the distance moved since the user touched the screen.
/// This is always a positive value.
///
/// The distance, as a float, a user's finger has panned.
/// 3
public float GetDistance()
{
float ret = Interop.PanGestureDetector.PanGesture_GetDistance(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
///
/// Returns the speed at which the user is moving their fingers relative to screen coordinates.
/// This is the pixel movement per millisecond.
///
/// The speed of the pan (in pixels per millisecond).
/// 3
public float GetScreenSpeed()
{
float ret = Interop.PanGestureDetector.PanGesture_GetScreenSpeed(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
///
/// Returns the distance the user has panned (dragged) since the last pan gesture in screen
/// coordinates or, if the gesture has just started, then the distance in screen coordinates moved
/// since the user touched the screen.
/// This is always a positive value.
///
/// The distance, as a float, a user's finger has panned.
/// 3
public float GetScreenDistance()
{
float ret = Interop.PanGestureDetector.PanGesture_GetScreenDistance(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
internal static global::System.Runtime.InteropServices.HandleRef getCPtr(PanGesture obj)
{
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
internal static PanGesture GetPanGestureFromPtr(global::System.IntPtr cPtr)
{
PanGesture ret = new PanGesture(cPtr, false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
/// This will not be public opened.
[EditorBrowsable(EditorBrowsableState.Never)]
protected override void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr)
{
Interop.PanGestureDetector.delete_PanGesture(swigCPtr);
}
}
}