A 2D vector representing Cartesian coordinates.
Vec2() → Vec2Vec2() → Vec2
Vec2(value: float) → Vec2Vec2(value: float) → Vec2
Vec2(x: float, y: float) → Vec2Vec2(x: float, y: float) → Vec2
A 2D vector representing Cartesian coordinates.
| Name | Description | Type |
|---|---|---|
DOWN | Vec2(0.0, 1.0) | Vec2 |
LEFT | Vec2(-1.0, 0.0) | Vec2 |
RIGHT | Vec2(1.0, 0.0) | Vec2 |
UP | Vec2(0.0, -1.0) | Vec2 |
ZERO | Vec2(0.0, 0.0) | Vec2 |
angle | Return the vector angle in radians. | float |
length | Return the magnitude of this Vec2. | float |
length_squared | Return the squared magnitude of this Vec2. | float |
x | The x component of the vector. | float |
xx | Return a Vec2 with both components set to x. | Vec2 |
xy | Access or assign the (x, y) components as a Vec2. | Vec2 |
y | The y component of the vector. | float |
yx | Access or assign the (y, x) components as a Vec2. | Vec2 |
yy | Return a Vec2 with both components set to y. | Vec2 |
as_ints() → tuple[int, int]as_ints() → tuple[int, int]Return the vector components truncated to integers as a tuple.
Returns
tuple[int, int] : The (x, y) components as integers.
ceil() → Noneceil() → NoneCeil both components of this Vec2 in-place.
ceiled() → Vec2ceiled() → Vec2Return a new Vec2 with both components ceiled to the nearest integer.
Returns
Vec2 : A new vector with ceiled components.
copy() → Vec2copy() → Vec2Return a copy of this Vec2.
Returns
Vec2 : A duplicated vector with the same components.
distance_squared_to(other: Vec2) → floatdistance_squared_to(other: Vec2) → floatCompute the squared distance to another Vec2.
Args
other : Comparison vector.Returns
float : Squared distance between the vectors.
distance_to(other: Vec2) → floatdistance_to(other: Vec2) → floatCompute the Euclidean distance to another Vec2.
Args
other : Comparison vector.Returns
float : Distance between the vectors.
floor() → Nonefloor() → NoneFloor both components of this Vec2 in-place.
floored() → Vec2floored() → Vec2Return a new Vec2 with both components floored to the nearest integer.
Returns
Vec2 : A new vector with floored components.
is_zero(tolerance: float = 1e-08) → boolis_zero(tolerance: float = 1e-08) → boolDetermine whether this Vec2 is effectively zero.
Args
tolerance : Largest allowed absolute component magnitude.Returns
bool : True if both components are within the tolerance.
move_toward(target: Vec2, delta: float) → Nonemove_toward(target: Vec2, delta: float) → NoneMove this Vec2 toward a target Vec2 by a specified delta.
Args
target : The target vector to move towards.delta : The maximum distance to move.moved_toward(target: Vec2, delta: float) → Vec2moved_toward(target: Vec2, delta: float) → Vec2Return a new Vec2 moved toward a target Vec2 by a specified delta.
Args
target : The target vector to move towards.delta : The maximum distance to move.Returns
Vec2 : A new vector moved toward the target.
normalize() → Nonenormalize() → NoneNormalize this Vec2 in place.
normalized() → Vec2normalized() → Vec2Return a new normalized Vec2.
Returns
Vec2 : A new vector with unit length.
project(other: Vec2) → Vec2project(other: Vec2) → Vec2Project this Vec2 onto another Vec2.
Args
other : The vector to project onto.Returns
Vec2 : Projection of this vector onto the other vector.
reflect(other: Vec2) → Vec2reflect(other: Vec2) → Vec2Reflect this Vec2 across another Vec2.
Args
other : The vector used as the reflection normal.Returns
Vec2 : Reflected vector.
reject(other: Vec2) → Vec2reject(other: Vec2) → Vec2Compute the rejection of this Vec2 from another Vec2.
Args
other : The vector defining the projection axis.Returns
Vec2 : Component of this vector orthogonal to the other vector.
rotate(radians: float) → Nonerotate(radians: float) → NoneRotate this Vec2 in place.
Args
radians : Rotation angle in radians.rotated(radians: float) → Vec2rotated(radians: float) → Vec2Return a new Vec2 rotated by a specified angle.
Args
radians : Rotation angle in radians.Returns
Vec2 : A new vector rotated by the given angle.
round() → Noneround() → NoneRound both components of this Vec2 in-place.
rounded() → Vec2rounded() → Vec2Return a new Vec2 with both components rounded to the nearest integer.
Returns
Vec2 : A new vector with rounded components.
scale_to_length(length: float) → Nonescale_to_length(length: float) → NoneScale this Vec2 to a specific magnitude.
Args
length : Target vector length.scaled_to_length(length: float) → Vec2scaled_to_length(length: float) → Vec2Return a new Vec2 scaled to a specific magnitude.
Args
length : Target vector length.Returns
Vec2 : A new vector scaled to the specified length.
slid(normal: Vec2) → Vec2slid(normal: Vec2) → Vec2Return a new Vec2 slid along a surface defined by a normal vector.
Args
normal : The normal vector defining the surface.Returns
Vec2 : A new vector slid along the surface.
slide(normal: Vec2) → Noneslide(normal: Vec2) → NoneSlide this Vec2 along a surface defined by a normal vector.
Args
normal : The normal vector defining the surface.Returns
Vec2 : A new vector slid along the surface.
to_polar() → PolarCoordinateto_polar() → PolarCoordinateConvert this Vec2 to polar coordinates.
Returns
PolarCoordinate : Polar representation with angle and length.