Class Vector2

Based on Vector2 class in C#.

Hierarchy

Vector2

Index

Constructors

constructor

Properties

x
y

Accessors

length

Methods

Constructors

constructor

new Vector2(x: number, y: number): Vector2

- Defined in osu-base/src/mathutil/Vector2.ts:15
Parameters
- x: number
- y: number
Returns Vector2

Properties

x

x: number

The x position of the vector.

y

y: number

The y position of the vector.

Accessors

length

get length(): number

- Defined in osu-base/src/mathutil/Vector2.ts:51
The length of the vector.

Returns number

Methods

add

add(vec: Vector2): Vector2

- Defined in osu-base/src/mathutil/Vector2.ts:37
Adds the vector with another vector.

Parameters
- vec: Vector2
Returns Vector2

divide

divide(divideFactor: number): Vector2

- Defined in osu-base/src/mathutil/Vector2.ts:27
Parameters
- divideFactor: number
Returns Vector2

dot

dot(vec: Vector2): number

- Defined in osu-base/src/mathutil/Vector2.ts:58
Performs a dot multiplication with another vector.

Parameters
- vec: Vector2
Returns number

equals

equals(other: Vector2): boolean

- Defined in osu-base/src/mathutil/Vector2.ts:92
Checks whether this vector is equal to another vector.

Parameters
- other: Vector2
  
  The other vector.
Returns boolean

getDistance

getDistance(vec: Vector2): number

- Defined in osu-base/src/mathutil/Vector2.ts:72
Gets the distance between this vector and another vector.

Parameters
- vec: Vector2
Returns number

multiply

multiply(vec: Vector2): Vector2

- Defined in osu-base/src/mathutil/Vector2.ts:23
Multiplies the vector with another vector.

Parameters
- vec: Vector2
Returns Vector2

normalize

normalize(): void

- Defined in osu-base/src/mathutil/Vector2.ts:81
Normalizes the vector.

Returns void

scale

scale(scaleFactor: number): Vector2

- Defined in osu-base/src/mathutil/Vector2.ts:65
Scales the vector.

Parameters
- scaleFactor: number
Returns Vector2

subtract

subtract(vec: Vector2): Vector2

- Defined in osu-base/src/mathutil/Vector2.ts:44
Subtracts the vector with another vector.

Parameters
- vec: Vector2
Returns Vector2

toString

toString(): string

- Defined in osu-base/src/mathutil/Vector2.ts:99
Returns a string representation of the vector.

Returns string

Generated using TypeDoc