src/Tizen.NUI/src/public/Touch.cs

   1 /** Copyright (c) 2017 Samsung Electronics Co., Ltd.
   2 *
   3 * Licensed under the Apache License, Version 2.0 (the "License");
   4 * you may not use this file except in compliance with the License.
   5 * You may obtain a copy of the License at
   6 *
   7 * http://www.apache.org/licenses/LICENSE-2.0
   8 *
   9 * Unless required by applicable law or agreed to in writing, software
  10 * distributed under the License is distributed on an "AS IS" BASIS,
  11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 * See the License for the specific language governing permissions and
  13 * limitations under the License.
  14 *
  15 */
  16
  17 namespace Tizen.NUI
  18 {
  19     using Tizen.NUI.BaseComponents;
  20     /// <summary>
  21     /// Touch events are a collection of points at a specific moment in time.<br>
  22     /// When a multi-touch event occurs, each point represents the points that are currently being
  23     /// touched or the points where a touch has stopped.<br>
  24     /// </summary>
  25     public class Touch : BaseHandle
  26     {
  27         private global::System.Runtime.InteropServices.HandleRef swigCPtr;
  28
  29         internal Touch(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicPINVOKE.Touch_SWIGUpcast(cPtr), cMemoryOwn)
  30         {
  31             swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
  32         }
  33
  34         internal static global::System.Runtime.InteropServices.HandleRef getCPtr(Touch obj)
  35         {
  36             return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
  37         }
  38
  39         protected override void Dispose(DisposeTypes type)
  40         {
  41             if(disposed)
  42             {
  43                 return;
  44             }
  45
  46             if(type == DisposeTypes.Explicit)
  47             {
  48                 //Called by User
  49                 //Release your own managed resources here.
  50                 //You should release all of your own disposable objects here.
  51             }
  52
  53             //Release your own unmanaged resources here.
  54             //You should not access any managed member here except static instance.
  55             //because the execution order of Finalizes is non-deterministic.
  56
  57             if (swigCPtr.Handle != global::System.IntPtr.Zero)
  58             {
  59                 if (swigCMemOwn)
  60                 {
  61                     swigCMemOwn = false;
  62                     NDalicPINVOKE.delete_Touch(swigCPtr);
  63                 }
  64                 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
  65             }
  66
  67             base.Dispose(type);
  68         }
  69
  70
  71         internal static Touch GetTouchFromPtr(global::System.IntPtr cPtr)
  72         {
  73             Touch ret = Registry.GetManagedBaseHandleFromNativePtr(cPtr) as Touch;
  74             if (ret == null)
  75             {
  76                 ret = new Touch(cPtr, false);
  77             }
  78
  79             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  80             return ret;
  81         }
  82
  83         /// <summary>
  84         /// An uninitialized touch instance.<br>
  85         /// Calling member functions with an uninitialized touch handle is not allowed.<br>
  86         /// </summary>
  87         public Touch() : this(NDalicPINVOKE.new_Touch__SWIG_0(), true)
  88         {
  89             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  90         }
  91
  92         internal Touch(Touch other) : this(NDalicPINVOKE.new_Touch__SWIG_1(Touch.getCPtr(other)), true)
  93         {
  94             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  95         }
  96
  97         /// <summary>
  98         /// Returns the time (in ms) that the touch event occurred.
  99         /// </summary>
 100         /// <returns>The time (in ms) that the touch event occurred.</returns>
 101         public uint GetTime()
 102         {
 103             uint ret = NDalicPINVOKE.Touch_GetTime(swigCPtr);
 104             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 105             return ret;
 106         }
 107
 108         /// <summary>
 109         /// Returns the total number of points in this TouchData.
 110         /// </summary>
 111         /// <returns>The total number of points.</returns>
 112         public uint GetPointCount()
 113         {
 114             uint ret = NDalicPINVOKE.Touch_GetPointCount(swigCPtr);
 115             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 116             return ret;
 117         }
 118
 119         /// <summary>
 120         /// Returns the ID of the device used for the point specified.<br>
 121         /// Each point has a unique device ID, which specifies the device used for that
 122         /// point. This is returned by this method.<br>
 123         /// If a point is greater than GetPointCount(), then this method will return -1.<br>
 124         /// </summary>
 125         /// <param name="point">The point required.</param>
 126         /// <returns>The device ID of this point.</returns>
 127         public int GetDeviceId(uint point)
 128         {
 129             int ret = NDalicPINVOKE.Touch_GetDeviceId(swigCPtr, point);
 130             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 131             return ret;
 132         }
 133
 134         /// <summary>
 135         /// Retrieves the state of the point specified.<br>
 136         /// If a point is greater than GetPointCount(), then this method will return PointState.Finished.<br>
 137         /// </summary>
 138         /// <param name="point">The point required.</param>
 139         /// <returns>The state of the point specified.</returns>
 140         public PointStateType GetState(uint point)
 141         {
 142             PointStateType ret = (PointStateType)NDalicPINVOKE.Touch_GetState(swigCPtr, point);
 143             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 144             return ret;
 145         }
 146
 147         /// <summary>
 148         /// Retrieves the actor that was underneath the point specified.<br>
 149         /// If a point is greater than GetPointCount(), then this method will return an empty handle.<br>
 150         /// </summary>
 151         /// <param name="point">The point required.</param>
 152         /// <returns>The actor that was underneath the point specified.</returns>
 153         public View GetHitView(uint point)
 154         {
 155             global::System.IntPtr cPtr = NDalicPINVOKE.Touch_GetHitActor(swigCPtr, point);
 156             View ret = Registry.GetManagedBaseHandleFromNativePtr(cPtr) as View;
 157
 158             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 159             return ret;
 160         }
 161
 162         /// <summary>
 163         /// Retrieves the coordinates relative to the top-left of the hit actor at the point specified.<br>
 164         /// The top-left of an actor is (0.0, 0.0, 0.5).<br>
 165         /// If you require the local coordinates of another actor (for example, the parent of the hit actor),
 166         /// then you should use Actor::ScreenToLocal().<br>
 167         /// If a point is greater than GetPointCount(), then this method will return Vector2.Zero.<br>
 168         /// </summary>
 169         /// <param name="point">The point required.</param>
 170         /// <returns>The coordinates relative to the top-left of the hit actor of the point specified.</returns>
 171         public Vector2 GetLocalPosition(uint point)
 172         {
 173             Vector2 ret = new Vector2(NDalicPINVOKE.Touch_GetLocalPosition(swigCPtr, point), false);
 174             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 175             return ret;
 176         }
 177
 178         /// <summary>
 179         /// Retrieves the coordinates relative to the top-left of the screen of the point specified.<br>
 180         /// If a point is greater than GetPointCount(), then this method will return Vector2.Zero.<br>
 181         /// </summary>
 182         /// <param name="point">The point required.</param>
 183         /// <returns>The coordinates relative to the top-left of the screen of the point specified.</returns>
 184         public Vector2 GetScreenPosition(uint point)
 185         {
 186             Vector2 ret = new Vector2(NDalicPINVOKE.Touch_GetScreenPosition(swigCPtr, point), false);
 187             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 188             return ret;
 189         }
 190
 191         /// <summary>
 192         /// Retrieves the radius of the press point.<br>
 193         /// This is the average of both the horizontal and vertical radii of the press point.<br>
 194         /// If point is greater than GetPointCount(), then this method will return 0.0f.<br>
 195         /// </summary>
 196         /// <param name="point">The point required.</param>
 197         /// <returns>The radius of the press point.</returns>
 198         public float GetRadius(uint point)
 199         {
 200             float ret = NDalicPINVOKE.Touch_GetRadius(swigCPtr, point);
 201             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 202             return ret;
 203         }
 204
 205         /// <summary>
 206         /// Retrieves both the horizontal and the vertical radii of the press point.<br>
 207         /// If a point is greater than GetPointCount(), then this method will return Vector2.Zero.<br>
 208         /// </summary>
 209         /// <param name="point">The point required.</param>
 210         /// <returns>The horizontal and vertical radii of the press point.</returns>
 211         public Vector2 GetEllipseRadius(uint point)
 212         {
 213             Vector2 ret = new Vector2(NDalicPINVOKE.Touch_GetEllipseRadius(swigCPtr, point), false);
 214             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 215             return ret;
 216         }
 217
 218         /// <summary>
 219         /// Retrieves the touch pressure.<br>
 220         /// The pressure range starts at 0.0f.<br>
 221         /// Normal pressure is defined as 1.0f.<br>
 222         /// A value between 0.0f and 1.0f means light pressure has been applied.<br>
 223         /// A value greater than 1.0f means more pressure than normal has been applied.<br>
 224         /// If point is greater than GetPointCount(), then this method will return 1.0f.<br>
 225         /// </summary>
 226         /// <param name="point">The point required.</param>
 227         /// <returns>The touch pressure.</returns>
 228         public float GetPressure(uint point)
 229         {
 230             float ret = NDalicPINVOKE.Touch_GetPressure(swigCPtr, point);
 231             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 232             return ret;
 233         }
 234
 235         internal Degree GetAngle(uint point)
 236         {
 237             Degree ret = new Degree(NDalicPINVOKE.Touch_GetAngle(swigCPtr, point), true);
 238             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 239             return ret;
 240         }
 241
 242     }
 243 }