vector2¶
class in InfEngine.math
Description¶
A representation of 2D vectors and points.
description
vector2 represents a two-dimensional vector with x and y components. It is used for 2D positions, directions, UV coordinates, and screen-space calculations throughout the engine.
Supports standard arithmetic — add, subtract, multiply, and divide vectors or scale by a scalar. Utility methods provide common operations: magnitude() and sqr_magnitude() for length, normalize() for unit conversion, dot() for projection, distance() for spacing, lerp() for interpolation, and angle() for measuring rotation between directions.
Static constants like vector2.zero, vector2.one, vector2.up, and vector2.right give quick access to frequently used values without constructing new instances.
Properties¶
| Name | Type | Description |
|---|---|---|
| zero | Vector2 |
Shorthand for writing vector2(0, 0). (read-only) |
| one | Vector2 |
Shorthand for writing vector2(1, 1). (read-only) |
| up | Vector2 |
Shorthand for writing vector2(0, 1). (read-only) |
| down | Vector2 |
Shorthand for writing vector2(0, -1). (read-only) |
| left | Vector2 |
Shorthand for writing vector2(-1, 0). (read-only) |
| right | Vector2 |
Shorthand for writing vector2(1, 0). (read-only) |
| positive_infinity | Vector2 |
Shorthand for writing vector2(inf, inf). (read-only) |
| negative_infinity | Vector2 |
Shorthand for writing vector2(-inf, -inf). (read-only) |
properties
Static Methods¶
| Method | Description |
|---|---|
static vector2.angle(a: Vector2, b: Vector2) → float |
Return the unsigned angle in degrees between two vectors. |
static vector2.clamp_magnitude(v: Vector2, max_length: float) → Vector2 |
Return a copy of the vector with its magnitude clamped. |
static vector2.cross(a: Vector2, b: Vector2) → float |
Return the 2D cross product (z-component of 3D cross). |
static vector2.distance(a: Vector2, b: Vector2) → float |
Return the distance between two points. |
static vector2.dot(a: Vector2, b: Vector2) → float |
Return the dot product of two vectors. |
static vector2.lerp(a: Vector2, b: Vector2, t: float) → Vector2 |
Linearly interpolate between two vectors. |
static vector2.lerp_unclamped(a: Vector2, b: Vector2, t: float) → Vector2 |
Linearly interpolate between two vectors without clamping t. |
static vector2.max(a: Vector2, b: Vector2) → Vector2 |
Return a vector made from the largest components of two vectors. |
static vector2.min(a: Vector2, b: Vector2) → Vector2 |
Return a vector made from the smallest components of two vectors. |
static vector2.move_towards(current: Vector2, target: Vector2, max_delta: float) → Vector2 |
Move current towards target by at most max_delta. |
static vector2.normalize(v: Vector2) → Vector2 |
Return the vector with a magnitude of 1. |
static vector2.perpendicular(v: Vector2) → Vector2 |
Return the 2D vector perpendicular to this vector. |
static vector2.reflect(direction: Vector2, normal: Vector2) → Vector2 |
Reflect a vector off the surface defined by a normal. |
static vector2.scale(a: Vector2, b: Vector2) → Vector2 |
Multiply two vectors component-wise. |
static vector2.signed_angle(a: Vector2, b: Vector2) → float |
Return the signed angle in degrees between two vectors. |
static vector2.smooth_damp(current: Vector2, target: Vector2, current_velocity: Vector2, smooth_time: float, max_speed: float, delta_time: float) → Vector2 |
Gradually change a vector towards a desired goal over time. |
static vector2.magnitude(v: Vector2) → float |
Return the length of the vector. |
static vector2.sqr_magnitude(v: Vector2) → float |
Return the squared length of the vector. |
static_methods
Example¶
example
from InfEngine.math import vector2
# Construct vectors
pos = vector2(3.0, 4.0)
target = vector2(10.0, 0.0)
# Arithmetic
offset = vector2(target.x - pos.x, target.y - pos.y)
scaled = vector2(offset.x * 0.5, offset.y * 0.5)
# Length and distance
length = vector2.magnitude(pos) # 5.0
dist = vector2.distance(pos, target)
# Normalize to a unit direction
direction = vector2.normalize(offset)
# Dot product and angle
dot = vector2.dot(pos, target)
angle = vector2.angle(pos, target)
# Smooth interpolation between two points
mid = vector2.lerp(pos, target, 0.5)
See Also¶
see_also