Class ObservableVector2d

A Vector2d object that provide notification by executing the given callback when the vector is changed.

Hierarchy (view full)

Vector2d
- ObservableVector2d

Index

Constructors

constructor

new ObservableVector2d(x?, y?, settings): ObservableVector2d
Parameters
- x: number = 0
  x value of the vector
- y: number = 0
  y value of the vector
- settings: {
  onUpdate: Function;
  scope: undefined | Function;
  }
  additional required parameters
  - onUpdate: Function
    the callback to be executed when the vector is changed
  - scope: undefined | Function
    the value to use as this when calling onUpdate
Returns ObservableVector2d
Overrides Vector2d.constructor
- Defined in src/math/observable_vector2.js:16

Properties

_x

_x: any

_y

_y: any

onUpdate

onUpdate: undefined | Function

scope

scope: undefined | Function

Accessors

x

get x(): number
x value of the vector

Returns number
Name
x

Memberof
ObservableVector2d
Overrides Vector2d.x
- Defined in src/math/observable_vector2.js:43
set x(value): void
x value of the vector
Parameters
- value: number
Returns void
Overrides Vector2d.x
- Defined in src/math/observable_vector2.js:47

y

get y(): number
y value of the vector

Returns number
Name
y

Memberof
ObservableVector2d
Overrides Vector2d.y
- Defined in src/math/observable_vector2.js:70
set y(value): void
y value of the vector
Parameters
- value: number
Returns void
Overrides Vector2d.y
- Defined in src/math/observable_vector2.js:74

Methods

abs

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

Returns ObservableVector2d
Reference to this object for method chaining

Name
abs

Memberof
ObservableVector2d
Overrides Vector2d.abs
- Defined in src/math/observable_vector2.js:195

add

add(v): ObservableVector2d
Add the passed vector to this vector
Parameters
- v: ObservableVector2d
Returns ObservableVector2d
Reference to this object for method chaining

Name
add

Memberof
ObservableVector2d
Overrides Vector2d.add
- Defined in src/math/observable_vector2.js:140

angle

angle(v): number
return the angle between this vector and the passed one
Parameters
- v: Vector2d
Returns number
angle in radians
Inherited from Vector2d.angle
- Defined in src/math/vector2.js:386

ceil

ceil(): ObservableVector2d
Ceil the vector values

Returns ObservableVector2d
new me.ObservableVector2d

Name
ceil

Memberof
ObservableVector2d
Overrides Vector2d.ceil
- Defined in src/math/observable_vector2.js:287

ceilSelf

ceilSelf(): ObservableVector2d
Ceil this vector values

Returns ObservableVector2d
Reference to this object for method chaining

Name
ceilSelf

Memberof
ObservableVector2d
Overrides Vector2d.ceilSelf
- Defined in src/math/observable_vector2.js:300

clamp

clamp(low, high): ObservableVector2d
Clamp the vector value within the specified value range
Parameters
- low: number
- high: number
Returns ObservableVector2d
new me.ObservableVector2d

Name
clamp

Memberof
ObservableVector2d
Overrides Vector2d.clamp
- Defined in src/math/observable_vector2.js:210

clampSelf

clampSelf(low, high): ObservableVector2d
Clamp this vector value within the specified value range
Parameters
- low: number
- high: number
Returns ObservableVector2d
Reference to this object for method chaining

Name
clampSelf

Memberof
ObservableVector2d
Overrides Vector2d.clampSelf
- Defined in src/math/observable_vector2.js:226

clone

clone(): ObservableVector2d
return a clone copy of this vector

Returns ObservableVector2d
new me.ObservableVector2d

Name
clone

Memberof
ObservableVector2d
Overrides Vector2d.clone
- Defined in src/math/observable_vector2.js:465

copy

copy(v): ObservableVector2d
Copy the x,y values of the passed vector to this one
Parameters
- v: ObservableVector2d
Returns ObservableVector2d
Reference to this object for method chaining

Name
copy

Memberof
ObservableVector2d
Overrides Vector2d.copy
- Defined in src/math/observable_vector2.js:334

cross

cross(v): number
return the cross product of this vector and the passed one
Parameters
- v: Vector2d | ObservableVector2d
Returns number
The cross product.

Name
cross

Memberof
ObservableVector2d
Overrides Vector2d.cross
- Defined in src/math/observable_vector2.js:404

distance

distance(v): number
return the distance between this vector and the passed one
Parameters
- v: ObservableVector2d
Returns number
Name
distance

Memberof
ObservableVector2d
Overrides Vector2d.distance
- Defined in src/math/observable_vector2.js:453

div

div(n): 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

Name
div

Memberof
ObservableVector2d
Overrides Vector2d.div
- Defined in src/math/observable_vector2.js:185

dot

dot(v): number
return the dot product of this vector and the passed one
Parameters
- v: Vector2d | ObservableVector2d
Returns number
The dot product.

Name
dot

Memberof
ObservableVector2d
Overrides Vector2d.dot
- Defined in src/math/observable_vector2.js:393

equals

equals(v): boolean
return true if the two vectors are the same
Parameters
- v: ObservableVector2d
Returns boolean
Name
equals

Memberof
ObservableVector2d
Overrides Vector2d.equals
- Defined in src/math/observable_vector2.js:345

floor

floor(): ObservableVector2d
Floor the vector values

Returns ObservableVector2d
new me.ObservableVector2d

Name
floor

Memberof
ObservableVector2d
Overrides Vector2d.floor
- Defined in src/math/observable_vector2.js:264

floorSelf

floorSelf(): ObservableVector2d
Floor this vector values

Returns ObservableVector2d
Reference to this object for method chaining

Name
floorSelf

Memberof
ObservableVector2d
Overrides Vector2d.floorSelf
- Defined in src/math/observable_vector2.js:277

length

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

Returns number
the length of this vector
Inherited from Vector2d.length
- Defined in src/math/vector2.js:333

length2

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

Returns number
The length^2 of this vector.
Inherited from Vector2d.length2
- Defined in src/math/vector2.js:325

lerp

lerp(v, alpha): ObservableVector2d
Linearly interpolate between this vector and the given one.
Parameters
- v: Vector2d | ObservableVector2d
- 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

Name
lerp

Memberof
ObservableVector2d
Overrides Vector2d.lerp
- Defined in src/math/observable_vector2.js:416

maxV

maxV(v): ObservableVector2d
Update this vector with the maximum value between this and the passed vector
Parameters
- v: ObservableVector2d
Returns ObservableVector2d
Reference to this object for method chaining

Name
maxV

Memberof
ObservableVector2d
Overrides Vector2d.maxV
- Defined in src/math/observable_vector2.js:251

minV

minV(v): ObservableVector2d
Update this vector with the minimum value between this and the passed vector
Parameters
- v: ObservableVector2d
Returns ObservableVector2d
Reference to this object for method chaining

Name
minV

Memberof
ObservableVector2d
Overrides Vector2d.minV
- Defined in src/math/observable_vector2.js:237

moveTowards

moveTowards(target, step): ObservableVector2d
interpolate the position of this vector towards the given one while nsure that the distance never exceeds the given step.
Parameters
- target: Vector2d | ObservableVector2d
- step: number
  the maximum step per iteration (Negative values will push the vector away from the target)
Returns ObservableVector2d
Reference to this object for method chaining

Name
moveTowards

Memberof
ObservableVector2d
Overrides Vector2d.moveTowards
- Defined in src/math/observable_vector2.js:431

negate

negate(): ObservableVector2d
Negate the vector values

Returns ObservableVector2d
new me.ObservableVector2d

Name
negate

Memberof
ObservableVector2d
Overrides Vector2d.negate
- Defined in src/math/observable_vector2.js:310

negateSelf

negateSelf(): ObservableVector2d
Negate this vector values

Returns ObservableVector2d
Reference to this object for method chaining

Name
negateSelf

Memberof
ObservableVector2d
Overrides Vector2d.negateSelf
- Defined in src/math/observable_vector2.js:323

normalize

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

Returns Vector2d
Reference to this object for method chaining
Inherited from Vector2d.normalize
- Defined in src/math/vector2.js:266

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

Name
perp

Memberof
ObservableVector2d
Overrides Vector2d.perp
- Defined in src/math/observable_vector2.js:356

project

project(v): Vector2d
project this vector on to another vector.
Parameters
- v: Vector2d
  The vector to project onto.
Returns Vector2d
Reference to this object for method chaining
Inherited from Vector2d.project
- Defined in src/math/vector2.js:395

projectN

projectN(v): Vector2d
Project this vector onto a vector of unit length.
This is slightly more efficient than project when dealing with unit vectors.
Parameters
- v: Vector2d
  The unit vector to project onto.
Returns Vector2d
Reference to this object for method chaining
Inherited from Vector2d.projectN
- Defined in src/math/vector2.js:405

rotate

rotate(angle, v?): 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

Name
rotate

Memberof
ObservableVector2d
Overrides Vector2d.rotate
- Defined in src/math/observable_vector2.js:368

scale

scale(x, y?): ObservableVector2d
Multiply this vector values by the given scalar
Parameters
- x: number
- Optionaly: number = x
Returns ObservableVector2d
Reference to this object for method chaining

Name
scale

Memberof
ObservableVector2d
Overrides Vector2d.scale
- Defined in src/math/observable_vector2.js:163

scaleV

scaleV(v): ObservableVector2d
Multiply this vector values by the passed vector
Parameters
- v: ObservableVector2d
Returns ObservableVector2d
Reference to this object for method chaining

Name
scaleV

Memberof
ObservableVector2d
Overrides Vector2d.scaleV
- Defined in src/math/observable_vector2.js:174

set

set(x, y): Vector2d
set the Vector x and y properties to the given values
Parameters
- x: number
- y: number
Returns Vector2d
Reference to this object for method chaining
Inherited from Vector2d.set
- Defined in src/math/vector2.js:51

setCallback

setCallback(fn, scope?): ObservableVector2d
set the callback to be executed when the vector is changed
Parameters
- fn: Function
  callback
- Optionalscope: Function = null
  scope
Returns ObservableVector2d
Reference to this object for method chaining

Name
setCallback

Memberof
ObservableVector2d
- Defined in src/math/observable_vector2.js:124

setMuted

setMuted(x, y): ObservableVector2d
set the vector value without triggering the callback
Parameters
- x: number
  x value of the vector
- y: number
  y value of the vector
Returns ObservableVector2d
Reference to this object for method chaining

Name
setMuted

Memberof
ObservableVector2d
- Defined in src/math/observable_vector2.js:110

setV

setV(v): Vector2d
set the Vector x and y properties using the passed vector
Parameters
- v: Vector2d
Returns Vector2d
Reference to this object for method chaining
Inherited from Vector2d.setV
- Defined in src/math/vector2.js:71

setZero

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

Returns Vector2d
Reference to this object for method chaining
Inherited from Vector2d.setZero
- Defined in src/math/vector2.js:62

sub

sub(v): ObservableVector2d
Substract the passed vector to this vector
Parameters
- v: ObservableVector2d
Returns ObservableVector2d
Reference to this object for method chaining

Name
sub

Memberof
ObservableVector2d
Overrides Vector2d.sub
- Defined in src/math/observable_vector2.js:151

to2d

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

Returns Vector2d
Reference to this object for method chaining
Inherited from Vector2d.to2d
- Defined in src/math/vector2.js:115

toIso

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

Returns Vector2d
Reference to this object for method chaining
Inherited from Vector2d.toIso
- Defined in src/math/vector2.js:107

toString

toString(): string
convert the object to a string representation

Returns string
Name
toString

Memberof
ObservableVector2d
Overrides Vector2d.toString
- Defined in src/math/observable_vector2.js:488

toVector2d

toVector2d(): Vector2d
return a me.Vector2d copy of this me.ObservableVector2d object

Returns Vector2d
new me.Vector2d

Name
toVector2d

Memberof
ObservableVector2d
- Defined in src/math/observable_vector2.js:478

Class ObservableVector2d

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

onUpdate: Function

scope: undefined | Function

Returns ObservableVector2d

Properties

_x

_y

onUpdate

scope

Accessors

x

Returns number

Name

Memberof

Parameters

Returns void

y

Returns number

Name

Memberof

Parameters

Returns void

Methods

abs

Returns ObservableVector2d

Name

Memberof

add

Parameters

Returns ObservableVector2d

Name

Memberof

angle

Parameters

Returns number

ceil

Returns ObservableVector2d

Name

Memberof

ceilSelf

Returns ObservableVector2d

Name

Memberof

clamp

Parameters

Returns ObservableVector2d

Name

Memberof

clampSelf

Parameters

Returns ObservableVector2d

Name

Memberof

clone

Returns ObservableVector2d

Name

Memberof

copy

Parameters

Returns ObservableVector2d

Name

Memberof

cross

Parameters

Returns number

Name

Memberof

distance

Parameters

Returns number

Name