| Documentation

Dw ▸
- Static members
- .EasyCam
- .DampedAction
- .Interpolation
- .Rotation
- .Vec3
- .Scalar
INFO ▸
- Static members
- .LIBRARY
- .VERSION
- .AUTHOR
- .SOURCE
EasyCam ▸
- Static members
- .INFO
- Instance members
- #setCanvas
- #getCanvas
- #attachMouseListeners
- #removeMouseListeners
- #dispose
- #getAutoUpdate
- #setAutoUpdate
- #update
- #apply
- #setViewport
- #getViewport
- #mouseWheelZoom
- #mouseDragZoom
- #mouseDragPan
- #mouseDragRotate
- #getZoomMult
- #getPanMult
- #getRotationMult
- #zoom
- #panX
- #panY
- #pan
- #rotateX
- #rotateY
- #rotateZ
- #rotate
- #setInterpolatedDistance
- #setInterpolatedCenter
- #setInterpolatedRotation
- #setDistanceMin
- #setDistanceMax
- #setDistance
- #getDistance
- #setCenter
- #getCenter
- #setRotation
- #getRotation
- #getPosition
- #getUpVector
- #getState
- #setState
- #pushResetState
- #reset
- #setRotationScale
- #setPanScale
- #setZoomScale
- #setWheelScale
- #getRotationScale
- #getPanScale
- #getZoomScale
- #getWheelScale
- #setDamping
- #setDefaultInterpolationTime
- #setRotationConstraint
- #beginHUD
- #endHUD
dampedCallback
DampedAction ▸
- Instance members
- #addForce
- #update
- #stop
Interpolation ▸
- Instance members
- #start
- #update
- #stop
interpolationCallback
Rotation ▸
- Static members
- .identity
- .applyToVec3
- .applyToRotation
- .slerp
- .create
Scalar ▸
- Static members
- .mix
- .smoothstep
- .smootherstep
Vec3 ▸
- Static members
- .add
- .mult
- .magSq
- .mag
- .dot
- .cross
- .angle
- .mix
p5 ▸
- Instance members
- #createEasyCam
- #ortho

Need help reading this?

Dw

Static Members

▸ EasyCam

EasyCam

▸ DampedAction

DampedAction

▸ Interpolation

Interpolation

▸ Rotation

Rotation

▸ Vec3

Vec3

▸ Scalar

Scalar

INFO

EasyCam Library Info

INFO

Static Members

▸ LIBRARY

name

LIBRARY

▸ VERSION

version

VERSION

▸ AUTHOR

author

AUTHOR

▸ SOURCE

source

SOURCE

EasyCam


  new Dw.EasyCam(p5.RendererGL, {
    distance : z,                 // scalar
    center   : [x, y, z],         // vector
    rotation : [q0, q1, q2, q3],  // quaternion
    viewport : [x, y, w, h],      // array
  }

new EasyCam(renderer: p5.RendererGL, args: Object)

Parameters

renderer (p5.RendererGL) p5 WEBGL renderer

args (Object) {distance, center, rotation, viewport}

Static Members

▸ INFO

INFO

Instance Members

▸ setCanvas(renderer)

sets the WEBGL renderer the camera is working on

setCanvas(renderer: p5.RendererGL)

Parameters

renderer (p5.RendererGL) ... p5 WEBGL renderer

▸ getCanvas()

getCanvas(): p5.RendererGL

Returns

p5.RendererGL: the currently used renderer

▸ attachMouseListeners(renderer)

attaches input-listeners (mouse, touch, key) to the used renderer

attachMouseListeners(renderer: any)

Parameters

renderer (any)

▸ removeMouseListeners()

detaches all attached input-listeners

removeMouseListeners()

▸ dispose()

Disposes/releases the camera.

dispose()

▸ getAutoUpdate()

getAutoUpdate(): boolean

Returns

boolean: the current autoUpdate state

▸ setAutoUpdate(status, the)

If true, the EasyCam will update automatically in a pre-draw step. This updates the camera state and updates the renderers modelview/camera matrix.

If false, the update() needs to be called manually.

setAutoUpdate(status: any, the: boolean)

Parameters

status (any)

the (boolean) new autoUpdate state

▸ update()

Updates the camera state (interpolated / damped animations) and updates the renderers' modelview/camera matrix.

if "auto_update" is true, this is called automatically in a pre-draw call.

update()

▸ apply(renderer)

Applies the current camera state to the renderers' modelview/camera matrix. If no argument is given, then the cameras currently set renderer is used.

apply(renderer: any)

Parameters

renderer (any)

▸ setViewport(viewport, the)

setViewport(viewport: any, the: Array<int>)

Parameters

viewport (any)

the (Array<int>) new viewport-def, as [ x,y,w,h ]

▸ getViewport()

getViewport(): Array<int>

Returns

Array<int>: the current viewport-def, as [ x,y,w,h ]

▸ mouseWheelZoom()

implemented zoom-cb for mouswheel handler.

mouseWheelZoom()

▸ mouseDragZoom()

implemented zoom-cb for mousedrag/touch handler.

mouseDragZoom()

▸ mouseDragPan()

implemented pan-cb for mousedrag/touch handler.

mouseDragPan()

▸ mouseDragRotate()

implemented rotate-cb for mousedrag/touch handler.

mouseDragRotate()

▸ getZoomMult()

(private) returns the used zoom -multiplier for damped actions.

getZoomMult()

▸ getPanMult()

(private) returns the used pan-multiplier for damped actions.

getPanMult()

▸ getRotationMult()

(private) returns the used rotate-multiplier for damped actions.

getRotationMult()

▸ zoom(dz)

Applies a change to the current zoom.

zoom(dz: any)

Parameters

dz (any)

▸ panX(dx)

Applies a change to the current pan-xValue.

panX(dx: any)

Parameters

dx (any)

▸ panY(dy)

Applies a change to the current pan-yValue.

panY(dy: any)

Parameters

dy (any)

▸ pan(dx, dy)

Applies a change to the current pan-value.

pan(dx: any, dy: any)

Parameters

dx (any)

dy (any)

▸ rotateX(rx)

Applies a change to the current xRotation.

rotateX(rx: any)

Parameters

rx (any)

▸ rotateY(ry)

Applies a change to the current yRotation.

rotateY(ry: any)

Parameters

ry (any)

▸ rotateZ(rz)

Applies a change to the current zRotation.

rotateZ(rz: any)

Parameters

rz (any)

▸ rotate(axis, angle)

Applies a change to the current rotation, using the given axis/angle.

rotate(axis: any, angle: any)

Parameters

axis (any)

angle (any)

▸ setInterpolatedDistance(valA, valB, t)

Sets the new camera-distance, interpolated (t) between given A and B.

setInterpolatedDistance(valA: any, valB: any, t: any)

Parameters

valA (any)

valB (any)

t (any)

▸ setInterpolatedCenter(valA, valB, t)

Sets the new camera-center, interpolated (t) between given A and B.

setInterpolatedCenter(valA: any, valB: any, t: any)

Parameters

valA (any)

valB (any)

t (any)

▸ setInterpolatedRotation(valA, valB, t)

Sets the new camera-rotation, interpolated (t) between given A and B.

setInterpolatedRotation(valA: any, valB: any, t: any)

Parameters

valA (any)

valB (any)

t (any)

▸ setDistanceMin(distance_min)

Sets the minimum camera distance.

setDistanceMin(distance_min: any)

Parameters

distance_min (any)

▸ setDistanceMax(distance_max)

Sets the maximum camera distance.

setDistanceMax(distance_max: any)

Parameters

distance_max (any)

▸ setDistance(distance, duration, new, animation)

Sets the new camera distance.

setDistance(distance: any, duration: any, new: double, animation: long)

Parameters

distance (any)

duration (any)

new (double) distance.

animation (long) time in millis.

▸ getDistance()

getDistance(): double

Returns

double: the current camera distance.

▸ setCenter(center, duration, new, animation)

Sets the new camera center.

setCenter(center: any, duration: any, new: Array<double>, animation: long)

Parameters

center (any)

duration (any)

new (Array<double>) center.

animation (long) time in millis.

▸ getCenter()

getCenter(): Array<double>

Returns

Array<double>: the current camera center.

▸ setRotation(rotation, duration, new, animation)

Sets the new camera rotation (quaternion).

setRotation(rotation: any, duration: any, new: Array<double>, animation: long)

Parameters

rotation (any)

duration (any)

new (Array<double>) rotation as quat [ q0,q1,q2,q3 ] .

animation (long) time in millis.

▸ getRotation()

getRotation(): Array<double>

Returns

Array<double>: the current camera rotation as quat [ q0,q1,q2,q3 ] .

▸ getPosition(dst)

getPosition(dst: any): Array<double>

Parameters

dst (any)

Returns

Array<double>: the current camera position, aka. the eye position.

▸ getUpVector(dst)

getUpVector(dst: any): Array<double>

Parameters

dst (any)

Returns

Array<double>: the current camera up vector.

▸ getState()

getState(): Object

Returns

Object: a copy of the camera state {distance,center,rotation}

▸ setState(other, duration, a, animation)

setState(other: any, duration: any, a: Object, animation: long)

Parameters

other (any)

duration (any)

a (Object) new camera state {distance,center,rotation}.

animation (long) time in millis.

▸ pushResetState()

sets the current state as reset-state.

pushResetState()

▸ reset(duration)

resets the camera, by applying the reset-state.

reset(duration: any)

Parameters

duration (any)

▸ setRotationScale(scale_rotation)

sets the rotation scale/speed.

setRotationScale(scale_rotation: any)

Parameters

scale_rotation (any)

▸ setPanScale(scale_pan)

sets the pan scale/speed.

setPanScale(scale_pan: any)

Parameters

scale_pan (any)

▸ setZoomScale(scale_zoom)

sets the zoom scale/speed.

setZoomScale(scale_zoom: any)

Parameters

scale_zoom (any)

▸ setWheelScale(wheelScale)

sets the wheel scale/speed.

setWheelScale(wheelScale: any)

Parameters

wheelScale (any)

▸ getRotationScale()

getRotationScale(): any

Returns

any: the rotation scale/speed.

▸ getPanScale()

getPanScale(): any

Returns

any: the pan scale/speed.

▸ getZoomScale()

getZoomScale(): any

Returns

any: the zoom scale/speed.

▸ getWheelScale()

getWheelScale(): any

Returns

any: the wheel scale/speed.

▸ setDamping(damping)

sets the default damping scale/speed.

setDamping(damping: any)

Parameters

damping (any)

▸ setDefaultInterpolationTime(duration)

sets the default interpolation time in millis.

setDefaultInterpolationTime(duration: any)

Parameters

duration (any)

▸ setRotationConstraint(yaw, pitch, roll)

sets the rotation constraint for each axis separately.

setRotationConstraint(yaw: boolean, pitch: boolean, roll: boolean)

Parameters

yaw (boolean) constraint

pitch (boolean) constraint

roll (boolean) constraint

▸ beginHUD(renderer, w, h)

begin screen-aligned 2D-drawing.

beginHUD()
  disabled depth test
  ortho
  ... your code is executed here ...
endHUD()

beginHUD(renderer: any, w: any, h: any)

Parameters

renderer (any)

w (any)

h (any)

▸ endHUD(renderer)

end screen-aligned 2D-drawing.

endHUD(renderer: any)

Parameters

renderer (any)

dampedCallback

Damped callback, that accepts the resulting damped/smooth value.

dampedCallback(value: double)

Type: Function

Parameters

value (double) the damped/smoothed value

DampedAction

DampedAction, for smoothly changing a value to zero.

new DampedAction(cb: dampedCallback)

Parameters

cb (dampedCallback) callback that accepts the damped value as argument.

Instance Members

▸ addForce(force)

adds a value to the current value beeing damped.

addForce(force: double)

Parameters

force (double) the value beeing added.

▸ update()

updates the damping and calls damped-callback.

update()

▸ stop()

stops the damping.

stop()

Interpolation

Interpolation, for smoothly changing a value by interpolating it over time.

new Interpolation(cb: interpolationCallback)

Parameters

cb (interpolationCallback) callback for interpolating between two values.

Instance Members

▸ start(valA, valB, duration, actions)

starts the interpolation. If the given interpolation-duration is 0, then interpolation-callback is called immediately.

start(valA: any, valB: any, duration: any, actions: any)

Parameters

valA (any)

valB (any)

duration (any)

actions (any)

▸ update()

updates the interpolation and calls interpolation-callback.

update()

▸ stop()

stops the interpolation.

stop()

interpolationCallback

Interpolation callback, that implements any form of interpolation between two values A and B and the interpolationparameter t.

  linear: A * (1-t) + B * t
  smooth, etc...

interpolationCallback(A: Object, B: Object, t: double)

Type: Function

Parameters

A (Object) First Value

B (Object) Second Value

t (double) interpolation parameter [ 0, 1 ]

Rotation

Rotation as Quaternion [q0, q1, q2, q3]

Note: Only functions that were required for the EasyCam to work are implemented.

Rotation

Static Members

▸ identity()

identity(): Array<Number>

Returns

Array<Number>: an identity rotation [ 1,0,0,0 ]

▸ applyToVec3(rot, vec, dst)

Applies the rotation to a vector and returns dst or a new vector.

applyToVec3(rot: Array<Number>, vec: Array<Number>, dst: Array<Number>): Array<Number>

Parameters

rot (Array<Number>) Rotation (Quaternion)

vec (Array<Number>) vector to be rotated by rot

dst (Array<Number>) resulting vector

Returns

Array<Number>: dst- resulting vector

▸ applyToRotation(rotA, rotB, dst)

Applies the rotation to another rotation and returns dst or a new rotation.

applyToRotation(rotA: Array<Number>, rotB: Array<Number>, dst: Array<Number>): Array<Number>

Parameters

rotA (Array<Number>) RotationA (Quaternion)

rotB (Array<Number>) RotationB (Quaternion)

dst (Array<Number>) resulting rotation

Returns

Array<Number>: dst - resulting rotation

▸ slerp(rotA, rotB, t, dst)

Interpolates a rotation.

slerp(rotA: Array<Number>, rotB: Array<Number>, t: Number, dst: Array<Number>): Array<Number>

Parameters

rotA (Array<Number>) RotationA (Quaternion)

rotB (Array<Number>) RotationB (Quaternion)

t (Number) interpolation parameter

dst (Array<Number>) resulting rotation

Returns

Array<Number>: dst - resulting rotation

▸ create(def, dst)

Creates/Initiates a new Rotation


   1) Axis,Angle:
      {
        axis : [x, y, z],
        angle: double
      }
     
   2) Another Rotation:
      {
        rotation : [q0, q1, q2, q3],
        normalize: boolean
      }
     
   3) 3 euler angles, XYZ-order:
      {
        angles_xyz : [rX, rY, rZ]
      }

create(def: Object, dst: Array<Number>): Array<Number>

Parameters

def (Object) Definition, for creating the new Rotation

dst (Array<Number>) resulting rotation

Returns

Array<Number>: dst - resulting rotation

Scalar

Scalar as a simple number.

Note: Only functions that were required for the EasyCam to work are implemented.

Scalar

Static Members

▸ mix(a, b, t)

Linear interpolation between A and B using t[0,1]

mix(a: any, b: any, t: any)

Parameters

a (any)

b (any)

t (any)

▸ smoothstep(x)

modifying t as a function of smoothstep(0,1,t);

smoothstep(x: any)

Parameters

x (any)

▸ smootherstep(t)

modifying t as a function of smootherstep(0,1,t);

smootherstep(t: any)

Parameters

t (any)

Vec3

Vec3 as a 3D vector (Array)

Vec3

Static Members

▸ add(a, b, dst)

addition:

 dst = a + b

add(a: any, b: any, dst: any)

Parameters

a (any)

b (any)

dst (any)

▸ mult(a, b, dst)

componentwise multiplication:

 dst = a * b

mult(a: any, b: any, dst: any)

Parameters

a (any)

b (any)

dst (any)

▸ magSq(a)

squared length

magSq(a: any)

Parameters

a (any)

▸ mag(a)

length

mag(a: any)

Parameters

a (any)

▸ dot(a, b)

dot-product

dot(a: any, b: any)

Parameters

a (any)

b (any)

▸ cross(a, b, dst)

cross-product

cross(a: any, b: any, dst: any)

Parameters

a (any)

b (any)

dst (any)

▸ angle(v1, v2)

angle

angle(v1: any, v2: any)

Parameters

v1 (any)

v2 (any)

▸ mix(a, b, t, dst)

linear interpolation:

 dst = a  (1 - t) + b  t

mix(a: any, b: any, t: any, dst: any)

Parameters

a (any)

b (any)

t (any)

dst (any)

p5

Instance Members

▸ createEasyCam()

p5.EasyCam creator function. Arguments are optional, and equal to the default EasyCam constructor.

createEasyCam(): EasyCam

Returns

EasyCam: a new EasyCam

▸ ortho(left, right, bottom, top, near, far)

Overriding the current p5.ortho();

p5 v0.5.16 temporary bugfix for https://github.com/processing/p5.js/pull/2463.

ortho(left: Number, right: Number, bottom: Number, top: Number, near: Number, far: Number): p5

Parameters

left (Number) camera frustum left plane

right (Number) camera frustum right plane

bottom (Number) camera frustum bottom plane

top (Number) camera frustum top plane

near (Number) camera frustum near plane

far (Number) camera frustum far plane

Returns

p5: the p5 object