struct

SF::Vector3(T)

Inherits Enumerable / Struct / Value / Object

Utility generic struct for manipulating 2-dimensional vectors

SF::Vector3 is a simple struct that defines a mathematical vector with three coordinates (x, y and z). It can be used to represent anything that has three dimensions: a size, a point, a velocity, etc.

The generic parameter T is the type of the coordinates. It can be any type that supports arithmetic operations (+, -, /, *) and comparisons (==, !=), for example Int or Float.

You generally don't have to care about the generic form, the most common specialization has a special alias:

  • SF::Vector3(Float32) is SF::Vector3f

The SF::Vector3 struct has a small and simple interface, its x, y, z members can be accessed directly and it contains no mathematical function like dot product, cross product, length, etc.

Note: for 2-dimensional vectors, see SF::Vector2.

Constructors

new(x : T, y : T, z : T)

Construct the vector from its coordinates.

Source
new

Default constructor: equivalent to new(0, 0, 0)

Source

Instance methods

*(n : Number)

Memberwise multiplication by a scalar

Source
+(other)

Memberwise addition of two vectors

Source
-(other)

Memberwise subtraction of two vectors

Source
-

Memberwise opposite of the vector

Source
/(n : Number)

Memberwise division by a scalar

Source
==(other : Vector3)

Returns true if all corresponding coordinates of two vectors are equal

Source
[](i)

Get a coordinate by its index: 0 is x, 1 is y, 2 is z.

Raises IndexError for other indices.

Source
each

Yields x, then y, then z

Source
size

Returns 3

Source
x

The x coordinate

Source
x=(x : T)

The x coordinate

Source
y

The y coordinate

Source
y=(y : T)

The y coordinate

Source
z

The z coordinate

Source
z=(z : T)

The z coordinate

Source