Class ObservableVector3d

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

Hierarchy (view full)

Vector3d
- ObservableVector3d

Index

Constructors

constructor

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

Properties

_x

_x: any

_y

_y: any

_z

_z: any

onUpdate

onUpdate: undefined | Function

scope

scope: undefined | Function

Accessors

x

get x(): number
x value of the vector

Returns number
Name
x

Memberof
ObservableVector3d
Overrides Vector3d.x
- Defined in src/math/observable_vector3.js:51
set x(value): void
x value of the vector
Parameters
- value: number
Returns void
Overrides Vector3d.x
- Defined in src/math/observable_vector3.js:55

y

get y(): number
y value of the vector

Returns number
Name
y

Memberof
ObservableVector3d
Overrides Vector3d.y
- Defined in src/math/observable_vector3.js:80
set y(value): void
y value of the vector
Parameters
- value: number
Returns void
Overrides Vector3d.y
- Defined in src/math/observable_vector3.js:84

z

get z(): number
z value of the vector

Returns number
Name
z

Memberof
ObservableVector3d
Overrides Vector3d.z
- Defined in src/math/observable_vector3.js:109
set z(value): void
z value of the vector
Parameters
- value: number
Returns void
Overrides Vector3d.z
- Defined in src/math/observable_vector3.js:113

Methods

abs

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

Returns ObservableVector3d
Reference to this object for method chaining

Name
abs

Memberof
ObservableVector3d
Overrides Vector3d.abs
- Defined in src/math/observable_vector3.js:251

add

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

Name
add

Memberof
ObservableVector3d
Overrides Vector3d.add
- Defined in src/math/observable_vector3.js:195

angle

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

ceil

ceil(): ObservableVector3d
Ceil the vector values

Returns ObservableVector3d
new me.ObservableVector3d

Name
ceil

Memberof
ObservableVector3d
Overrides Vector3d.ceil
- Defined in src/math/observable_vector3.js:359

ceilSelf

ceilSelf(): ObservableVector3d
Ceil this vector values

Returns ObservableVector3d
Reference to this object for method chaining

Name
ceilSelf

Memberof
ObservableVector3d
Overrides Vector3d.ceilSelf
- Defined in src/math/observable_vector3.js:374

clamp

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

Name
clamp

Memberof
ObservableVector3d
Overrides Vector3d.clamp
- Defined in src/math/observable_vector3.js:267

clampSelf

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

Name
clampSelf

Memberof
ObservableVector3d
Overrides Vector3d.clampSelf
- Defined in src/math/observable_vector3.js:284

clone

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

Returns ObservableVector3d
new me.ObservableVector3d

Name
clone

Memberof
ObservableVector3d
Overrides Vector3d.clone
- Defined in src/math/observable_vector3.js:557

copy

copy(v): ObservableVector3d
Copy the components of the given vector into this one
Parameters
- v:
      | ObservableVector3d
      | Vector2d
      | Vector3d
      | ObservableVector2d
Returns ObservableVector3d
Reference to this object for method chaining

Name
copy

Memberof
ObservableVector3d
Overrides Vector3d.copy
- Defined in src/math/observable_vector3.js:412

cross

cross(v): ObservableVector3d
calculate the cross product of this vector and the passed one
Parameters
- v: ObservableVector3d | Vector3d
Returns ObservableVector3d
Reference to this object for method chaining

Name
cross

Memberof
ObservableVector3d
Overrides Vector3d.cross
- Defined in src/math/observable_vector3.js:483

distance

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

Memberof
ObservableVector3d
Overrides Vector3d.distance
- Defined in src/math/observable_vector3.js:544

div

div(n): ObservableVector3d
Divide this vector values by the passed value
Parameters
- n: number
  the value to divide the vector by
Returns ObservableVector3d
Reference to this object for method chaining

Name
div

Memberof
ObservableVector3d
Overrides Vector3d.div
- Defined in src/math/observable_vector3.js:241

dot

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

Name
dot

Memberof
ObservableVector3d
Overrides Vector3d.dot
- Defined in src/math/observable_vector3.js:472

equals

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

Memberof
ObservableVector3d
Overrides Vector3d.equals
- Defined in src/math/observable_vector3.js:423

floor

floor(): ObservableVector3d
Floor the vector values

Returns ObservableVector3d
new me.ObservableVector3d

Name
floor

Memberof
ObservableVector3d
Overrides Vector3d.floor
- Defined in src/math/observable_vector3.js:330

floorSelf

floorSelf(): ObservableVector3d
Floor this vector values

Returns ObservableVector3d
Reference to this object for method chaining

Name
floorSelf

Memberof
ObservableVector3d
Overrides Vector3d.floorSelf
- Defined in src/math/observable_vector3.js:345

length

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

Returns number
the length of this vector
Inherited from Vector3d.length
- Defined in src/math/vector3.js:405

length2

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

Returns number
The length^2 of this vector.
Inherited from Vector3d.length2
- Defined in src/math/vector3.js:397

lerp

lerp(v, alpha): ObservableVector3d
Linearly interpolate between this vector and the given one.
Parameters
- v: ObservableVector3d | Vector3d
- alpha: number
  distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
Returns ObservableVector3d
Reference to this object for method chaining

Name
lerp

Memberof
ObservableVector3d
Overrides Vector3d.lerp
- Defined in src/math/observable_vector3.js:502

maxV

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

Name
maxV

Memberof
ObservableVector3d
Overrides Vector3d.maxV
- Defined in src/math/observable_vector3.js:315

minV

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

Name
minV

Memberof
ObservableVector3d
Overrides Vector3d.minV
- Defined in src/math/observable_vector3.js:299

moveTowards

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

Name
moveTowards

Memberof
ObservableVector3d
Overrides Vector3d.moveTowards
- Defined in src/math/observable_vector3.js:518

negate

negate(): ObservableVector3d
Negate the vector values

Returns ObservableVector3d
new me.ObservableVector3d

Name
negate

Memberof
ObservableVector3d
Overrides Vector3d.negate
- Defined in src/math/observable_vector3.js:388

negateSelf

negateSelf(): ObservableVector3d
Negate this vector values

Returns ObservableVector3d
Reference to this object for method chaining

Name
negateSelf

Memberof
ObservableVector3d
Overrides Vector3d.negateSelf
- Defined in src/math/observable_vector3.js:401

normalize

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

Returns Vector3d
Reference to this object for method chaining
Inherited from Vector3d.normalize
- Defined in src/math/vector3.js:322

perp

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

Returns ObservableVector3d
Reference to this object for method chaining

Name
perp

Memberof
ObservableVector3d
Overrides Vector3d.perp
- Defined in src/math/observable_vector3.js:434

project

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

projectN

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

rotate

rotate(angle, v?): ObservableVector3d
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 (on the same z axis)
Returns ObservableVector3d
Reference to this object for method chaining

Name
rotate

Memberof
ObservableVector3d
Overrides Vector3d.rotate
- Defined in src/math/observable_vector3.js:446

scale

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

Name
scale

Memberof
ObservableVector3d
Overrides Vector3d.scale
- Defined in src/math/observable_vector3.js:219

scaleV

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

Name
scaleV

Memberof
ObservableVector3d
Overrides Vector3d.scaleV
- Defined in src/math/observable_vector3.js:230

set

set(x, y, z?): Vector3d
set the Vector x and y properties to the given values
Parameters
- x: number
- y: number
- Optionalz: number
Returns Vector3d
Reference to this object for method chaining
Inherited from Vector3d.set
- Defined in src/math/vector3.js:68

setCallback

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

Name
setCallback

Memberof
ObservableVector3d
- Defined in src/math/observable_vector3.js:179

setMuted

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

Name
setMuted

Memberof
ObservableVector3d
- Defined in src/math/observable_vector3.js:164

setV

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

setZero

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

Returns Vector3d
Reference to this object for method chaining
Inherited from Vector3d.setZero
- Defined in src/math/vector3.js:79

sub

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

Name
sub

Memberof
ObservableVector3d
Overrides Vector3d.sub
- Defined in src/math/observable_vector3.js:206

to2d

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

Returns Vector3d
Reference to this object for method chaining
Inherited from Vector3d.to2d
- Defined in src/math/vector3.js:142

toIso

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

Returns Vector3d
Reference to this object for method chaining
Inherited from Vector3d.toIso
- Defined in src/math/vector3.js:134

toString

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

Returns string
Name
toString

Memberof
ObservableVector3d
Overrides Vector3d.toString
- Defined in src/math/observable_vector3.js:579

toVector3d

toVector3d(): Vector3d
return a me.Vector3d copy of this me.ObservableVector3d object

Returns Vector3d
new me.Vector3d

Name
toVector3d

Memberof
ObservableVector3d
- Defined in src/math/observable_vector3.js:569

Class ObservableVector3d

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

onUpdate: Function

scope: undefined | object

Returns ObservableVector3d

Properties

_x

_y

_z

onUpdate

scope

Accessors

x

Returns number

Name

Memberof

Parameters

Returns void

y

Returns number

Name

Memberof

Parameters

Returns void

z

Returns number

Name

Memberof

Parameters

Returns void

Methods

abs

Returns ObservableVector3d

Name

Memberof

add

Parameters

Returns ObservableVector3d

Name

Memberof

angle

Parameters

Returns number

ceil

Returns ObservableVector3d

Name

Memberof

ceilSelf

Returns ObservableVector3d

Name

Memberof

clamp

Parameters

Returns ObservableVector3d

Name

Memberof

clampSelf

Parameters

Returns ObservableVector3d

Name

Memberof

clone

Returns ObservableVector3d

Name

Memberof

copy

Parameters

Returns ObservableVector3d

Name

Memberof

cross

Parameters