2 * Copyright (c) 2017 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
23 /// RelativeVector2 is a two-dimensional vector.
24 /// Both values (x and y) should be between [0, 1].
26 public class RelativeVector2 : global::System.IDisposable
28 private global::System.Runtime.InteropServices.HandleRef swigCPtr;
29 protected bool swigCMemOwn;
31 internal RelativeVector2(global::System.IntPtr cPtr, bool cMemoryOwn)
33 swigCMemOwn = cMemoryOwn;
34 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
37 internal static global::System.Runtime.InteropServices.HandleRef getCPtr(RelativeVector2 obj)
39 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
42 //A Flag to check who called Dispose(). (By User or DisposeQueue)
43 private bool isDisposeQueued = false;
44 //A Flat to check if it is already disposed.
45 protected bool disposed = false;
51 isDisposeQueued = true;
52 DisposeQueue.Instance.Add(this);
58 //Throw excpetion if Dispose() is called in separate thread.
59 if (!Window.IsInstalled())
61 throw new System.InvalidOperationException("This API called from separate thread. This API must be called from MainThread.");
66 Dispose(DisposeTypes.Implicit);
70 Dispose(DisposeTypes.Explicit);
71 System.GC.SuppressFinalize(this);
75 protected virtual void Dispose(DisposeTypes type)
82 if(type == DisposeTypes.Explicit)
85 //Release your own managed resources here.
86 //You should release all of your own disposable objects here.
89 //Release your own unmanaged resources here.
90 //You should not access any managed member here except static instance.
91 //because the execution order of Finalizes is non-deterministic.
93 if (swigCPtr.Handle != global::System.IntPtr.Zero)
98 NDalicPINVOKE.delete_Vector2(swigCPtr);
100 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
107 /// The addition operator.
109 /// <param name="arg1">The vector to add.</param>
110 /// <param name="arg2">The vector to add.</param>
111 /// <returns>The vector containing the result of the addition.</returns>
112 /// <since_tizen> 3 </since_tizen>
113 public static RelativeVector2 operator +(RelativeVector2 arg1, RelativeVector2 arg2)
115 RelativeVector2 result = arg1.Add(arg2);
121 /// The subtraction operator.
123 /// <param name="arg1">The vector to subtract.</param>
124 /// <param name="arg2">The vector to subtract.</param>
125 /// <returns>The vector containing the result of the subtraction.</returns>
126 /// <since_tizen> 3 </since_tizen>
127 public static RelativeVector2 operator -(RelativeVector2 arg1, RelativeVector2 arg2)
129 RelativeVector2 result = arg1.Subtract(arg2);
135 /// The multiplication operator.
137 /// <param name="arg1">The vector to multiply.</param>
138 /// <param name="arg2">The vector to multiply.</param>
139 /// <returns>The vector containing the result of the multiplication.</returns>
140 /// <since_tizen> 3 </since_tizen>
141 public static RelativeVector2 operator *(RelativeVector2 arg1, RelativeVector2 arg2)
143 RelativeVector2 result = arg1.Multiply(arg2);
149 /// The multiplication operator.
151 /// <param name="arg1">The vector to multiply.</param>
152 /// <param name="arg2">The float value to scale the vector.</param>
153 /// <returns>The vector containing the result of the scaling.</returns>
154 /// <since_tizen> 3 </since_tizen>
155 public static RelativeVector2 operator *(RelativeVector2 arg1, float arg2)
157 RelativeVector2 result = arg1.Multiply(arg2);
163 /// The division operator.
165 /// <param name="arg1">The vector to divide.</param>
166 /// <param name="arg2">The vector to divide.</param>
167 /// <returns>The vector containing the result of the division.</returns>
168 /// <since_tizen> 3 </since_tizen>
169 public static RelativeVector2 operator /(RelativeVector2 arg1, RelativeVector2 arg2)
171 RelativeVector2 result = arg1.Divide(arg2);
177 /// The division operator.
179 /// <param name="arg1">The vector to divide.</param>
180 /// <param name="arg2">The float value to scale the vector by.</param>
181 /// <returns>The vector containing the result of the scaling.</returns>
182 /// <since_tizen> 3 </since_tizen>
183 public static RelativeVector2 operator /(RelativeVector2 arg1, float arg2)
185 RelativeVector2 result = arg1.Divide(arg2);
192 /// The const array subscript operator overload. Should be 0, 1.
194 /// <param name="index">The subscript index.</param>
195 /// <returns>The float at the given index.</returns>
196 /// <since_tizen> 3 </since_tizen>
197 public float this[uint index]
201 return ValueOfIndex(index);
207 internal static RelativeVector2 GetRelativeVector2FromPtr(global::System.IntPtr cPtr)
209 RelativeVector2 ret = new RelativeVector2(cPtr, false);
210 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
218 /// <since_tizen> 3 </since_tizen>
219 public RelativeVector2() : this(NDalicPINVOKE.new_Vector2__SWIG_0(), true)
221 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
227 /// <param name="x">The x component.</param>
228 /// <param name="y">The y component.</param>
229 /// <since_tizen> 3 </since_tizen>
230 public RelativeVector2(float x, float y) : this(NDalicPINVOKE.new_Vector2__SWIG_1(x, y), true)
234 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
240 /// <param name="relativeVector3">The RelativeVector3 to create this vector from.</param>
241 /// <since_tizen> 3 </since_tizen>
242 public RelativeVector2(RelativeVector3 relativeVector3) : this(NDalicPINVOKE.new_Vector2__SWIG_3(RelativeVector3.getCPtr(relativeVector3)), true)
244 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
250 /// <param name="relativeVector4">The RelativeVector4 to create this vector from.</param>
251 /// <since_tizen> 3 </since_tizen>
252 public RelativeVector2(RelativeVector4 relativeVector4) : this(NDalicPINVOKE.new_Vector2__SWIG_4(RelativeVector4.getCPtr(relativeVector4)), true)
254 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
258 private RelativeVector2 Add(RelativeVector2 rhs)
260 RelativeVector2 ret = new RelativeVector2(NDalicPINVOKE.Vector2_Add(swigCPtr, RelativeVector2.getCPtr(rhs)), true);
261 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
265 private RelativeVector2 Subtract(RelativeVector2 rhs)
267 RelativeVector2 ret = new RelativeVector2(NDalicPINVOKE.Vector2_Subtract__SWIG_0(swigCPtr, RelativeVector2.getCPtr(rhs)), true);
268 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
272 private RelativeVector2 Multiply(RelativeVector2 rhs)
274 RelativeVector2 ret = new RelativeVector2(NDalicPINVOKE.Vector2_Multiply__SWIG_0(swigCPtr, RelativeVector2.getCPtr(rhs)), true);
275 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
279 private RelativeVector2 Multiply(float rhs)
281 RelativeVector2 ret = new RelativeVector2(NDalicPINVOKE.Vector2_Multiply__SWIG_1(swigCPtr, rhs), true);
282 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
286 private RelativeVector2 Divide(RelativeVector2 rhs)
288 RelativeVector2 ret = new RelativeVector2(NDalicPINVOKE.Vector2_Divide__SWIG_0(swigCPtr, RelativeVector2.getCPtr(rhs)), true);
289 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
293 private RelativeVector2 Divide(float rhs)
295 RelativeVector2 ret = new RelativeVector2(NDalicPINVOKE.Vector2_Divide__SWIG_1(swigCPtr, rhs), true);
296 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
300 private float ValueOfIndex(uint index)
302 float ret = NDalicPINVOKE.Vector2_ValueOfIndex__SWIG_0(swigCPtr, index);
303 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
308 /// Compares if the rhs is equal to.
310 /// <param name="rhs">The vector to compare.</param>
311 /// <returns>Returns true if the two vectors are equal, otherwise false.</returns>
312 /// <since_tizen> 3 </since_tizen>
313 public bool EqualTo(RelativeVector2 rhs)
315 bool ret = NDalicPINVOKE.Vector2_EqualTo(swigCPtr, RelativeVector2.getCPtr(rhs));
316 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
321 /// Compares if the rhs is not equal to.
323 /// <param name="rhs">The vector to compare.</param>
324 /// <returns>Returns true if the two vectors are not equal, otherwise false.</returns>
325 /// <since_tizen> 3 </since_tizen>
326 public bool NotEqualTo(RelativeVector2 rhs)
328 bool ret = NDalicPINVOKE.Vector2_NotEqualTo(swigCPtr, RelativeVector2.getCPtr(rhs));
329 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
337 /// <since_tizen> 3 </since_tizen>
343 NDalicPINVOKE.Vector2_X_set(swigCPtr, value);
344 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
348 float ret = NDalicPINVOKE.Vector2_X_get(swigCPtr);
349 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
357 /// <since_tizen> 3 </since_tizen>
363 NDalicPINVOKE.Vector2_Y_set(swigCPtr, value);
364 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
368 float ret = NDalicPINVOKE.Vector2_Y_get(swigCPtr);
369 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
376 /// <since_tizen> 3 </since_tizen>
377 public static implicit operator Vector2(RelativeVector2 relativeVector2)
379 return new Vector2(relativeVector2.X, relativeVector2.Y);
384 /// <since_tizen> 3 </since_tizen>
385 public static implicit operator RelativeVector2(Vector2 vec)
389 return new RelativeVector2(vec.X, vec.Y);
392 internal static void ValueCheck(RelativeVector2 relativeVector2)
394 if(relativeVector2.X < 0.0f)
396 relativeVector2.X = 0.0f;
397 Tizen.Log.Fatal("NUI", "The value of Result is invalid! Should be between [0, 1].");
399 else if(relativeVector2.X > 1.0f)
401 relativeVector2.X = 1.0f;
402 Tizen.Log.Fatal("NUI", "The value of Result is invalid! Should be between [0, 1].");
404 if(relativeVector2.Y < 0.0f)
406 relativeVector2.Y = 0.0f;
407 Tizen.Log.Fatal("NUI", "The value of Result is invalid! Should be between [0, 1].");
409 else if(relativeVector2.Y > 1.0f)
411 relativeVector2.Y = 1.0f;
412 Tizen.Log.Fatal("NUI", "The value of Result is invalid! Should be between [0, 1].");
416 internal static void ValueCheck(float value)
421 Tizen.Log.Fatal("NUI", "The value of Parameters is invalid! Should be between [0, 1].");
423 else if(value > 1.0f)
426 Tizen.Log.Fatal("NUI", "The value of Parameters is invalid! Should be between [0, 1].");