// Copyright (c) Xenko contributors (https://xenko.com) and Silicon Studio Corp. (https://www.siliconstudio.co.jp) // Distributed under the MIT license. See the LICENSE.md file in the project root for more information. // // Copyright (c) 2010-2011 SharpDX - Alexandre Mutel // // 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; using System.Runtime.Serialization; namespace math { /// /// Represents a four dimensional mathematical vector. /// [DataContract( Name = "Int4" )] [DataStyle( DataStyle.Compact )] [StructLayout( LayoutKind.Sequential, Pack = 4 )] public struct Int4 : IEquatable, IFormattable { /// /// The size of the type, in bytes. /// public static readonly int SizeInBytes = lib.Util.SizeOf(); /// /// A with all of its components set to zero. /// public static readonly Int4 Zero = new Int4(); /// /// The X unit (1, 0, 0, 0). /// public static readonly Int4 UnitX = new Int4( 1, 0, 0, 0 ); /// /// The Y unit (0, 1, 0, 0). /// public static readonly Int4 UnitY = new Int4( 0, 1, 0, 0 ); /// /// The Z unit (0, 0, 1, 0). /// public static readonly Int4 UnitZ = new Int4( 0, 0, 1, 0 ); /// /// The W unit (0, 0, 0, 1). /// public static readonly Int4 UnitW = new Int4( 0, 0, 0, 1 ); /// /// A with all of its components set to one. /// public static readonly Int4 One = new Int4( 1, 1, 1, 1 ); /// /// The X component of the vector. /// [DataMember( Order = 0 )] public int X; /// /// The Y component of the vector. /// [DataMember( Order = 1 )] public int Y; /// /// The Z component of the vector. /// [DataMember( Order = 2 )] public int Z; /// /// The W component of the vector. /// [DataMember( Order = 3 )] public int W; /// /// Initializes a new instance of the struct. /// /// The value that will be assigned to all components. public Int4( int value ) { X = value; Y = value; Z = value; W = value; } /// /// Initializes a new instance of the struct. /// /// Initial value for the X component of the vector. /// Initial value for the Y component of the vector. /// Initial value for the Z component of the vector. /// Initial value for the W component of the vector. public Int4( int x, int y, int z, int w ) { X = x; Y = y; Z = z; W = w; } /// /// Initializes a new instance of the struct. /// /// The values to assign to the X, Y, Z, and W components of the vector. This must be an array with four elements. /// Thrown when is null. /// Thrown when contains more or less than four elements. public Int4( int[] values ) { if( values == null ) throw new ArgumentNullException( "values" ); if( values.Length != 4 ) throw new ArgumentOutOfRangeException( "values", "There must be four and only four input values for Int4." ); X = values[0]; Y = values[1]; Z = values[2]; W = values[3]; } /// /// Gets or sets the component at the specified index. /// /// The value of the X, Y, Z, or W component, depending on the index. /// The index of the component to access. Use 0 for the X component, 1 for the Y component, 2 for the Z component, and 3 for the W component. /// The value of the component at the specified index. /// Thrown when the is out of the range [0, 3]. public int this[int index] { get { switch( index ) { case 0: return X; case 1: return Y; case 2: return Z; case 3: return W; } throw new ArgumentOutOfRangeException( "index", "Indices for Int4 run from 0 to 3, inclusive." ); } set { switch( index ) { case 0: X = value; break; case 1: Y = value; break; case 2: Z = value; break; case 3: W = value; break; default: throw new ArgumentOutOfRangeException( "index", "Indices for Int4 run from 0 to 3, inclusive." ); } } } /// /// Calculates the length of the vector. /// /// The length of the vector. /// /// may be preferred when only the relative length is needed /// and speed is of the essence. /// public int Length() { return (int)Math.Sqrt( ( X * X ) + ( Y * Y ) + ( Z * Z ) + ( W * W ) ); } /// /// Calculates the squared length of the vector. /// /// The squared length of the vector. /// /// This method may be preferred to when only a relative length is needed /// and speed is of the essence. /// public int LengthSquared() { return ( X * X ) + ( Y * Y ) + ( Z * Z ) + ( W * W ); } /// /// Creates an array containing the elements of the vector. /// /// A four-element array containing the components of the vector. public int[] ToArray() { return new int[] { X, Y, Z, W }; } /// /// Adds two vectors. /// /// The first vector to add. /// The second vector to add. /// When the method completes, contains the sum of the two vectors. public static void Add( ref Int4 left, ref Int4 right, out Int4 result ) { result = new Int4( left.X + right.X, left.Y + right.Y, left.Z + right.Z, left.W + right.W ); } /// /// Adds two vectors. /// /// The first vector to add. /// The second vector to add. /// The sum of the two vectors. public static Int4 Add( Int4 left, Int4 right ) { return new Int4( left.X + right.X, left.Y + right.Y, left.Z + right.Z, left.W + right.W ); } /// /// Subtracts two vectors. /// /// The first vector to subtract. /// The second vector to subtract. /// When the method completes, contains the difference of the two vectors. public static void Subtract( ref Int4 left, ref Int4 right, out Int4 result ) { result = new Int4( left.X - right.X, left.Y - right.Y, left.Z - right.Z, left.W - right.W ); } /// /// Subtracts two vectors. /// /// The first vector to subtract. /// The second vector to subtract. /// The difference of the two vectors. public static Int4 Subtract( Int4 left, Int4 right ) { return new Int4( left.X - right.X, left.Y - right.Y, left.Z - right.Z, left.W - right.W ); } /// /// Scales a vector by the given value. /// /// The vector to scale. /// The amount by which to scale the vector. /// When the method completes, contains the scaled vector. public static void Multiply( ref Int4 value, int scale, out Int4 result ) { result = new Int4( value.X * scale, value.Y * scale, value.Z * scale, value.W * scale ); } /// /// Scales a vector by the given value. /// /// The vector to scale. /// The amount by which to scale the vector. /// The scaled vector. public static Int4 Multiply( Int4 value, int scale ) { return new Int4( value.X * scale, value.Y * scale, value.Z * scale, value.W * scale ); } /// /// Modulates a vector with another by performing component-wise multiplication. /// /// The first vector to modulate. /// The second vector to modulate. /// When the method completes, contains the modulated vector. public static void Modulate( ref Int4 left, ref Int4 right, out Int4 result ) { result = new Int4( left.X * right.X, left.Y * right.Y, left.Z * right.Z, left.W * right.W ); } /// /// Modulates a vector with another by performing component-wise multiplication. /// /// The first vector to modulate. /// The second vector to modulate. /// The modulated vector. public static Int4 Modulate( Int4 left, Int4 right ) { return new Int4( left.X * right.X, left.Y * right.Y, left.Z * right.Z, left.W * right.W ); } /// /// Scales a vector by the given value. /// /// The vector to scale. /// The amount by which to scale the vector. /// When the method completes, contains the scaled vector. public static void Divide( ref Int4 value, int scale, out Int4 result ) { result = new Int4( value.X / scale, value.Y / scale, value.Z / scale, value.W / scale ); } /// /// Scales a vector by the given value. /// /// The vector to scale. /// The amount by which to scale the vector. /// The scaled vector. public static Int4 Divide( Int4 value, int scale ) { return new Int4( value.X / scale, value.Y / scale, value.Z / scale, value.W / scale ); } /// /// Reverses the direction of a given vector. /// /// The vector to negate. /// When the method completes, contains a vector facing in the opposite direction. public static void Negate( ref Int4 value, out Int4 result ) { result = new Int4( -value.X, -value.Y, -value.Z, -value.W ); } /// /// Reverses the direction of a given vector. /// /// The vector to negate. /// A vector facing in the opposite direction. public static Int4 Negate( Int4 value ) { return new Int4( -value.X, -value.Y, -value.Z, -value.W ); } /// /// Restricts a value to be within a specified range. /// /// The value to clamp. /// The minimum value. /// The maximum value. /// When the method completes, contains the clamped value. public static void Clamp( ref Int4 value, ref Int4 min, ref Int4 max, out Int4 result ) { int x = value.X; x = ( x > max.X ) ? max.X : x; x = ( x < min.X ) ? min.X : x; int y = value.Y; y = ( y > max.Y ) ? max.Y : y; y = ( y < min.Y ) ? min.Y : y; int z = value.Z; z = ( z > max.Z ) ? max.Z : z; z = ( z < min.Z ) ? min.Z : z; int w = value.W; w = ( w > max.W ) ? max.W : w; w = ( w < min.W ) ? min.W : w; result = new Int4( x, y, z, w ); } /// /// Restricts a value to be within a specified range. /// /// The value to clamp. /// The minimum value. /// The maximum value. /// The clamped value. public static Int4 Clamp( Int4 value, Int4 min, Int4 max ) { Int4 result; Clamp( ref value, ref min, ref max, out result ); return result; } /// /// Returns a vector containing the smallest components of the specified vectors. /// /// The first source vector. /// The second source vector. /// When the method completes, contains an new vector composed of the largest components of the source vectors. public static void Max( ref Int4 left, ref Int4 right, out Int4 result ) { result.X = ( left.X > right.X ) ? left.X : right.X; result.Y = ( left.Y > right.Y ) ? left.Y : right.Y; result.Z = ( left.Z > right.Z ) ? left.Z : right.Z; result.W = ( left.W > right.W ) ? left.W : right.W; } /// /// Returns a vector containing the largest components of the specified vectors. /// /// The first source vector. /// The second source vector. /// A vector containing the largest components of the source vectors. public static Int4 Max( Int4 left, Int4 right ) { Int4 result; Max( ref left, ref right, out result ); return result; } /// /// Returns a vector containing the smallest components of the specified vectors. /// /// The first source vector. /// The second source vector. /// When the method completes, contains an new vector composed of the smallest components of the source vectors. public static void Min( ref Int4 left, ref Int4 right, out Int4 result ) { result.X = ( left.X < right.X ) ? left.X : right.X; result.Y = ( left.Y < right.Y ) ? left.Y : right.Y; result.Z = ( left.Z < right.Z ) ? left.Z : right.Z; result.W = ( left.W < right.W ) ? left.W : right.W; } /// /// Returns a vector containing the smallest components of the specified vectors. /// /// The first source vector. /// The second source vector. /// A vector containing the smallest components of the source vectors. public static Int4 Min( Int4 left, Int4 right ) { Int4 result; Min( ref left, ref right, out result ); return result; } /// /// Adds two vectors. /// /// The first vector to add. /// The second vector to add. /// The sum of the two vectors. public static Int4 operator +( Int4 left, Int4 right ) { return new Int4( left.X + right.X, left.Y + right.Y, left.Z + right.Z, left.W + right.W ); } /// /// Assert a vector (return it unchanged). /// /// The vector to assert (unchange). /// The asserted (unchanged) vector. public static Int4 operator +( Int4 value ) { return value; } /// /// Subtracts two vectors. /// /// The first vector to subtract. /// The second vector to subtract. /// The difference of the two vectors. public static Int4 operator -( Int4 left, Int4 right ) { return new Int4( left.X - right.X, left.Y - right.Y, left.Z - right.Z, left.W - right.W ); } /// /// Reverses the direction of a given vector. /// /// The vector to negate. /// A vector facing in the opposite direction. public static Int4 operator -( Int4 value ) { return new Int4( -value.X, -value.Y, -value.Z, -value.W ); } /// /// Scales a vector by the given value. /// /// The vector to scale. /// The amount by which to scale the vector. /// The scaled vector. public static Int4 operator *( int scale, Int4 value ) { return new Int4( value.X * scale, value.Y * scale, value.Z * scale, value.W * scale ); } /// /// Scales a vector by the given value. /// /// The vector to scale. /// The amount by which to scale the vector. /// The scaled vector. public static Int4 operator *( Int4 value, int scale ) { return new Int4( value.X * scale, value.Y * scale, value.Z * scale, value.W * scale ); } /// /// Scales a vector by the given value. /// /// The vector to scale. /// The amount by which to scale the vector. /// The scaled vector. public static Int4 operator /( Int4 value, int scale ) { return new Int4( value.X / scale, value.Y / scale, value.Z / scale, value.W / scale ); } /// /// Tests for equality between two objects. /// /// The first value to compare. /// The second value to compare. /// true if has the same value as ; otherwise, false. public static bool operator ==( Int4 left, Int4 right ) { return left.Equals( right ); } /// /// Tests for inequality between two objects. /// /// The first value to compare. /// The second value to compare. /// true if has a different value than ; otherwise, false. public static bool operator !=( Int4 left, Int4 right ) { return !left.Equals( right ); } /// /// Performs an explicit conversion from to . /// /// The value. /// The result of the conversion. public static explicit operator Vec2( Int4 value ) { return new Vec2( value.X, value.Y ); } /// /// Performs an explicit conversion from to . /// /// The value. /// The result of the conversion. public static explicit operator Vec3( Int4 value ) { return new Vec3( value.X, value.Y, value.Z ); } /// /// Performs an explicit conversion from to . /// /// The value. /// The result of the conversion. public static explicit operator Vec4( Int4 value ) { return new Vec4( value.X, value.Y, value.Z, value.W ); } /// /// Returns a that represents this instance. /// /// /// A that represents this instance. /// public override string ToString() { return string.Format( CultureInfo.CurrentCulture, "X:{0} Y:{1} Z:{2} W:{3}", X, Y, Z, W ); } /// /// Returns a that represents this instance. /// /// The format. /// /// A that represents this instance. /// public string ToString( string format ) { if( format == null ) return ToString(); return string.Format( CultureInfo.CurrentCulture, "X:{0} Y:{1} Z:{2} W:{3}", X.ToString( format, CultureInfo.CurrentCulture ), Y.ToString( format, CultureInfo.CurrentCulture ), Z.ToString( format, CultureInfo.CurrentCulture ), W.ToString( format, CultureInfo.CurrentCulture ) ); } /// /// Returns a that represents this instance. /// /// The format provider. /// /// A that represents this instance. /// public string ToString( IFormatProvider formatProvider ) { return string.Format( formatProvider, "X:{0} Y:{1} Z:{2} W:{3}", X, Y, Z, W ); } /// /// Returns a that represents this instance. /// /// The format. /// The format provider. /// /// A that represents this instance. /// public string ToString( string format, IFormatProvider formatProvider ) { if( format == null ) ToString( formatProvider ); return string.Format( formatProvider, "X:{0} Y:{1} Z:{2} W:{3}", X.ToString( format, formatProvider ), Y.ToString( format, formatProvider ), Z.ToString( format, formatProvider ), W.ToString( format, formatProvider ) ); } /// /// Returns a hash code for this instance. /// /// /// A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. /// public override int GetHashCode() { return X.GetHashCode() + Y.GetHashCode() + Z.GetHashCode() + W.GetHashCode(); } /// /// Determines whether the specified is equal to this instance. /// /// The to compare with this instance. /// /// true if the specified is equal to this instance; otherwise, false. /// public bool Equals( Int4 other ) { return other.X == X && other.Y == Y && other.Z == Z && other.W == W; } /// /// Determines whether the specified is equal to this instance. /// /// The to compare with this instance. /// /// true if the specified is equal to this instance; otherwise, false. /// public override bool Equals( object value ) { if( value == null ) return false; if( value.GetType() != GetType() ) return false; return Equals( (Int4)value ); } /// /// Performs an implicit conversion from array to . /// /// The input. /// The result of the conversion. public static implicit operator Int4( int[] input ) { return new Int4( input ); } /// /// Performs an implicit conversion from to array. /// /// The input. /// The result of the conversion. public static implicit operator int[]( Int4 input ) { return input.ToArray(); } } }