/*
* Copyright(c) 2019 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;
using Tizen.NUI.Binding;
using System.ComponentModel;
namespace Tizen.NUI
{
///
/// The Color class.
///
[Tizen.NUI.Binding.TypeConverter(typeof(ColorTypeConverter))]
public class Color : Disposable, ICloneable
{
///
/// Gets the black colored Color class.
///
/// 3
public static readonly Color Black = new Color(0.0f, 0.0f, 0.0f, 1.0f);
///
/// Gets the white colored Color class.
///
/// 3
public static readonly Color White = new Color(1.0f, 1.0f, 1.0f, 1.0f);
///
/// Gets the red colored Color class.
///
/// 3
public static readonly Color Red = new Color(1.0f, 0.0f, 0.0f, 1.0f);
///
/// Gets the green colored Color class.
///
/// 3
public static readonly Color Green = new Color(0.0f, 1.0f, 0.0f, 1.0f);
///
/// Gets the blue colored Color class.
///
/// 3
public static readonly Color Blue = new Color(0.0f, 0.0f, 1.0f, 1.0f);
///
/// Gets the yellow colored Color class.
///
/// 3
public static readonly Color Yellow = new Color(1.0f, 1.0f, 0.0f, 1.0f);
///
/// Gets the magenta colored Color class.
///
/// 3
public static readonly Color Magenta = new Color(1.0f, 0.0f, 1.0f, 1.0f);
///
/// Gets the cyan colored Color class.
///
/// 3
public static readonly Color Cyan = new Color(0.0f, 1.0f, 1.0f, 1.0f);
///
/// Gets the transparent colored Color class.
///
/// 3
public static readonly Color Transparent = new Color(0.0f, 0.0f, 0.0f, 0.0f);
private readonly bool hashDummy;
///
/// Default constructor
///
/// 3
public Color() : this(Interop.Vector4.new_Vector4__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
///
/// The constructor.
///
/// The red component.
/// The green component.
/// The blue component.
/// The alpha component.
/// 3
public Color(float r, float g, float b, float a) : this(Interop.Vector4.new_Vector4__SWIG_1(ValueCheck(r), ValueCheck(g), ValueCheck(b), ValueCheck(a)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
///
/// The conversion constructor from an array of four floats.
///
/// array Array of R,G,B,A.
/// 3
public Color(float[] array) : this(Interop.Vector4.new_Vector4__SWIG_2(ValueCheck(array)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
///
/// The conversion constructor from an hexcode of four floats.
///
/// Hex color code
/// This exception is thrown when hexColor is null.
/// 6
/// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
public Color(string hexColor) : this(Interop.Vector4.new_Vector4__SWIG_0(), true)
{
try
{
if (null == hexColor)
{
throw new ArgumentNullException(nameof(hexColor));
}
hexColor = hexColor.Replace("#", "");
R = ((float)Convert.ToInt32(hexColor.Substring(0, 2), 16)) / 255.0f;
G = ((float)Convert.ToInt32(hexColor.Substring(2, 2), 16)) / 255.0f;
B = ((float)Convert.ToInt32(hexColor.Substring(4, 2), 16)) / 255.0f;
A = hexColor.Length > 6 ? ((float)Convert.ToInt32(hexColor.Substring(6, 2), 16)) / 255.0f : 1.0f;
}
catch
{
throw new global::System.ArgumentException("Please check your hex code");
}
}
///
/// The conversion constructor from an System.Drawing.Color instance.
///
/// System.Drawing.Color instance
[EditorBrowsable(EditorBrowsableState.Never)]
public Color(global::System.Drawing.Color color) : this(Interop.Vector4.new_Vector4__SWIG_0(), true)
{
R = color.R / 255.0f;
G = color.G / 255.0f;
B = color.B / 255.0f;
A = color.A / 255.0f;
}
///
/// The copy constructor.
///
/// The copy target.
[EditorBrowsable(EditorBrowsableState.Never)]
public Color(Color other) : this((float)other?.R, (float)other.G, (float)other.B, (float)other.A)
{
}
internal Color(global::System.IntPtr cPtr, bool cMemoryOwn) : base(cPtr, cMemoryOwn)
{
hashDummy = false;
}
internal Color(ColorChangedCallback cb, float r, float g, float b, float a) : this(Interop.Vector4.new_Vector4__SWIG_1(ValueCheck(r), ValueCheck(g), ValueCheck(b), ValueCheck(a)), true)
{
callback = cb;
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
internal Color(ColorChangedCallback cb, Color other) : this(cb, other.R, other.G, other.B, other.A)
{
}
internal delegate void ColorChangedCallback(float r, float g, float b, float a);
private ColorChangedCallback callback = null;
///
/// The red component.
///
/// 3
[Obsolete("Please do not use this setter, Deprecated in API8, will be removed in API10. please use new Color(...) constructor")]
public float R
{
set
{
Tizen.Log.Fatal("NUI", "Please do not use this setter, Deprecated in API8, will be removed in API10. please use new Color(...) constructor");
Interop.Vector4.Vector4_r_set(swigCPtr, ValueCheck(value));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
callback?.Invoke(R, G, B, A);
}
get
{
float ret = Interop.Vector4.Vector4_r_get(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
}
///
/// The green component.
///
/// 3
[Obsolete("Please do not use this setter, Deprecated in API8, will be removed in API10. please use new Color(...) constructor")]
public float G
{
set
{
Tizen.Log.Fatal("NUI", "Please do not use this setter, Deprecated in API8, will be removed in API10. please use new Color(...) constructor");
Interop.Vector4.Vector4_g_set(swigCPtr, ValueCheck(value));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
callback?.Invoke(R, G, B, A);
}
get
{
float ret = Interop.Vector4.Vector4_g_get(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
}
///
/// The blue component.
///
/// 3
[Obsolete("Please do not use this setter, Deprecated in API8, will be removed in API10. please use new Color(...) constructor")]
public float B
{
set
{
Tizen.Log.Fatal("NUI", "Please do not use this setter, Deprecated in API8, will be removed in API10. please use new Color(...) constructor");
Interop.Vector4.Vector4_b_set(swigCPtr, ValueCheck(value));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
callback?.Invoke(R, G, B, A);
}
get
{
float ret = Interop.Vector4.Vector4_b_get(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
}
///
/// The alpha component.
///
/// 3
[Obsolete("Please do not use this setter, Deprecated in API8, will be removed in API10. please use new Color(...) constructor")]
public float A
{
set
{
Tizen.Log.Fatal("NUI", "Please do not use this setter, Deprecated in API8, will be removed in API10. please use new Color(...) constructor");
Interop.Vector4.Vector4_a_set(swigCPtr, ValueCheck(value));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
callback?.Invoke(R, G, B, A);
}
get
{
float ret = Interop.Vector4.Vector4_a_get(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
}
///
/// The array subscript operator overload.
///
/// The subscript index.
/// The float at the given index.
/// 3
public float this[uint index]
{
get
{
return ValueOfIndex(index);
}
}
///
/// Converts the Color class to Vector4 class implicitly.
///
/// A color to be converted to Vector4
/// 3
public static implicit operator Vector4(Color color)
{
return new Vector4((float)color?.R, (float)color.G, (float)color.B, (float)color.A);
}
///
/// Converts Vector4 class to Color class implicitly.
///
/// A Vector4 to be converted to color.
/// 3
public static implicit operator Color(Vector4 vec)
{
return new Color((float)vec?.R, (float)vec.G, (float)vec.B, (float)vec.A);
}
///
/// The addition operator.
///
/// The first value.
/// The second value.
/// The color containing the result of the addition.
/// Thrown when arg1 is null.
/// 3
public static Color operator +(Color arg1, Color arg2)
{
if (null == arg1)
{
throw new ArgumentNullException(nameof(arg1));
}
Color result = arg1.Add(arg2);
return ValueCheck(result);
}
///
/// The subtraction operator.
///
/// The first value.
/// The second value.
/// The color containing the result of the subtraction.
/// Thrown when arg1 is null.
/// 3
public static Color operator -(Color arg1, Color arg2)
{
if (null == arg1)
{
throw new ArgumentNullException(nameof(arg1));
}
Color result = arg1.Subtract(arg2);
return ValueCheck(result);
}
///
/// The unary negation operator.
///
/// The target value.
/// The color containg the negation.
/// Thrown when arg1 is null.
/// 3
public static Color operator -(Color arg1)
{
if (null == arg1)
{
throw new ArgumentNullException(nameof(arg1));
}
Color result = arg1.Subtract();
return ValueCheck(result);
}
///
/// The multiplication operator.
///
/// The first value.
/// The second value.
/// The color containing the result of the multiplication.
/// Thrown when arg1 is null.
/// 3
public static Color operator *(Color arg1, Color arg2)
{
if (null == arg1)
{
throw new ArgumentNullException(nameof(arg1));
}
Color result = arg1.Multiply(arg2);
return ValueCheck(result);
}
///
/// The multiplication operator.
///
/// The first value.
/// The second value.
/// The color containing the result of the multiplication.
/// Thrown when arg1 is null.
/// 3
public static Color operator *(Color arg1, float arg2)
{
if (null == arg1)
{
throw new ArgumentNullException(nameof(arg1));
}
Color result = arg1.Multiply(arg2);
return ValueCheck(result);
}
///
/// The division operator.
///
/// The first value.
/// The second value.
/// The color containing the result of the division.
/// Thrown when arg1 is null.
/// 3
public static Color operator /(Color arg1, Color arg2)
{
if (null == arg1)
{
throw new ArgumentNullException(nameof(arg1));
}
Color result = arg1.Divide(arg2);
return ValueCheck(result);
}
///
/// The division operator.
///
/// The first value.
/// The second value.
/// The color containing the result of the division.
/// Thrown when arg1 is null.
/// 3
public static Color operator /(Color arg1, float arg2)
{
if (null == arg1)
{
throw new ArgumentNullException(nameof(arg1));
}
Color result = arg1.Divide(arg2);
return ValueCheck(result);
}
///
/// Checks if two color classes are same.
///
/// A color to be compared.
/// If two colors are are same, then true.
/// 3
public bool EqualTo(Color rhs)
{
bool ret = Interop.Vector4.Vector4_EqualTo(swigCPtr, Color.getCPtr(rhs));
if (rhs == null) return false;
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
///
/// Checks if two color classes are different.
///
/// A color to be compared.
/// If two colors are are different, then true.
/// 3
public bool NotEqualTo(Color rhs)
{
bool ret = Interop.Vector4.Vector4_NotEqualTo(swigCPtr, Color.getCPtr(rhs));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
///
[EditorBrowsable(EditorBrowsableState.Never)]
public object Clone() => new Color(this);
internal static global::System.Runtime.InteropServices.HandleRef getCPtr(Color obj)
{
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
internal static Color GetColorFromPtr(global::System.IntPtr cPtr)
{
Color ret = new Color(cPtr, false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
internal static Color ValueCheck(Color color)
{
float r = color.R;
float g = color.G;
float b = color.B;
float a = color.A;
if (r < 0.0f)
{
r = 0.0f;
NUILog.Error("The value of Result is invalid! Should be between [0, 1].");
}
else if (r > 1.0f)
{
r = 1.0f;
NUILog.Error("The value of Result is invalid! Should be between [0, 1].");
}
if (g < 0.0f)
{
g = 0.0f;
NUILog.Error("The value of Result is invalid! Should be between [0, 1].");
}
else if (g > 1.0f)
{
g = 1.0f;
NUILog.Error("The value of Result is invalid! Should be between [0, 1].");
}
if (b < 0.0f)
{
b = 0.0f;
NUILog.Error("The value of Result is invalid! Should be between [0, 1].");
}
else if (b > 1.0f)
{
b = 1.0f;
NUILog.Error("The value of Result is invalid! Should be between [0, 1].");
}
if (a < 0.0f)
{
a = 0.0f;
NUILog.Error("The value of Result is invalid! Should be between [0, 1].");
}
else if (a > 1.0f)
{
a = 1.0f;
NUILog.Error("The value of Result is invalid! Should be between [0, 1].");
}
color = new Color(r, g, b, a);
return color;
}
internal static float ValueCheck(float value)
{
if (value < 0.0f)
{
value = 0.0f;
NUILog.Error("The value of Parameters is invalid! Should be between [0, 1].");
}
else if (value > 1.0f)
{
value = 1.0f;
NUILog.Error("The value of Parameters is invalid! Should be between [0, 1].");
}
return value;
}
internal static float[] ValueCheck(float[] arr)
{
if (null == arr)
{
throw new ArgumentNullException(nameof(arr));
}
for (int i = 0; i < arr.Length; i++)
{
if (arr[i] < 0.0f)
{
arr[i] = 0.0f;
NUILog.Error("The value of Parameters is invalid! Should be between [0, 1].");
}
else if (arr[i] > 1.0f)
{
arr[i] = 1.0f;
NUILog.Error("The value of Parameters is invalid! Should be between [0, 1].");
}
}
return arr;
}
/// This will not be public opened.
[EditorBrowsable(EditorBrowsableState.Never)]
protected override void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr)
{
Interop.Vector4.delete_Vector4(swigCPtr);
}
private Color Add(Color rhs)
{
Color ret = new Color(Interop.Vector4.Vector4_Add(swigCPtr, Color.getCPtr(rhs)), true);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
private Color AddAssign(Vector4 rhs)
{
Color ret = new Color(Interop.Vector4.Vector4_AddAssign(swigCPtr, Color.getCPtr(rhs)), false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
private Color Subtract(Color rhs)
{
Color ret = new Color(Interop.Vector4.Vector4_Subtract__SWIG_0(swigCPtr, Color.getCPtr(rhs)), true);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
private Color SubtractAssign(Color rhs)
{
Color ret = new Color(Interop.Vector4.Vector4_SubtractAssign(swigCPtr, Color.getCPtr(rhs)), false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
private Color Multiply(Color rhs)
{
Color ret = new Color(Interop.Vector4.Vector4_Multiply__SWIG_0(swigCPtr, Color.getCPtr(rhs)), true);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
private Color Multiply(float rhs)
{
Color ret = new Color(Interop.Vector4.Vector4_Multiply__SWIG_1(swigCPtr, rhs), true);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
private Color MultiplyAssign(Color rhs)
{
Color ret = new Color(Interop.Vector4.Vector4_MultiplyAssign__SWIG_0(swigCPtr, Color.getCPtr(rhs)), false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
private Color MultiplyAssign(float rhs)
{
Color ret = new Color(Interop.Vector4.Vector4_MultiplyAssign__SWIG_1(swigCPtr, rhs), false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
private Color Divide(Vector4 rhs)
{
Color ret = new Color(Interop.Vector4.Vector4_Divide__SWIG_0(swigCPtr, Color.getCPtr(rhs)), true);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
private Color Divide(float rhs)
{
Color ret = new Color(Interop.Vector4.Vector4_Divide__SWIG_1(swigCPtr, rhs), true);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
private Color DivideAssign(Color rhs)
{
Color ret = new Color(Interop.Vector4.Vector4_DivideAssign__SWIG_0(swigCPtr, Color.getCPtr(rhs)), false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
private Color DivideAssign(float rhs)
{
Color ret = new Color(Interop.Vector4.Vector4_DivideAssign__SWIG_1(swigCPtr, rhs), false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
private Color Subtract()
{
Color ret = new Color(Interop.Vector4.Vector4_Subtract__SWIG_1(swigCPtr), true);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
private static bool EqualsColorValue(float f1, float f2)
{
float EPS = (float)Math.Abs(f1 * .00001);
if (Math.Abs(f1 - f2) <= EPS)
{
return true;
}
else
{
return false;
}
}
private static bool EqualsColor(Color c1, Color c2)
{
return EqualsColorValue(c1.R, c2.R) && EqualsColorValue(c1.G, c2.G)
&& EqualsColorValue(c1.B, c2.B) && EqualsColorValue(c1.A, c2.A);
}
///
/// Determines whether the specified object is equal to the current object.
///
/// The object to compare with the current object.
/// true if the specified object is equal to the current object; otherwise, false.
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
public override bool Equals(System.Object obj)
{
Color color = obj as Color;
bool equal = false;
if (color == null)
{
return equal;
}
if (EqualsColor(this, color))
{
equal = true;
}
return equal;
}
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
public override int GetHashCode()
{
return hashDummy.GetHashCode();
}
private float ValueOfIndex(uint index)
{
float ret = Interop.Vector4.Vector4_ValueOfIndex__SWIG_0(swigCPtr, index);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
}
}