anx.framework/ANX.Framework/CurveKey.cs

using System;

#region License

//
// This file is part of the ANX.Framework created by the "ANX.Framework developer group".
//
// This file is released under the Ms-PL license.
//
//
//
// Microsoft Public License (Ms-PL)
//
// This license governs use of the accompanying software. If you use the software, you accept this license. 
// If you do not accept the license, do not use the software.
//
// 1.Definitions
//   The terms "reproduce," "reproduction," "derivative works," and "distribution" have the same meaning 
//   here as under U.S. copyright law.
//   A "contribution" is the original software, or any additions or changes to the software.
//   A "contributor" is any person that distributes its contribution under this license.
//   "Licensed patents" are a contributor's patent claims that read directly on its contribution.
//
// 2.Grant of Rights
//   (A) Copyright Grant- Subject to the terms of this license, including the license conditions and limitations 
//       in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free copyright license to 
//       reproduce its contribution, prepare derivative works of its contribution, and distribute its contribution
//       or any derivative works that you create.
//   (B) Patent Grant- Subject to the terms of this license, including the license conditions and limitations in 
//       section 3, each contributor grants you a non-exclusive, worldwide, royalty-free license under its licensed
//       patents to make, have made, use, sell, offer for sale, import, and/or otherwise dispose of its contribution 
//       in the software or derivative works of the contribution in the software.
//
// 3.Conditions and Limitations
//   (A) No Trademark License- This license does not grant you rights to use any contributors' name, logo, or trademarks.
//   (B) If you bring a patent claim against any contributor over patents that you claim are infringed by the software, your 
//       patent license from such contributor to the software ends automatically.
//   (C) If you distribute any portion of the software, you must retain all copyright, patent, trademark, and attribution 
//       notices that are present in the software.
//   (D) If you distribute any portion of the software in source code form, you may do so only under this license by including
//       a complete copy of this license with your distribution. If you distribute any portion of the software in compiled or 
//       object code form, you may only do so under a license that complies with this license.
//   (E) The software is licensed "as-is." You bear the risk of using it. The contributors give no express warranties, guarantees,
//       or conditions. You may have additional consumer rights under your local laws which this license cannot change. To the
//       extent permitted under your local laws, the contributors exclude the implied warranties of merchantability, fitness for a 
//       particular purpose and non-infringement.

#endregion // License

namespace ANX.Framework
{
	public class CurveKey : IEquatable<CurveKey>, IComparable<CurveKey>
	{
		#region Public
		public float Position
		{
			get;
			private set;
		}

		public float Value
		{
			get;
			set;
		}

		public float TangentIn
		{
			get;
			set;
		}

		public float TangentOut
		{
			get;
			set;
		}

		public CurveContinuity Continuity
		{
			get;
			set;
		}
		#endregion

		#region Constructor
		public CurveKey(float position, float value)
			: this(position, value, 0f, 0f, CurveContinuity.Smooth)
		{
		}

		public CurveKey(float position, float value, float tangentIn,
			float tangentOut)
			: this(position, value, tangentIn, tangentOut, CurveContinuity.Smooth)
		{
		}

		public CurveKey(float position, float value, float tangentIn,
			float tangentOut, CurveContinuity continuity)
		{
			Position = position;
			Value = value;
			TangentIn = tangentIn;
			TangentOut = tangentOut;
			Continuity = continuity;
		}
		#endregion

		#region Clone
		public CurveKey Clone()
		{
			return new CurveKey(Position, Value, TangentIn, TangentOut, Continuity);
		}
		#endregion

		#region Equals
        public bool Equals(CurveKey other)
        {
            if (other != null)
            {
                return other.Position == Position &&
                    other.Value == Value &&
                    other.TangentIn == TangentIn &&
                    other.TangentOut == TangentOut &&
                    other.Continuity == Continuity;
            }

            return false;
        }

		public override bool Equals(object obj)
		{
			if (obj == null && obj.GetType() == typeof(CurveKey))
			{
                return this == (CurveKey)obj;
			}

			return false;
		}
		#endregion

		#region GetHashCode
		public override int GetHashCode()
		{
			return Position.GetHashCode() + Value.GetHashCode() +
				TangentIn.GetHashCode() + TangentOut.GetHashCode() +
				Continuity.GetHashCode();
		}
		#endregion

		#region Equality
		public static bool operator ==(CurveKey a, CurveKey b)
		{
            if (null == a as Object)
            {
                return null == b as Object;
            }

            if (null == b as Object)
            {
                return null == a as Object;
            }

            return a.Position == b.Position &&
                   a.Value == b.Value &&
                   a.TangentIn == b.TangentIn &&
                   a.TangentOut == b.TangentOut &&
                   a.Continuity == b.Continuity;
        }
		#endregion

		#region Inequality
		public static bool operator !=(CurveKey a, CurveKey b)
		{
            if (null == a as Object)
            {
                return null != b as Object;
            }

            if (null == b as Object)
            {
                return null != a as Object;
            }

			return a.Position != b.Position ||
			  	   a.Value != b.Value ||
				   a.TangentIn != b.TangentIn ||
				   a.TangentOut != b.TangentOut ||
				   a.Continuity != b.Continuity;
		}
		#endregion

		#region CompareTo
		public int CompareTo(CurveKey other)
		{
			if (Position == other.Position)
			{
				return 0;
			}

			return Position >= other.Position ?
				1 :
				-1;
		}
		#endregion
	}
}