pyunity.values.vector module

pyunity.values.vector.clamp(x, _min, _max)

class pyunity.values.vector.Vector

Bases: object

abs()

length()

class pyunity.values.vector.Vector2(x_or_list=None, y=None)

Bases: pyunity.values.vector.Vector

copy()

Makes a copy of the Vector2

get_length_sqrd()

Gets the length of the vector squared. This is much faster than finding the length.

Returns:The length of the vector squared Return type:float

length

Gets or sets the magnitude of the vector

normalized()

Get a normalized copy of the vector, or Vector2(0, 0) if the length is 0.

Returns:A normalized vector Return type:Vector2

normalize()

Normalize the vector in place.

normalize_return_length()

Normalize the vector and return its length before the normalization

Returns:The length before the normalization Return type:float

get_distance(other)

The distance between this vector and the other vector

Returns:The distance Return type:float

get_dist_sqrd(other)

The distance between this vector and the other vector, squared. It is more efficient to call this than to call get_distance and square it.

Returns:The squared distance Return type:float

int_tuple

Return the x, y and z values of this vector as ints

rounded

Return the x, y and z values of this vector rounded to the nearest integer

clamp(min, max)

Clamps a vector between two other vectors, resulting in the vector being as close to the edge of a bounding box created as possible.

Parameters:

• min (Vector2) – Min vector
• max (Vector2) – Max vector

dot(other)

Dot product of two vectors.

Parameters:other (Vector2) – Other vector Returns:Dot product of the two vectors Return type:float

cross(other)

Cross product of two vectors. In 2D this is a scalar.

Parameters:other (Vector2) – Other vector Returns:Cross product of the two vectors Return type:float

static min(a, b)

static max(a, b)

static zero()

A vector of zero length

static one()

A vector of ones

static left()

Vector2 pointing in the negative x axis

static right()

Vector2 pointing in the postive x axis

static up()

Vector2 pointing in the postive y axis

static down()

Vector2 pointing in the negative y axis

class pyunity.values.vector.Vector3(x_or_list=None, y=None, z=None)

Bases: pyunity.values.vector.Vector

copy()

Makes a copy of the Vector3

Returns:A shallow copy of the vector Return type:Vector3

get_length_sqrd()

Gets the length of the vector squared. This is much faster than finding the length.

Returns:The length of the vector squared Return type:float

length

Gets or sets the magnitude of the vector

normalized()

Get a normalized copy of the vector, or Vector3(0, 0, 0) if the length is 0.

Returns:A normalized vector Return type:Vector3

normalize()

Normalize the vector in place.

normalize_return_length()

Normalize the vector and return its length before the normalization

Returns:The length before the normalization Return type:float

get_distance(other)

The distance between this vector and the other vector

Returns:The distance Return type:float

get_dist_sqrd(other)

The distance between this vector and the other vector, squared. It is more efficient to call this than to call get_distance and square it.

Returns:The squared distance Return type:float

int_tuple

Return the x, y and z values of this vector as ints

rounded

Return the x, y and z values of this vector rounded to the nearest integer

clamp(min, max)

Clamps a vector between two other vectors, resulting in the vector being as close to the edge of a bounding box created as possible.

Parameters:

• min (Vector3) – Min vector
• max (Vector3) – Max vector

dot(other)

Dot product of two vectors.

Parameters:other (Vector3) – Other vector Returns:Dot product of the two vectors Return type:float

cross(other)

Cross product of two vectors

Parameters:other (Vector3) – Other vector Returns:Cross product of the two vectors Return type:Vector3

static min(a, b)

static max(a, b)

static zero()

A vector of zero length

static one()

A vector of ones

static forward()

Vector3 pointing in the positive z axis

static back()

Vector3 pointing in the negative z axis

static left()

Vector3 pointing in the negative x axis

static right()

Vector3 pointing in the postive x axis

static up()

Vector3 pointing in the postive y axis

static down()

Vector3 pointing in the negative y axis