MeshKey.cs

/*
* Copyright (c) 2012 Nicholas Woodfield
* 
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
* 
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
* 
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/

using System;
using System.Globalization;
using System.Runtime.InteropServices;

namespace Assimp {
    /// <summary>
    /// Binds an anim mesh (referenced by an index) to a specific point in time.
    /// </summary>
    [Serializable]
    [StructLayoutAttribute(LayoutKind.Sequential)]
    public struct MeshKey : IEquatable<MeshKey> {
        /// <summary>
        /// The time of this key.
        /// </summary>
        public double Time;

        /// <summary>
        /// Index of the anim mesh that corresponds to this keyframe.
        /// </summary>
        public uint Value;

        /// <summary>
        /// Constructs a new MeshKey.
        /// </summary>
        /// <param name="time">The time of this key.</param>
        /// <param name="index">Index of the anim mesh that corresponds to this keyframe.</param>
        public MeshKey(double time, uint index) {
            Time = time;
            Value = index;
        }

        /// <summary>
        /// Tests equality between two keys.
        /// </summary>
        /// <param name="a">The first key</param>
        /// <param name="b">The second key</param>
        /// <returns>True if the key's indices are the same, false otherwise</returns>
        public static bool operator==(MeshKey a, MeshKey b) {
            return a.Value == b.Value;
        }

        /// <summary>
        /// Tests inequality between two keys.
        /// </summary>
        /// <param name="a">The first key</param>
        /// <param name="b">The second key</param>
        /// <returns>True if the key's indices are not equal, false otherwise.</returns>
        public static bool operator!=(MeshKey a, MeshKey b) {
            return a.Value != b.Value;
        }

        /// <summary>
        /// Tests inequality between two keys.
        /// </summary>
        /// <param name="a">The first key</param>
        /// <param name="b">The second key</param>
        /// <returns>True if the first key's time is less than the second key's.</returns>
        public static bool operator<(MeshKey a, MeshKey b) {
            return a.Time < b.Time;
        }

        /// <summary>
        /// Tests inequality between two keys.
        /// </summary>
        /// <param name="a">The first key</param>
        /// <param name="b">The second key</param>
        /// <returns>True if the first key's time is greater than the second key's.</returns>
        public static bool operator>(MeshKey a, MeshKey b) {
            return a.Time > b.Time;
        }

        /// <summary>
        /// Determines whether the specified <see cref="System.Object"/> is equal to this instance.
        /// </summary>
        /// <param name="obj">The <see cref="System.Object"/> to compare with this instance.</param>
        /// <returns>
        ///   <c>true</c> if the specified <see cref="System.Object"/> is equal to this instance; otherwise, <c>false</c>.
        /// </returns>
        public override bool Equals(object obj) {
            if(obj is MeshKey) {
                return Equals((MeshKey) obj);
            }
            return false;
        }

        /// <summary>
        /// Tests equality between this key and another.
        /// </summary>
        /// <param name="key">Other key to test</param>
        /// <returns>True if their indices are equal</returns>
        public bool Equals(MeshKey key) {
            return Value == key.Value;
        }

        /// <summary>
        /// Returns a hash code for this instance.
        /// </summary>
        /// <returns>
        /// A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. 
        /// </returns>
        public override int GetHashCode() {
            return Value.GetHashCode();
        }

        /// <summary>
        /// Returns a <see cref="System.String"/> that represents this instance.
        /// </summary>
        /// <returns>
        /// A <see cref="System.String"/> that represents this instance.
        /// </returns>
        public override string ToString() {
            CultureInfo info = CultureInfo.CurrentCulture;
            return String.Format(info, "{{Time:{0} Index:{1}}}",
                new Object[] { Time.ToString(info), Value.ToString(info) });
        }
    }
}