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;
32 /// <since_tizen> 3 </since_tizen>
33 protected bool swigCMemOwn;
35 internal RelativeVector2(global::System.IntPtr cPtr, bool cMemoryOwn)
37 swigCMemOwn = cMemoryOwn;
38 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
41 internal static global::System.Runtime.InteropServices.HandleRef getCPtr(RelativeVector2 obj)
43 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
46 //A Flag to check who called Dispose(). (By User or DisposeQueue)
47 private bool isDisposeQueued = false;
49 /// A Flat to check if it is already disposed.
51 /// <since_tizen> 3 </since_tizen>
52 protected bool disposed = false;
57 /// <since_tizen> 3 </since_tizen>
62 isDisposeQueued = true;
63 DisposeQueue.Instance.Add(this);
70 /// <since_tizen> 3 </since_tizen>
73 //Throw excpetion if Dispose() is called in separate thread.
74 if (!Window.IsInstalled())
76 throw new System.InvalidOperationException("This API called from separate thread. This API must be called from MainThread.");
81 Dispose(DisposeTypes.Implicit);
85 Dispose(DisposeTypes.Explicit);
86 System.GC.SuppressFinalize(this);
93 /// <since_tizen> 3 </since_tizen>
94 protected virtual void Dispose(DisposeTypes type)
101 if(type == DisposeTypes.Explicit)
104 //Release your own managed resources here.
105 //You should release all of your own disposable objects here.
108 //Release your own unmanaged resources here.
109 //You should not access any managed member here except static instance.
110 //because the execution order of Finalizes is non-deterministic.
112 if (swigCPtr.Handle != global::System.IntPtr.Zero)
117 NDalicPINVOKE.delete_Vector2(swigCPtr);
119 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
126 /// The addition operator.
128 /// <param name="arg1">The vector to add.</param>
129 /// <param name="arg2">The vector to add.</param>
130 /// <returns>The vector containing the result of the addition.</returns>
131 /// <since_tizen> 3 </since_tizen>
132 public static RelativeVector2 operator +(RelativeVector2 arg1, RelativeVector2 arg2)
134 RelativeVector2 result = arg1.Add(arg2);
135 return ValueCheck(result);
139 /// The subtraction operator.
141 /// <param name="arg1">The vector to subtract.</param>
142 /// <param name="arg2">The vector to subtract.</param>
143 /// <returns>The vector containing the result of the subtraction.</returns>
144 /// <since_tizen> 3 </since_tizen>
145 public static RelativeVector2 operator -(RelativeVector2 arg1, RelativeVector2 arg2)
147 RelativeVector2 result = arg1.Subtract(arg2);
148 return ValueCheck(result);
152 /// The multiplication operator.
154 /// <param name="arg1">The vector to multiply.</param>
155 /// <param name="arg2">The vector to multiply.</param>
156 /// <returns>The vector containing the result of the multiplication.</returns>
157 /// <since_tizen> 3 </since_tizen>
158 public static RelativeVector2 operator *(RelativeVector2 arg1, RelativeVector2 arg2)
160 RelativeVector2 result = arg1.Multiply(arg2);
161 return ValueCheck(result);
165 /// The multiplication operator.
167 /// <param name="arg1">The vector to multiply.</param>
168 /// <param name="arg2">The float value to scale the vector.</param>
169 /// <returns>The vector containing the result of the scaling.</returns>
170 /// <since_tizen> 3 </since_tizen>
171 public static RelativeVector2 operator *(RelativeVector2 arg1, float arg2)
173 RelativeVector2 result = arg1.Multiply(arg2);
174 return ValueCheck(result);
178 /// The division operator.
180 /// <param name="arg1">The vector to divide.</param>
181 /// <param name="arg2">The vector to divide.</param>
182 /// <returns>The vector containing the result of the division.</returns>
183 /// <since_tizen> 3 </since_tizen>
184 public static RelativeVector2 operator /(RelativeVector2 arg1, RelativeVector2 arg2)
186 RelativeVector2 result = arg1.Divide(arg2);
187 return ValueCheck(result);
191 /// The division operator.
193 /// <param name="arg1">The vector to divide.</param>
194 /// <param name="arg2">The float value to scale the vector by.</param>
195 /// <returns>The vector containing the result of the scaling.</returns>
196 /// <since_tizen> 3 </since_tizen>
197 public static RelativeVector2 operator /(RelativeVector2 arg1, float arg2)
199 RelativeVector2 result = arg1.Divide(arg2);
200 return ValueCheck(result);
205 /// The const array subscript operator overload. Should be 0, 1.
207 /// <param name="index">The subscript index.</param>
208 /// <returns>The float at the given index.</returns>
209 /// <since_tizen> 3 </since_tizen>
210 public float this[uint index]
214 return ValueOfIndex(index);
220 internal static RelativeVector2 GetRelativeVector2FromPtr(global::System.IntPtr cPtr)
222 RelativeVector2 ret = new RelativeVector2(cPtr, false);
223 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
231 /// <since_tizen> 3 </since_tizen>
232 public RelativeVector2() : this(NDalicPINVOKE.new_Vector2__SWIG_0(), true)
234 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
240 /// <param name="x">The x component.</param>
241 /// <param name="y">The y component.</param>
242 /// <since_tizen> 3 </since_tizen>
243 public RelativeVector2(float x, float y) : this(NDalicPINVOKE.new_Vector2__SWIG_1(ValueCheck(x), ValueCheck(y)), true)
245 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
251 /// <param name="relativeVector3">The RelativeVector3 to create this vector from.</param>
252 /// <since_tizen> 3 </since_tizen>
253 public RelativeVector2(RelativeVector3 relativeVector3) : this(NDalicPINVOKE.new_Vector2__SWIG_3(RelativeVector3.getCPtr(relativeVector3)), true)
255 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
261 /// <param name="relativeVector4">The RelativeVector4 to create this vector from.</param>
262 /// <since_tizen> 3 </since_tizen>
263 public RelativeVector2(RelativeVector4 relativeVector4) : this(NDalicPINVOKE.new_Vector2__SWIG_4(RelativeVector4.getCPtr(relativeVector4)), true)
265 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
269 private RelativeVector2 Add(RelativeVector2 rhs)
271 RelativeVector2 ret = new RelativeVector2(NDalicPINVOKE.Vector2_Add(swigCPtr, RelativeVector2.getCPtr(rhs)), true);
272 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
276 private RelativeVector2 Subtract(RelativeVector2 rhs)
278 RelativeVector2 ret = new RelativeVector2(NDalicPINVOKE.Vector2_Subtract__SWIG_0(swigCPtr, RelativeVector2.getCPtr(rhs)), true);
279 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
283 private RelativeVector2 Multiply(RelativeVector2 rhs)
285 RelativeVector2 ret = new RelativeVector2(NDalicPINVOKE.Vector2_Multiply__SWIG_0(swigCPtr, RelativeVector2.getCPtr(rhs)), true);
286 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
290 private RelativeVector2 Multiply(float rhs)
292 RelativeVector2 ret = new RelativeVector2(NDalicPINVOKE.Vector2_Multiply__SWIG_1(swigCPtr, rhs), true);
293 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
297 private RelativeVector2 Divide(RelativeVector2 rhs)
299 RelativeVector2 ret = new RelativeVector2(NDalicPINVOKE.Vector2_Divide__SWIG_0(swigCPtr, RelativeVector2.getCPtr(rhs)), true);
300 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
304 private RelativeVector2 Divide(float rhs)
306 RelativeVector2 ret = new RelativeVector2(NDalicPINVOKE.Vector2_Divide__SWIG_1(swigCPtr, rhs), true);
307 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
311 private float ValueOfIndex(uint index)
313 float ret = NDalicPINVOKE.Vector2_ValueOfIndex__SWIG_0(swigCPtr, index);
314 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
319 /// Compares if the rhs is equal to.
321 /// <param name="rhs">The vector to compare.</param>
322 /// <returns>Returns true if the two vectors are equal, otherwise false.</returns>
323 /// <since_tizen> 3 </since_tizen>
324 public bool EqualTo(RelativeVector2 rhs)
326 bool ret = NDalicPINVOKE.Vector2_EqualTo(swigCPtr, RelativeVector2.getCPtr(rhs));
327 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
332 /// Compares if the rhs is not equal to.
334 /// <param name="rhs">The vector to compare.</param>
335 /// <returns>Returns true if the two vectors are not equal, otherwise false.</returns>
336 /// <since_tizen> 3 </since_tizen>
337 public bool NotEqualTo(RelativeVector2 rhs)
339 bool ret = NDalicPINVOKE.Vector2_NotEqualTo(swigCPtr, RelativeVector2.getCPtr(rhs));
340 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
348 /// <since_tizen> 3 </since_tizen>
353 NDalicPINVOKE.Vector2_X_set(swigCPtr, ValueCheck(value));
354 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
358 float ret = NDalicPINVOKE.Vector2_X_get(swigCPtr);
359 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
367 /// <since_tizen> 3 </since_tizen>
372 NDalicPINVOKE.Vector2_Y_set(swigCPtr, ValueCheck(value));
373 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
377 float ret = NDalicPINVOKE.Vector2_Y_get(swigCPtr);
378 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
385 /// <since_tizen> 3 </since_tizen>
386 public static implicit operator Vector2(RelativeVector2 relativeVector2)
388 return new Vector2(relativeVector2.X, relativeVector2.Y);
393 /// <since_tizen> 3 </since_tizen>
394 public static implicit operator RelativeVector2(Vector2 vec)
396 return new RelativeVector2(ValueCheck(vec.X), ValueCheck(vec.Y));
399 internal static RelativeVector2 ValueCheck(RelativeVector2 relativeVector2)
401 if(relativeVector2.X < 0.0f)
403 relativeVector2.X = 0.0f;
404 NUILog.Error( "The value of Result is invalid! Should be between [0, 1].");
406 else if(relativeVector2.X > 1.0f)
408 relativeVector2.X = 1.0f;
409 NUILog.Error( "The value of Result is invalid! Should be between [0, 1].");
411 if(relativeVector2.Y < 0.0f)
413 relativeVector2.Y = 0.0f;
414 NUILog.Error( "The value of Result is invalid! Should be between [0, 1].");
416 else if(relativeVector2.Y > 1.0f)
418 relativeVector2.Y = 1.0f;
419 NUILog.Error( "The value of Result is invalid! Should be between [0, 1].");
421 return relativeVector2;
424 internal static float ValueCheck(float value)
429 NUILog.Error( "The value of Parameters is invalid! Should be between [0, 1].");
431 else if(value > 1.0f)
434 NUILog.Error( "The value of Parameters is invalid! Should be between [0, 1].");