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 /// RelativeVector4 is a four-dimensional vector.
24 /// All values (x, y, and z) should be between [0, 1].
26 public class RelativeVector4 : global::System.IDisposable
28 private global::System.Runtime.InteropServices.HandleRef swigCPtr;
32 /// <since_tizen> 3 </since_tizen>
33 protected bool swigCMemOwn;
35 internal RelativeVector4(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(RelativeVector4 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_Vector4(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 RelativeVector4 operator +(RelativeVector4 arg1, RelativeVector4 arg2)
134 RelativeVector4 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 RelativeVector4 operator -(RelativeVector4 arg1, RelativeVector4 arg2)
147 RelativeVector4 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 RelativeVector4 operator *(RelativeVector4 arg1, RelativeVector4 arg2)
160 RelativeVector4 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 RelativeVector4 operator *(RelativeVector4 arg1, float arg2)
173 RelativeVector4 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 RelativeVector4 operator /(RelativeVector4 arg1, RelativeVector4 arg2)
186 RelativeVector4 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 RelativeVector4 operator /(RelativeVector4 arg1, float arg2)
199 RelativeVector4 result = arg1.Divide(arg2);
200 return ValueCheck(result);
205 /// The const array subscript operator overload. Should be 0, 1 3 or 3.
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 RelativeVector4 GetRelativeVector4FromPtr(global::System.IntPtr cPtr)
222 RelativeVector4 ret = new RelativeVector4(cPtr, false);
223 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
231 /// <since_tizen> 3 </since_tizen>
232 public RelativeVector4() : this(NDalicPINVOKE.new_Vector4__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 /// <param name="z">The z component.</param>
243 /// <param name="w">The w component.</param>
244 /// <since_tizen> 3 </since_tizen>
245 public RelativeVector4(float x, float y, float z, float w) : this(NDalicPINVOKE.new_Vector4__SWIG_1(ValueCheck(x), ValueCheck(y),ValueCheck(z), ValueCheck(w)), true)
247 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
253 /// <param name="relativeVector2">The RelativeVector2 to create this vector from.</param>
254 /// <since_tizen> 3 </since_tizen>
255 public RelativeVector4(RelativeVector2 relativeVector2) : this(NDalicPINVOKE.new_Vector4__SWIG_3(RelativeVector2.getCPtr(relativeVector2)), true)
257 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
263 /// <param name="relativeVector3">The RelativeVector3 to create this vector from.</param>
264 /// <since_tizen> 3 </since_tizen>
265 public RelativeVector4(RelativeVector3 relativeVector3) : this(NDalicPINVOKE.new_Vector4__SWIG_4(RelativeVector3.getCPtr(relativeVector3)), true)
267 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
270 private RelativeVector4 Add(RelativeVector4 rhs)
272 RelativeVector4 ret = new RelativeVector4(NDalicPINVOKE.Vector4_Add(swigCPtr, RelativeVector4.getCPtr(rhs)), true);
273 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
277 private RelativeVector4 Subtract(RelativeVector4 rhs)
279 RelativeVector4 ret = new RelativeVector4(NDalicPINVOKE.Vector4_Subtract__SWIG_0(swigCPtr, RelativeVector4.getCPtr(rhs)), true);
280 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
284 private RelativeVector4 Multiply(RelativeVector4 rhs)
286 RelativeVector4 ret = new RelativeVector4(NDalicPINVOKE.Vector4_Multiply__SWIG_0(swigCPtr, RelativeVector4.getCPtr(rhs)), true);
287 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
291 private RelativeVector4 Multiply(float rhs)
293 RelativeVector4 ret = new RelativeVector4(NDalicPINVOKE.Vector4_Multiply__SWIG_1(swigCPtr, rhs), true);
294 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
298 private RelativeVector4 Divide(RelativeVector4 rhs)
300 RelativeVector4 ret = new RelativeVector4(NDalicPINVOKE.Vector4_Divide__SWIG_0(swigCPtr, RelativeVector4.getCPtr(rhs)), true);
301 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
305 private RelativeVector4 Divide(float rhs)
307 RelativeVector4 ret = new RelativeVector4(NDalicPINVOKE.Vector4_Divide__SWIG_1(swigCPtr, rhs), true);
308 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
312 private float ValueOfIndex(uint index)
314 float ret = NDalicPINVOKE.Vector4_ValueOfIndex__SWIG_0(swigCPtr, index);
315 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
320 /// Compares if the rhs is equal to.
322 /// <param name="rhs">The vector to compare.</param>
323 /// <returns>Returns true if the two vectors are equal, otherwise false.</returns>
324 /// <since_tizen> 3 </since_tizen>
325 public bool EqualTo(RelativeVector4 rhs)
327 bool ret = NDalicPINVOKE.Vector4_EqualTo(swigCPtr, RelativeVector4.getCPtr(rhs));
328 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
333 /// Compares if the rhs is not equal to.
335 /// <param name="rhs">The vector to compare.</param>
336 /// <returns>Returns true if the two vectors are not equal, otherwise false.</returns>
337 /// <since_tizen> 3 </since_tizen>
338 public bool NotEqualTo(RelativeVector4 rhs)
340 bool ret = NDalicPINVOKE.Vector4_NotEqualTo(swigCPtr, RelativeVector4.getCPtr(rhs));
341 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
349 /// <since_tizen> 3 </since_tizen>
354 NDalicPINVOKE.Vector4_X_set(swigCPtr, ValueCheck(value));
355 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
359 float ret = NDalicPINVOKE.Vector4_X_get(swigCPtr);
360 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
368 /// <since_tizen> 3 </since_tizen>
373 NDalicPINVOKE.Vector4_Y_set(swigCPtr, ValueCheck(value));
374 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
378 float ret = NDalicPINVOKE.Vector4_Y_get(swigCPtr);
379 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
387 /// <since_tizen> 3 </since_tizen>
392 NDalicPINVOKE.Vector4_Z_set(swigCPtr, ValueCheck(value));
393 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
397 float ret = NDalicPINVOKE.Vector4_Z_get(swigCPtr);
398 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
406 /// <since_tizen> 3 </since_tizen>
411 NDalicPINVOKE.Vector4_W_set(swigCPtr, ValueCheck(value));
412 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
416 float ret = NDalicPINVOKE.Vector4_W_get(swigCPtr);
417 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
424 /// <since_tizen> 3 </since_tizen>
425 public static implicit operator Vector4(RelativeVector4 relativeVector4)
427 return new Vector4(relativeVector4.X, relativeVector4.Y, relativeVector4.Z, relativeVector4.W);
432 /// <since_tizen> 3 </since_tizen>
433 public static implicit operator RelativeVector4(Vector4 vec)
435 return new RelativeVector4(ValueCheck(vec.X), ValueCheck(vec.Y), ValueCheck(vec.Z), ValueCheck(vec.W));
438 internal static RelativeVector4 ValueCheck(RelativeVector4 relativeVector4)
440 if(relativeVector4.X < 0.0f)
442 relativeVector4.X = 0.0f;
443 NUILog.Error( "The value of Result is invalid! Should be between [0, 1].");
445 else if(relativeVector4.X > 1.0f)
447 relativeVector4.X = 1.0f;
448 NUILog.Error( "The value of Result is invalid! Should be between [0, 1].");
450 if(relativeVector4.Y < 0.0f)
452 relativeVector4.Y = 0.0f;
453 NUILog.Error( "The value of Result is invalid! Should be between [0, 1].");
455 else if(relativeVector4.Y > 1.0f)
457 relativeVector4.Y = 1.0f;
458 NUILog.Error( "The value of Result is invalid! Should be between [0, 1].");
460 if(relativeVector4.Z < 0.0f)
462 relativeVector4.Z = 0.0f;
463 NUILog.Error( "The value of Result is invalid! Should be between [0, 1].");
465 else if(relativeVector4.Z > 1.0f)
467 relativeVector4.Z = 1.0f;
468 NUILog.Error( "The value of Result is invalid! Should be between [0, 1].");
470 if(relativeVector4.W < 0.0f)
472 relativeVector4.W = 0.0f;
473 NUILog.Error( "The value of Result is invalid! Should be between [0, 1].");
475 else if(relativeVector4.W > 1.0f)
477 relativeVector4.W = 1.0f;
478 NUILog.Error( "The value of Result is invalid! Should be between [0, 1].");
480 return relativeVector4;
483 internal static float ValueCheck(float value)
488 NUILog.Error( "The value of Parameters is invalid! Should be between [0, 1].");
490 else if(value > 1.0f)
493 NUILog.Error( "The value of Parameters is invalid! Should be between [0, 1].");