Class Int3

Source/Engine/Core/Math/Int3.cs:13–1064

Represents a three dimensional mathematical vector (signed integers).

    /// Represents a three dimensional mathematical vector (signed integers).
    /// </summary>
    [Serializable]
#if FLAX_EDITOR
    [System.ComponentModel.TypeConverter(typeof(TypeConverters.Int3Converter))]
#endif
    partial struct Int3 : IEquatable<Int3>, IFormattable, Json.ICustomValueEquals
    {
        private static readonly string _formatString = "X:{0} Y:{1} Z:{2}";

        /// <summary>
        /// The size of the <see cref="Int3" /> type, in bytes.
        /// </summary>
        public static readonly int SizeInBytes = Marshal.SizeOf(typeof(Int3));

        /// <summary>
        /// A <see cref="Int3" /> with all of its components set to zero.
        /// </summary>
        public static readonly Int3 Zero;

        /// <summary>
        /// The X unit <see cref="Int3" /> (1, 0, 0).
        /// </summary>
        public static readonly Int3 UnitX = new Int3(1, 0, 0);

        /// <summary>
        /// The Y unit <see cref="Int3" /> (0, 1, 0).
        /// </summary>
        public static readonly Int3 UnitY = new Int3(0, 1, 0);

        /// <summary>
        /// The Z unit <see cref="Int3" /> (0, 0, 1).
        /// </summary>
        public static readonly Int3 UnitZ = new Int3(0, 0, 1);

        /// <summary>
        /// A <see cref="Int3" /> with all of its components set to one.
        /// </summary>
        public static readonly Int3 One = new Int3(1, 1, 1);

        /// <summary>
        /// A <see cref="Int3" /> with all components equal to <see cref="int.MinValue"/>.
        /// </summary>
        public static readonly Int3 Minimum = new Int3(int.MinValue);

        /// <summary>
        /// A <see cref="Int3" /> with all components equal to <see cref="int.MaxValue"/>.
        /// </summary>
        public static readonly Int3 Maximum = new Int3(int.MaxValue);

        /// <summary>
        /// Initializes a new instance of the <see cref="Int3" /> struct.
        /// </summary>
        /// <param name="value">The value that will be assigned to all components.</param>
        public Int3(int value)
        {
            X = value;
            Y = value;
            Z = value;
        }