Class ObservableVector2d

Represents a point in a 3D coordinate vector that can be observed for changes.

Index

Constructors

constructor

Accessors

x y

Constructors

constructor

new ObservableVector2d(
    x?: number,
    y?: number,
    callback?: () => void,
): ObservableVector2d
Creates a new ObservableVector3d instance.
Parameters
- x: number = 0
  The x-coordinate of the vector. Default is 0.
- y: number = 0
  The y-coordinate of the vector. Default is 0.
- Optionalcallback: () => void
  The callback function to be called when the point changes. Default is undefined.
Returns ObservableVector2d
- Defined in packages/melonjs/src/math/observableVector2d.ts:34

Accessors

x

get x(): number
Gets the x-coordinate of the point.

Returns number
- Defined in packages/melonjs/src/math/observableVector2d.ts:88
set x(value: number): void
Sets the x-coordinate of the point.
Parameters
- value: number
  The new x-coordinate value.
Returns void
- Defined in packages/melonjs/src/math/observableVector2d.ts:96

y

get y(): number
Gets the y-coordinate of the point.

Returns number
- Defined in packages/melonjs/src/math/observableVector2d.ts:103
set y(value: number): void
Sets the y-coordinate of the point.
Parameters
- value: number
  The new y-coordinate value.
Returns void
- Defined in packages/melonjs/src/math/observableVector2d.ts:111

Methods

abs

abs(): ObservableVector2d
Update this vector values to absolute values

Returns ObservableVector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:206

add

add(v: Vector2d | ObservableVector2d): ObservableVector2d
Add the passed vector to this vector
Parameters
- v: Vector2d | ObservableVector2d
  other vector
Returns ObservableVector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:145

angle

angle(v: Vector2d | ObservableVector2d): number
return the angle between this vector and the passed one
Parameters
- v: Vector2d | ObservableVector2d
  other vector
Returns number
angle in radians
- Defined in packages/melonjs/src/math/observableVector2d.ts:453

ceil

ceil(): Vector2d
Ceil the vector values

Returns Vector2d
new Vector2d
- Defined in packages/melonjs/src/math/observableVector2d.ts:271

ceilSelf

ceilSelf(): Vector2d
Ceil this vector values

Returns Vector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:279

clamp

clamp(low: number, high: number): Vector2d
Clamp the vector value within the specified value range
Parameters
- low: number
  minimum component value
- high: number
  maximum component value
Returns Vector2d
new me.Vector2d
- Defined in packages/melonjs/src/math/observableVector2d.ts:219

clampSelf

clampSelf(low: number, high: number): Vector2d
Clamp this vector value within the specified value range
Parameters
- low: number
  minimum component value
- high: number
  maximum component value
Returns Vector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:229

clone

clone(cb?: () => void): ObservableVector2d
return a clone copy of this vector
Parameters
- Optionalcb: () => void
  callback function to override the clone values
Returns ObservableVector2d
new Vector2d
- Defined in packages/melonjs/src/math/observableVector2d.ts:481

copy

copy(v: Vector2d | ObservableVector2d): ObservableVector2d
Copy the x,y values of the passed vector to this one
Parameters
- v: Vector2d | ObservableVector2d
  other vector
Returns ObservableVector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:304

cross

cross(v: Vector2d | ObservableVector2d): number
return the cross product of this vector and the passed one
Parameters
- v: Vector2d | ObservableVector2d
  other vector
Returns number
The cross product.
- Defined in packages/melonjs/src/math/observableVector2d.ts:384

distance

distance(v: Vector2d | ObservableVector2d): number
Calculates the Euclidean distance between this vector and another vector.
Parameters
- v: Vector2d | ObservableVector2d
  The vector to which the distance is calculated.
Returns number
The Euclidean distance between this vector and the given vector.
Example
```
let v1 = new Vector2d(3, 4);
let v2 = new Vector2d(6, 8);
v1.distance(v2); // returns 5
```
- Defined in packages/melonjs/src/math/observableVector2d.ts:444

div

div(n: number): ObservableVector2d
Divide this vector values by the passed value
Parameters
- n: number
  the value to divide the vector by
Returns ObservableVector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:198

dot

dot(v: Vector2d | ObservableVector2d): number
return the dot product of this vector and the passed one
Parameters
- v: Vector2d | ObservableVector2d
  other vector
Returns number
The dot product.
- Defined in packages/melonjs/src/math/observableVector2d.ts:375

equals

equals(...args: [number, number] | [Vector2d] | [ObservableVector2d]): boolean
Checks if this vector is equal to another vector or a pair of coordinates.
Parameters
- ...args: [number, number] | [Vector2d] | [ObservableVector2d]
  Either two numbers representing x and y coordinates or a single Vector2d object.
Returns boolean
True if the coordinates are equal, false otherwise.
Example
```
let v1 = new Vector2d(3, 4);
let v2 = new Vector2d(3, 4);
v1.equals(v2); // returns true
```
Example
```
let v = new Vector2d(3, 4);
v.equals(3, 4); // returns true
```
- Defined in packages/melonjs/src/math/observableVector2d.ts:320

floor

floor(): Vector2d
Floor the vector values

Returns Vector2d
new Vector2d
- Defined in packages/melonjs/src/math/observableVector2d.ts:255

floorSelf

floorSelf(): Vector2d
Floor this vector values

Returns Vector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:263

length

length(): number
return the length (magnitude) of this vector

Returns number
the length of this vector
- Defined in packages/melonjs/src/math/observableVector2d.ts:400

length2

length2(): number
return the square length of this vector

Returns number
The length^2 of this vector.
- Defined in packages/melonjs/src/math/observableVector2d.ts:392

lerp

lerp(v: Vector2d | ObservableVector2d, alpha: number): ObservableVector2d
Linearly interpolate between this vector and the given one.
Parameters
- v: Vector2d | ObservableVector2d
  other vector
- alpha: number
  distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
Returns ObservableVector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:410

maxV

maxV(v: Vector2d | ObservableVector2d): ObservableVector2d
Update this vector with the maximum value between this and the passed vector
Parameters
- v: Vector2d | ObservableVector2d
  other vector
Returns ObservableVector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:247

minV

minV(v: Vector2d | ObservableVector2d): ObservableVector2d
Update this vector with the minimum value between this and the passed vector
Parameters
- v: Vector2d | ObservableVector2d
  other vector
Returns ObservableVector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:238

moveTowards

moveTowards(
target: Vector2d | ObservableVector2d,
step: number,
): Vector2d | ObservableVector2d
interpolate the position of this vector towards the given one by the given maximum step.
Parameters
- target: Vector2d | ObservableVector2d
  vector to rotate towards
- step: number
  the maximum step per iteration (Negative values will push the vector away from the target)
Returns Vector2d | ObservableVector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:421

negate

negate(): Vector2d
Negate the vector values

Returns Vector2d
new Vector2d
- Defined in packages/melonjs/src/math/observableVector2d.ts:287

negateSelf

negateSelf(): Vector2d
Negate this vector values

Returns Vector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:295

normalize

normalize(): ObservableVector2d
normalize this vector (scale the vector so that its magnitude is 1)

Returns ObservableVector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:333

perp

perp(): ObservableVector2d
change this vector to be perpendicular to what it was before.
(Effectively rotates it 90 degrees in a clockwise direction)

Returns ObservableVector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:342

project

project(v: Vector2d | ObservableVector2d): ObservableVector2d
project this vector on to another vector.
Parameters
- v: Vector2d | ObservableVector2d
  The vector to project onto.
Returns ObservableVector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:462

projectN

projectN(v: Vector2d | ObservableVector2d): ObservableVector2d
Project this vector onto a vector of unit length.
This is slightly more efficient than project when dealing with unit vectors.
Parameters
- v: Vector2d | ObservableVector2d
  The unit vector to project onto.
Returns ObservableVector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:472

revoke

revoke(): void
Revokes the proxy object, preventing further access to the ObservablePoint instance.

Returns void
- Defined in packages/melonjs/src/math/observableVector2d.ts:496

rotate

rotate(angle: number, v?: Vector2d | ObservableVector2d): ObservableVector2d
Rotate this vector (counter-clockwise) by the specified angle (in radians).
Parameters
- angle: number
  The angle to rotate (in radians)
- Optionalv: Vector2d | ObservableVector2d
  an optional point to rotate around
Returns ObservableVector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:352

scale

scale(x: number, y?: number): ObservableVector2d
Multiply this vector values by the given scalar
Parameters
- x: number
  x scale value
- Optionaly: number = x
  y scale value, if not passed, it uses the x value
Returns ObservableVector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:164

scaleV

scaleV(v: Vector2d | ObservableVector2d): ObservableVector2d
Multiply this vector values by the passed vector
Parameters
- v: Vector2d | ObservableVector2d
  other vector
Returns ObservableVector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:189

set

set(x?: number, y?: number): ObservableVector2d
Sets the x and y coordinates of the point.
Parameters
- x: number = 0
  The new x-coordinate value.
- y: number = 0
  The new y-coordinate value.
Returns ObservableVector2d
Reference to this object for method chaining.
- Defined in packages/melonjs/src/math/observableVector2d.ts:62

setCallback

setCallback(callback: () => void): void
Sets the callback function to be called when the point changes.
Parameters
- callback: () => void
  The callback function.
Returns void
- Defined in packages/melonjs/src/math/observableVector2d.ts:119

setMuted

setMuted(x?: number, y?: number): ObservableVector2d
Sets the x and y coordinates of the point without triggering the callback.
Parameters
- x: number = 0
  The new x-coordinate value.
- y: number = 0
  The new y-coordinate value.
Returns ObservableVector2d
Reference to this object for method chaining.
- Defined in packages/melonjs/src/math/observableVector2d.ts:77

setV

setV(v: Vector2d | ObservableVector2d): ObservableVector2d
set the Vector x and y properties using the passed vector
Parameters
- v: Vector2d | ObservableVector2d
  other vector
Returns ObservableVector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:136

setZero

setZero(): ObservableVector2d
set the Vector x and y properties to 0

Returns ObservableVector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:127

sub

sub(v: Vector2d | ObservableVector2d): ObservableVector2d
Substract the passed vector to this vector
Parameters
- v: Vector2d | ObservableVector2d
  other vector
Returns ObservableVector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:154

to2d

to2d(): ObservableVector2d
Convert this vector into 2d coordinate space

Returns ObservableVector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:180

toIso

toIso(): ObservableVector2d
Convert this vector into isometric coordinate space

Returns ObservableVector2d
Reference to this object for method chaining
- Defined in packages/melonjs/src/math/observableVector2d.ts:172

toString

toString(): `x:${number},y:${number}`
convert the object to a string representation

Returns `x:${number},y:${number}`
stringified representation of this vector
- Defined in packages/melonjs/src/math/observableVector2d.ts:489

Class ObservableVector2d

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns ObservableVector2d

Accessors

x

Returns number

Parameters

Returns void

y

Returns number

Parameters

Returns void

Methods

abs

Returns ObservableVector2d

add

Parameters

Returns ObservableVector2d

angle

Parameters

Returns number

ceil

Returns Vector2d

ceilSelf

Returns Vector2d

clamp

Parameters

Returns Vector2d

clampSelf

Parameters

Returns Vector2d

clone

Parameters

Returns ObservableVector2d

copy

Parameters

Returns ObservableVector2d

cross

Parameters

Returns number

distance

Parameters

Returns number

Example

div

Parameters

Returns ObservableVector2d

dot

Parameters

Returns number

equals

Parameters

Returns boolean

Example

Example

floor

Returns Vector2d

floorSelf

Returns Vector2d

length

Returns number

length2

Returns number

lerp

Parameters

Returns ObservableVector2d

maxV

Parameters

Returns ObservableVector2d

minV

Parameters

Returns ObservableVector2d

moveTowards

Parameters