Vector3i (Nu)

Vector3i Type

Namespace: System.Numerics
Assembly: Nu.Math.dll
Base Type: ValueType
All Interfaces: IEquatable<Vector3i> , IComparable<Vector3i> , IComparable
Kind: Struct

Represents a 3D vector using three 32-bit integer numbers.

The Vector3i structure is suitable for interoperation with unmanaged code requiring three consecutive integers.

Constructors

Constructor	Description
`Vector3i(value)` Full Usage: `Vector3i(value)` Parameters: value : `int` - The value that will initialize this instance.	Initializes a new instance of the Vector3i struct. value : `int` The value that will initialize this instance.
`Vector3i(x, y, z)` Full Usage: `Vector3i(x, y, z)` Parameters: x : `int` - The x component of the Vector3. y : `int` - The y component of the Vector3. z : `int` - The z component of the Vector3.	Initializes a new instance of the Vector3i struct. x : `int` The x component of the Vector3. y : `int` The y component of the Vector3. z : `int` The z component of the Vector3.

Instance members

Instance member Description


                
                  
                    
                      this.CompareTo

Full Usage: this.CompareTo

Parameters:

other : Vector3i

Returns: int
Modifiers: abstract

other : Vector3i

Returns: int


                
                  
                    
                      this.CompareTo

Full Usage: this.CompareTo

Parameters:

obj : obj

Returns: int
Modifiers: abstract

obj : obj

Returns: int


                
                  
                    
                      this.Equals

Full Usage: this.Equals

Parameters:

obj : obj - The object to compare to.

Returns: bool True if the instances are equal; false otherwise.
Modifiers: abstract

Indicates whether this instance and a specified object are equal.

obj : obj: The object to compare to.

Returns: bool: True if the instances are equal; false otherwise.


                
                  
                    
                      this.Equals

Full Usage: this.Equals

Parameters:

other : Vector3i - A vector to compare with this vector.

Returns: bool true if the current vector is equal to the vector parameter; otherwise, false.
Modifiers: abstract

Indicates whether the current vector is equal to another vector.

other : Vector3i: A vector to compare with this vector.

Returns: bool: true if the current vector is equal to the vector parameter; otherwise, false.


                
                  
                    
                      this.GetHashCode

Full Usage: this.GetHashCode

Returns: int A System.Int32 containing the unique hashcode for this instance.
Modifiers: abstract

Returns the hashcode for this instance.

Returns: int: A System.Int32 containing the unique hashcode for this instance.

Full Usage: this[arg1]

Returns: int

Gets or sets the value at the index of the vector.

Returns: int

IndexOutOfRangeException

Thrown if the index is less than 0 or greater than 2.


                
                  
                    
                      this.ToString

Full Usage: this.ToString

Returns: string
Modifiers: abstract

Returns: string

Static members

Static member	Description
`vec * scale` Full Usage: `vec * scale` Parameters: vec : `Vector3i` - The instance. scale : `int` - The scalar. Returns: `Vector3i` The result of the calculation.	Multiplies an instance by an integer scalar. vec : `Vector3i` The instance. scale : `int` The scalar. Returns: `Vector3i` The result of the calculation.
`scale * vec` Full Usage: `scale * vec` Parameters: scale : `int` - The scalar. vec : `Vector3i` - The instance. Returns: `Vector3i` The result of the calculation.	Multiplies an instance by an integer scalar. scale : `int` The scalar. vec : `Vector3i` The instance. Returns: `Vector3i` The result of the calculation.
`vec * scale` Full Usage: `vec * scale` Parameters: vec : `Vector3i` - Right operand. scale : `Vector3i` - Left operand. Returns: `Vector3i` Result of multiplication.	Component-wise multiplication between the specified instance by a scale vector. vec : `Vector3i` Right operand. scale : `Vector3i` Left operand. Returns: `Vector3i` Result of multiplication.
`left + right` Full Usage: `left + right` Parameters: left : `Vector3i` - The first instance. right : `Vector3i` - The second instance. Returns: `Vector3i` The result of the calculation.	Adds two instances. left : `Vector3i` The first instance. right : `Vector3i` The second instance. Returns: `Vector3i` The result of the calculation.
`left - right` Full Usage: `left - right` Parameters: left : `Vector3i` - The first instance. right : `Vector3i` - The second instance. Returns: `Vector3i` The result of the calculation.	Subtracts two instances. left : `Vector3i` The first instance. right : `Vector3i` The second instance. Returns: `Vector3i` The result of the calculation.
`vec / scale` Full Usage: `vec / scale` Parameters: vec : `Vector3i` - The instance. scale : `int` - The scalar. Returns: `Vector3i` The result of the calculation.	Divides the instance by a scalar using integer division, floor(a/b). vec : `Vector3i` The instance. scale : `int` The scalar. Returns: `Vector3i` The result of the calculation.
`vec / vec2` Full Usage: `vec / vec2` Parameters: vec : `Vector3i` - The instance. vec2 : `Vector3i` - The divisor. Returns: `Vector3i` The result of the calculation.	Divides the instance by another Vector3i using integer division, floor(a/b). vec : `Vector3i` The instance. vec2 : `Vector3i` The divisor. Returns: `Vector3i` The result of the calculation.
`left <> right` Full Usage: `left <> right` Parameters: left : `Vector3i` - The first instance. right : `Vector3i` - The second instance. Returns: `bool` True, if left does not equal right; false otherwise.	Compares two instances for inequality. left : `Vector3i` The first instance. right : `Vector3i` The second instance. Returns: `bool` True, if left does not equal right; false otherwise.
`left = right` Full Usage: `left = right` Parameters: left : `Vector3i` - The first instance. right : `Vector3i` - The second instance. Returns: `bool` True, if left equals right; false otherwise.	Compares two instances for equality. left : `Vector3i` The first instance. right : `Vector3i` The second instance. Returns: `bool` True, if left equals right; false otherwise.
`~-vec` Full Usage: `~-vec` Parameters: vec : `Vector3i` - The instance. Returns: `Vector3i` The result of the calculation.	Negates an instance. vec : `Vector3i` The instance. Returns: `Vector3i` The result of the calculation.
`Vector3i.Add(a, b)` Full Usage: `Vector3i.Add(a, b)` Parameters: a : `Vector3i` - Left operand. b : `Vector3i` - Right operand. Returns: `Vector3i` Result of operation.	Adds two vectors. a : `Vector3i` Left operand. b : `Vector3i` Right operand. Returns: `Vector3i` Result of operation.
`Vector3i.Add(a, b, result)` Full Usage: `Vector3i.Add(a, b, result)` Parameters: a : `inref<Vector3i>` - Left operand. b : `inref<Vector3i>` - Right operand. result : `byref<Vector3i>` - Result of operation.	Adds two vectors. a : `inref<Vector3i>` Left operand. b : `inref<Vector3i>` Right operand. result : `byref<Vector3i>` Result of operation.
`Vector3i.Clamp(vec, min, max)` Full Usage: `Vector3i.Clamp(vec, min, max)` Parameters: vec : `Vector3i` - Input vector. min : `Vector3i` - Minimum vector. max : `Vector3i` - Maximum vector. Returns: `Vector3i` The clamped vector.	Clamp a vector to the given minimum and maximum vectors. vec : `Vector3i` Input vector. min : `Vector3i` Minimum vector. max : `Vector3i` Maximum vector. Returns: `Vector3i` The clamped vector.
`Vector3i.Clamp(vec, min, max, result)` Full Usage: `Vector3i.Clamp(vec, min, max, result)` Parameters: vec : `inref<Vector3i>` - Input vector. min : `inref<Vector3i>` - Minimum vector. max : `inref<Vector3i>` - Maximum vector. result : `byref<Vector3i>` - The clamped vector.	Clamp a vector to the given minimum and maximum vectors. vec : `inref<Vector3i>` Input vector. min : `inref<Vector3i>` Minimum vector. max : `inref<Vector3i>` Maximum vector. result : `byref<Vector3i>` The clamped vector.
`Vector3i.ComponentMax(a, b)` Full Usage: `Vector3i.ComponentMax(a, b)` Parameters: a : `Vector3i` - First operand. b : `Vector3i` - Second operand. Returns: `Vector3i` The component-wise maximum.	Returns a vector created from the largest of the corresponding components of the given vectors. a : `Vector3i` First operand. b : `Vector3i` Second operand. Returns: `Vector3i` The component-wise maximum.
`Vector3i.ComponentMax(a, b, result)` Full Usage: `Vector3i.ComponentMax(a, b, result)` Parameters: a : `inref<Vector3i>` - First operand. b : `inref<Vector3i>` - Second operand. result : `byref<Vector3i>` - The component-wise maximum.	Returns a vector created from the largest of the corresponding components of the given vectors. a : `inref<Vector3i>` First operand. b : `inref<Vector3i>` Second operand. result : `byref<Vector3i>` The component-wise maximum.
`Vector3i.ComponentMin(a, b)` Full Usage: `Vector3i.ComponentMin(a, b)` Parameters: a : `Vector3i` - First operand. b : `Vector3i` - Second operand. Returns: `Vector3i` The component-wise minimum.	Returns a vector created from the smallest of the corresponding components of the given vectors. a : `Vector3i` First operand. b : `Vector3i` Second operand. Returns: `Vector3i` The component-wise minimum.
`Vector3i.ComponentMin(a, b, result)` Full Usage: `Vector3i.ComponentMin(a, b, result)` Parameters: a : `inref<Vector3i>` - First operand. b : `inref<Vector3i>` - Second operand. result : `byref<Vector3i>` - The component-wise minimum.	Returns a vector created from the smallest of the corresponding components of the given vectors. a : `inref<Vector3i>` First operand. b : `inref<Vector3i>` Second operand. result : `byref<Vector3i>` The component-wise minimum.
`Vector3i.Divide(vector, scale)` Full Usage: `Vector3i.Divide(vector, scale)` Parameters: vector : `Vector3i` - Left operand. scale : `int` - Right operand. Returns: `Vector3i` Result of the operation.	Divides a vector by a scalar using integer division, floor(a/b). vector : `Vector3i` Left operand. scale : `int` Right operand. Returns: `Vector3i` Result of the operation.
`Vector3i.Divide(vector, scale, result)` Full Usage: `Vector3i.Divide(vector, scale, result)` Parameters: vector : `inref<Vector3i>` - Left operand. scale : `int` - Right operand. result : `byref<Vector3i>` - Result of the operation.	Divides a vector by a scalar using integer division, floor(a/b). vector : `inref<Vector3i>` Left operand. scale : `int` Right operand. result : `byref<Vector3i>` Result of the operation.
`Vector3i.Divide(vector, scale)` Full Usage: `Vector3i.Divide(vector, scale)` Parameters: vector : `Vector3i` - Left operand. scale : `Vector3i` - Right operand. Returns: `Vector3i` Result of the operation.	Divides a vector by the components of a vector using integer division, floor(a/b). vector : `Vector3i` Left operand. scale : `Vector3i` Right operand. Returns: `Vector3i` Result of the operation.
`Vector3i.Divide(vector, scale, result)` Full Usage: `Vector3i.Divide(vector, scale, result)` Parameters: vector : `inref<Vector3i>` - Left operand. scale : `inref<Vector3i>` - Right operand. result : `byref<Vector3i>` - Result of the operation.	Divides a vector by the components of a vector using integer division, floor(a/b). vector : `inref<Vector3i>` Left operand. scale : `inref<Vector3i>` Right operand. result : `byref<Vector3i>` Result of the operation.
`Vector3i.Multiply(vector, scale)` Full Usage: `Vector3i.Multiply(vector, scale)` Parameters: vector : `Vector3i` - Left operand. scale : `int` - Right operand. Returns: `Vector3i` Result of the operation.	Multiplies a vector by a scalar. vector : `Vector3i` Left operand. scale : `int` Right operand. Returns: `Vector3i` Result of the operation.
`Vector3i.Multiply(vector, scale, result)` Full Usage: `Vector3i.Multiply(vector, scale, result)` Parameters: vector : `inref<Vector3i>` - Left operand. scale : `int` - Right operand. result : `byref<Vector3i>` - Result of the operation.	Multiplies a vector by a scalar. vector : `inref<Vector3i>` Left operand. scale : `int` Right operand. result : `byref<Vector3i>` Result of the operation.
`Vector3i.Multiply(vector, scale)` Full Usage: `Vector3i.Multiply(vector, scale)` Parameters: vector : `Vector3i` - Left operand. scale : `Vector3i` - Right operand. Returns: `Vector3i` Result of the operation.	Multiplies a vector by the components a vector (scale). vector : `Vector3i` Left operand. scale : `Vector3i` Right operand. Returns: `Vector3i` Result of the operation.
`Vector3i.Multiply(vector, scale, result)` Full Usage: `Vector3i.Multiply(vector, scale, result)` Parameters: vector : `inref<Vector3i>` - Left operand. scale : `inref<Vector3i>` - Right operand. result : `byref<Vector3i>` - Result of the operation.	Multiplies a vector by the components of a vector (scale). vector : `inref<Vector3i>` Left operand. scale : `inref<Vector3i>` Right operand. result : `byref<Vector3i>` Result of the operation.
`Vector3i.Subtract(a, b)` Full Usage: `Vector3i.Subtract(a, b)` Parameters: a : `Vector3i` - First operand. b : `Vector3i` - Second operand. Returns: `Vector3i` Result of subtraction.	Subtract one vector from another. a : `Vector3i` First operand. b : `Vector3i` Second operand. Returns: `Vector3i` Result of subtraction.
`Vector3i.Subtract(a, b, result)` Full Usage: `Vector3i.Subtract(a, b, result)` Parameters: a : `inref<Vector3i>` - First operand. b : `inref<Vector3i>` - Second operand. result : `byref<Vector3i>` - Result of subtraction.	Subtract one vector from another. a : `inref<Vector3i>` First operand. b : `inref<Vector3i>` Second operand. result : `byref<Vector3i>` Result of subtraction.
`Vector3i.op_Implicit values` Full Usage: `Vector3i.op_Implicit values` Parameters: values : `int * int * int` Returns: `Vector3i`	values : `int * int * int` Returns: `Vector3i`