struct SF::Vector3(T)
- SF::Vector3(T)
- Struct
- Value
- Object
Overview
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)
isSF::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
.
Included Modules
- Enumerable(T)
Defined in:
system/system.crConstructors
-
.new(x : T, y : T, z : T)
Construct the vector from its coordinates.
-
.new
Default constructor: equivalent to
.new(0, 0, 0)
Instance Method Summary
-
#*(n : Number)
Memberwise multiplication by a scalar
-
#+(other)
Memberwise addition of two vectors
-
#-(other)
Memberwise subtraction of two vectors
-
#-
Memberwise opposite of the vector
-
#/(n : Number)
Memberwise division by a scalar
-
#==(other : Vector3)
Returns true if all corresponding coordinates of two vectors are equal
- #[](i)
- #each(&)
-
#size
Returns
3
-
#x : T
The x coordinate
-
#x=(x : T)
The x coordinate
-
#y : T
The y coordinate
-
#y=(y : T)
The y coordinate
-
#z : T
The z coordinate
-
#z=(z : T)
The z coordinate
Constructor Detail
Instance Method Detail
Returns true if all corresponding coordinates of two vectors are equal