# Vec3I

## Description

`struct` `Tinman.Core.Math.Vectors.Vec3I`

A three-dimensional vector with 32-bit integer precision.

```/     \
|  X  |
|  Y  |
|  Z  |
\     /```

## Public / Constants

### Zero

`public` `static` `readonly` `attribute` `Zero` → `(Vec3I)`

The zero vector.

## Public / Constructors

### Vec3I

`public` `constructor` `Vec3I` → `(3)`

in : int32

X-coordinate of vector.

in : int32

Y-coordinate of vector.

in : int32

Z-coordinate of vector.

Creates a new instance of Vec3I.

## Public / Methods

`[Pure]`
`public` `method` `Add1` → `(1)`

in : Vec3I

The vector.

returns → Vec3I

The resulting vector.

Adds this vector and the given one.

`[Pure]`
`public` `method` `Add2` → `(3)`

in : int32

X-component of vector.

in : int32

Y-component of vector.

in : int32

Z-component of vector.

returns → Vec3I

The resulting vector.

Adds this vector and the given one.

### Choose

`[Pure]`
`public` `method` `Choose` → `(2)`

idx in : int32

The zero-based component index.

opt : int32 = 0

The value to return if idx in is out of range.

returns → int32

The resulting vector.

Chooses a component of this vector.

### Cross

`[Pure]`
`public` `method` `Cross1` → `(1)`

in : Vec3I

The vector.

returns → Vec3I

The resulting vector.

Computes the cross product between this vector and the given one.

`[Pure]`
`public` `method` `Cross2` → `(3)`

in : int32

X-component of vector.

in : int32

Y-component of vector.

in : int32

Z-component of vector.

returns → Vec3I

The resulting vector.

Computes the cross product between this vector and the given one.

### Dot

`[Pure]`
`public` `method` `Dot1` → `(1)`

in : Vec3I

The vector.

returns → int32

The resulting vector.

Computes the dot product between this vector and the given one.

`[Pure]`
`public` `method` `Dot2` → `(3)`

in : int32

X-component of vector.

in : int32

Y-component of vector.

in : int32

Z-component of vector.

returns → int32

The resulting vector.

Computes the dot product between this vector and the given one.

### Equals

`[Pure]`
`public` `method` `Equals2` → `(3)`

in : int32

X-component of vector.

in : int32

Y-component of vector.

in : int32

Z-component of vector.

returns → bool

`true` if both vectors are equal, `false` if they are not.

Checks if this vector and the given one are equal.

### Max

`[Pure]`
`public` `method` `Max1` → `(1)`

in : Vec3I

The vector.

returns → Vec3I

The resulting vector.

Computes the component-wise maximum of this vector and the given one.

`[Pure]`
`public` `method` `Max2` → `(3)`

in : int32

X-component of vector.

in : int32

Y-component of vector.

in : int32

Z-component of vector.

returns → Vec3I

The resulting vector.

Computes the component-wise maximum of this vector and the given one.

### Min

`[Pure]`
`public` `method` `Min1` → `(1)`

in : Vec3I

The vector.

returns → Vec3I

The resulting vector.

Computes the component-wise minimum of this vector and the given one.

`[Pure]`
`public` `method` `Min2` → `(3)`

in : int32

X-component of vector.

in : int32

Y-component of vector.

in : int32

Z-component of vector.

returns → Vec3I

The resulting vector.

Computes the component-wise minimum of this vector and the given one.

### Mul

`[Pure]`
`public` `method` `Mul1` → `(1)`

in : Vec3I

The vector.

returns → Vec3I

The resulting vector.

Multiplies this vector with the given one.

`[Pure]`
`public` `method` `Mul2` → `(3)`

in : int32

X-component of vector.

in : int32

Y-component of vector.

in : int32

Z-component of vector.

returns → Vec3I

The resulting vector.

Multiplies this vector with the given one.

`[Pure]`
`public` `method` `Mul3` → `(1)`

in : int32

The scalar value.

returns → Vec3I

The resulting vector.

Multiplies this vector with the given scalar value.

### Neg

`[Pure]`
`public` `method` `Neg` → `()`

returns → Vec3I

The resulting vector.

Negates this vector.

### ShiftLeft

`[Pure]`
`public` `method` `ShiftLeft` → `(1)`

in : int32

The shift amount.

returns → Vec3I

The resulting vector.

Performs a left bit shift on each component of this vector.

### ShiftRight

`[Pure]`
`public` `method` `ShiftRight` → `(1)`

in : int32

The shift amount.

returns → Vec3I

The resulting vector.

Performs a right bit shift on each component of this vector.

### Sub

`[Pure]`
`public` `method` `Sub1` → `(1)`

in : Vec3I

The vector.

returns → Vec3I

The resulting vector.

Subtracts the given vector from this one.

`[Pure]`
`public` `method` `Sub2` → `(3)`

in : int32

X-component of vector.

in : int32

Y-component of vector.

in : int32

Z-component of vector.

returns → Vec3I

The resulting vector.

Subtracts the given vector from this one.

## Public / Attributes

### Length

`public` `attribute` `Length` → `(get)`

value : float64

`[>=0]`
The vector length.

Returns the length of this vector.

### LengthSqr

`public` `attribute` `LengthSqr` → `(get)`

value : float64

`[>=0]`
The squared vector length.

Returns the squared length of this vector.

### X

`public` `readonly` `attribute` `X` → `(int32)`

X-coordinate of vector.

### Y

`public` `readonly` `attribute` `Y` → `(int32)`

Y-coordinate of vector.

### Z

`public` `readonly` `attribute` `Z` → `(int32)`

Z-coordinate of vector.

## Serialization

### Serializer

`public` `static` `readonly` `attribute` `Serializer` → `(ITypeSerializerEx<Vec3I>)`

The serialization helper object for values of Vec3I.