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): <internal>.Vector2

- Defined in osu-base/typings/index.d.ts:593
Parameters
- x: number
- y: number
Returns <internal>.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/typings/index.d.ts:610
The length of the vector.

Returns number

Methods

add

add(vec: <internal>.Vector2): <internal>.Vector2

- Defined in osu-base/typings/index.d.ts:602
Adds the vector with another vector.

Parameters
- vec: <internal>.Vector2
Returns <internal>.Vector2

divide

divide(divideFactor: number): <internal>.Vector2

- Defined in osu-base/typings/index.d.ts:598
Parameters
- divideFactor: number
Returns <internal>.Vector2

dot

dot(vec: <internal>.Vector2): number

- Defined in osu-base/typings/index.d.ts:614
Performs a dot multiplication with another vector.

Parameters
- vec: <internal>.Vector2
Returns number

equals

equals(other: <internal>.Vector2): boolean

- Defined in osu-base/typings/index.d.ts:632
Checks whether this vector is equal to another vector.

Parameters
- other: <internal>.Vector2
  
  The other vector.
Returns boolean

getDistance

getDistance(vec: <internal>.Vector2): number

- Defined in osu-base/typings/index.d.ts:622
Gets the distance between this vector and another vector.

Parameters
- vec: <internal>.Vector2
Returns number

multiply

multiply(vec: <internal>.Vector2): <internal>.Vector2

- Defined in osu-base/typings/index.d.ts:597
Multiplies the vector with another vector.

Parameters
- vec: <internal>.Vector2
Returns <internal>.Vector2

normalize

normalize(): void

- Defined in osu-base/typings/index.d.ts:626
Normalizes the vector.

Returns void

scale

scale(scaleFactor: number): <internal>.Vector2

- Defined in osu-base/typings/index.d.ts:618
Scales the vector.

Parameters
- scaleFactor: number
Returns <internal>.Vector2

subtract

subtract(vec: <internal>.Vector2): <internal>.Vector2

- Defined in osu-base/typings/index.d.ts:606
Subtracts the vector with another vector.

Parameters
- vec: <internal>.Vector2
Returns <internal>.Vector2

toString

toString(): string

- Defined in osu-base/typings/index.d.ts:636
Returns a string representation of the vector.

Returns string

Generated using TypeDoc