# struct Geode::Vector2(T)

## Overview

Vector containing two components. Provides a collection of scalars of the same type.

T is the scalar type.

## Defined in:

geode/vectors/vector2.cr

## Constructor Detail

def self.new(x : T, y : T) #

Creates a vector from its components.

def self.new(components : Tuple(T, T)) #

Creates a vector from its components.

def self.new(array : StaticArray(T, 2)) #

Constructs the vector with pre-existing values.

def self.new(other : CommonVector(T, 2)) #

Copies the contents of another vector.

def self.new(&) #

Constructs the vector by yielding for each component.

The value of each component should be returned from the block. The block will be given the index of each component as an argument.

``Vector2(Int32).new { |i| i * 5 } # => (0, 5)``

## Class Method Detail

def self.[](x : T, y : T) #

Constructs a vector with existing components.

The type of the components is derived from the type of each argument.

``Vector2[1, 2] # => (1, 2)``

def self.[](x, y) #

Constructs a vector with existing components.

The type of the components is specified by the type parameter. Each value is cast to the type T.

``Vector2F[1, 2] # => (1.0, 2.0)``

## Instance Method Detail

def angle : Number #

Computes the rotation of the vector.

Returns the value as radians. The value will be between 0 and 2 pi.

``Vector2[1, 1].angle # => 0.785398163``

def rotate(angle : Number | Angle) : Vector2 #

Computes a new vector from rotating this one.

The angle must be a `Number` in radians or an `Angle`.

``Vector2[1.0, 1.0].rotate(180.degrees) # => (-1.0, -1.0)``

def signed_angle(other : CommonVector(U, 2)) : Number forall U #

Computes the angle between this vector and another.

Returns the value as radians. The value will be between -pi and +pi.

The smallest angle between the vectors is calculated.

Positive values indicate that the other vector can be reached by rotating this vector in a positive direction. On a standard coordinate system, this means rotating counter-clockwise. Negative values indicate the opposite - clockwise rotation.

``````Vector2[1, 1].signed_angle(Vector2[-1, 0]) # => 2.35619449
Vector2[1, 1].signed_angle(Vector2[1, -1]) # => -1.570796327``````

def signed_angle : Number #

Computes the rotation of the vector.

Returns the value as radians. The value will be between -pi and +pi.

``````Vector2[1, 1].signed_angle   # => 0.785398163
Vector2[-1, -1].signed_angle # => -2.35619449``````

def to_column : Matrix2x1(T) #

Converts this vector to a column vector, in other words a matrix with one column.

``````vector = Vector2[1, 2]
vector.to_column # => [[1], [2]]``````

def to_row : Matrix1x2(T) #

Converts this vector to a row vector, in other words a matrix with one row.

``````vector = Vector2[1, 2]
vector.to_row # => [[1, 2]]``````

def tuple : Tuple(T, T) #

Retrieves the components as a tuple.

def x : T #

Retrieves the x component.

def y : T #

Retrieves the y component.