View Source Exray.Structs.Vector2 (Exray v0.6.0)

Vector2 TypedStruct. Defines functions for Vector2 from Raymath

Summary

Types

t()

Functions

add(v1, v2)

Add vector and vector or float

angle(v1, v2)

Calculate angle between two vectors

clamp(v, min, max)

Clamp the components of the vector between min and max values specified by the given vectors

clamp_value(v, min, max)

Clamp the magnitude of the vector between two min and max values

distance(v1, v2)

Calculate distance between two vectors

distance_sqr(v1, v2)

Calculate square distance between two vectors

divide(v1, v2)

Divide vector by vector

dot_product(v1, v2)

Calculate two vectors dot product

equals(p, q)

Check whether two given vectors are almost equal.

invert(v)

Invert the given vector. Doesn't quite work as well as Exray.Structs.Vector2.negate/1, though.

length(v)

Calculate vector length

length_sqr(v)

Calculate vector square length

lerp(v1, v2, amount)

Calculate linear interpolation between two vectors

line_angle(start, stop)

Calculate angle defined by a two vectors line

max(v1, v2)

Get max value for each pair of components

min(v1, v2)

Get min value for each pair of components

move_towards(v, target, max_distance)

Move Vector towards target

multiply(v1, v2)

Multiply vector by vector

negate(v)

Negate vector

new(arg1)

new(x, y)

normalize(v)

Normalize provided vector

one()

Vector with components value 1.0f

reflect(v, normal)

Calculate reflected vector to normal

refract(v, n, r)

Compute the direction of a refracted ray

rotate(v, angle)

Rotate vector by angle

scale(v, scale)

Scale vector (multiply by value)

subtract(v1, v2)

Subtract vector by vector or float

transform(v, mat)

Transforms a Vector2 by a given Matrix

zero()

Vector with components value 0.0f

Types

t()

@type t() :: %Exray.Structs.Vector2{x: float(), y: float()}

Functions

add(v1, v2)

@spec add(Exray.Structs.Vector2, Exray.Structs.Vector2) :: Exray.Structs.Vector2

@spec add(Exray.Structs.Vector2, number()) :: Exray.Structs.Vector2

Add vector and vector or float

angle(v1, v2)

@spec angle(Exray.Structs.Vector2, Exray.Structs.Vector2) :: float()

Calculate angle between two vectors

NOTE: Angle is calculated from origin point (0, 0)

clamp(v, min, max)

@spec clamp(Vector, Vector, Vector) :: Vector

Clamp the components of the vector between min and max values specified by the given vectors

clamp_value(v, min, max)

@spec clamp_value(Exray.Structs.Vector2, number(), number()) :: Exray.Structs.Vector2

Clamp the magnitude of the vector between two min and max values

distance(v1, v2)

@spec distance(Exray.Structs.Vector2, Exray.Structs.Vector2) :: float()

Calculate distance between two vectors

distance_sqr(v1, v2)

@spec distance_sqr(Exray.Structs.Vector2, Exray.Structs.Vector2) :: float()

Calculate square distance between two vectors

divide(v1, v2)

@spec divide(Exray.Structs.Vector2, Exray.Structs.Vector2) :: Exray.Structs.Vector2

Divide vector by vector

dot_product(v1, v2)

@spec dot_product(Exray.Structs.Vector2, Exray.Structs.Vector2) :: float()

Calculate two vectors dot product

equals(p, q)

@spec equals(Exray.Structs.Vector2, Exray.Structs.Vector2) :: boolean()

Check whether two given vectors are almost equal.

Very useful given 1.00000001 != 1.0000000003

invert(v)

@spec invert(Exray.Structs.Vector2) :: Exray.Structs.Vector2

Invert the given vector. Doesn't quite work as well as Exray.Structs.Vector2.negate/1, though.

length(v)

@spec length(Exray.Structs.Vector2) :: float()

Calculate vector length

length_sqr(v)

@spec length_sqr(Exray.Structs.Vector2) :: float()

Calculate vector square length

lerp(v1, v2, amount)

@spec lerp(Exray.Structs.Vector2, Exray.Structs.Vector2, number()) ::
  Exray.Structs.Vector2

Calculate linear interpolation between two vectors

line_angle(start, stop)

@spec line_angle(Exray.Structs.Vector2, Exray.Structs.Vector2) :: float()

Calculate angle defined by a two vectors line

NOTE: Parameters need to be normalized

Current implementation should be aligned with glm::angle

max(v1, v2)

@spec max(Exray.Structs.Vector2, Exray.Structs.Vector2) :: Exray.Structs.Vector2

Get max value for each pair of components

min(v1, v2)

@spec min(Exray.Structs.Vector2, Exray.Structs.Vector2) :: Exray.Structs.Vector2

Get min value for each pair of components

move_towards(v, target, max_distance)

@spec move_towards(Exray.Structs.Vector2, Exray.Structs.Vector2, number()) ::
  Exray.Structs.Vector2

Move Vector towards target

multiply(v1, v2)

@spec multiply(Exray.Structs.Vector2, Exray.Structs.Vector2) :: Exray.Structs.Vector2

Multiply vector by vector

negate(v)

@spec negate(Exray.Structs.Vector2) :: Exray.Structs.Vector2

Negate vector

new(arg1)

new(x, y)

normalize(v)

@spec normalize(Exray.Structs.Vector2) :: Exray.Structs.Vector2

Normalize provided vector

one()

@spec one() :: Exray.Structs.Vector2

Vector with components value 1.0f

reflect(v, normal)

@spec reflect(Exray.Structs.Vector2, Exray.Structs.Vector2) :: Exray.Structs.Vector2

Calculate reflected vector to normal

refract(v, n, r)

@spec refract(Exray.Structs.Vector2, Exray.Structs.Vector2, number()) ::
  Exray.Structs.Vector2

Compute the direction of a refracted ray

v: normalized direction of the incoming ray
n: normalized normal vector of the interface of two optical media
r: ratio of the refractive index of the medium from where the ray comes
to the refractive index of the medium on the other side of the surface

rotate(v, angle)

@spec rotate(Exray.Structs.Vector2, number()) :: Exray.Structs.Vector2

Rotate vector by angle

scale(v, scale)

@spec scale(Exray.Structs.Vector2, number()) :: Exray.Structs.Vector2

Scale vector (multiply by value)

subtract(v1, v2)

@spec subtract(Exray.Structs.Vector2, Exray.Structs.Vector2) :: Exray.Structs.Vector2

@spec subtract(Exray.Structs.Vector2, float()) :: Exray.Structs.Vector2

Subtract vector by vector or float

transform(v, mat)

@spec transform(Exray.Structs.Vector2, Matrix) :: Exray.Structs.Vector2

Transforms a Vector2 by a given Matrix

zero()

@spec zero() :: Exray.Structs.Vector2

Vector with components value 0.0f