overte-HifiExperiments/script-archive/gracefulControls.js

//
//  gracefulControls.js
//  examples
//
//  Created by Ryan Huffman on 9/11/14
//  Copyright 2014 High Fidelity, Inc.
//
//  Distributed under the Apache License, Version 2.0.
//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//

var DEFAULT_PARAMETERS = {
    // Coefficient to use for linear drag.  Higher numbers will cause motion to
    // slow down more quickly.
    DRAG_COEFFICIENT: 60.0,
    MAX_SPEED: 10.0,
    ACCELERATION: 10.0,

    MOUSE_YAW_SCALE: -0.125,
    MOUSE_PITCH_SCALE: -0.125,
    MOUSE_SENSITIVITY: 0.5,

    // Damping frequency, adjust to change mouse look behavior
    W: 2.2,
}

var BRAKE_PARAMETERS = {
    DRAG_COEFFICIENT: 4.9,
    MAX_SPEED: DEFAULT_PARAMETERS.MAX_SPEED,
    ACCELERATION: 0,

    W: 1.0,
    MOUSE_YAW_SCALE: -0.125,
    MOUSE_PITCH_SCALE: -0.125,
    MOUSE_SENSITIVITY: 0.5,
}

var DRIVE_AVATAR_ENABLED = true;
var UPDATE_RATE = 90;
var USE_INTERVAL = true;

var movementParameters = DEFAULT_PARAMETERS;

// Movement keys
var KEY_BRAKE = "q";
var KEY_FORWARD = "w";
var KEY_BACKWARD = "s";
var KEY_LEFT = "a";
var KEY_RIGHT = "d";
var KEY_UP = "e";
var KEY_DOWN = "c";
var KEY_TOGGLE= "SPACE";
var KEY_DISABLE = "ESC";
var CAPTURED_KEYS;

if (DRIVE_AVATAR_ENABLED) {
    CAPTURED_KEYS = [KEY_TOGGLE, KEY_BRAKE, KEY_FORWARD, KEY_BACKWARD, KEY_LEFT, KEY_RIGHT, KEY_UP, KEY_DOWN];
} else {
    CAPTURED_KEYS = [KEY_TOGGLE];
}

// Global Variables
var keys = {};
var velocity = { x: 0, y: 0, z: 0 };
var velocityVertical = 0;
var enabled = false;

var lastX = Reticle.getPosition().x;
var lastY = Reticle.getPosition().y;
var yawFromMouse = 0;
var pitchFromMouse = 0;

var yawSpeed = 0;
var pitchSpeed = 0;

function keyPressEvent(event) {
    if (event.text == KEY_DISABLE) {
        disable();
    } else if (event.text == KEY_TOGGLE) {
        toggleEnabled();
    } else if (event.text == KEY_BRAKE) {
        movementParameters = BRAKE_PARAMETERS;
    }
    keys[event.text] = true;
}

function keyReleaseEvent(event) {
    if (event.text == KEY_BRAKE) {
        movementParameters = DEFAULT_PARAMETERS;
    }

    delete keys[event.text];
}

function update(dt) {
    if (enabled && Window.hasFocus()) {
        var x = Reticle.getPosition().x;
        var y = Reticle.getPosition().y;

        var dx = x - lastX;
        var dy = y - lastY;

        yawFromMouse += (dx * movementParameters.MOUSE_YAW_SCALE * movementParameters.MOUSE_SENSITIVITY);
        pitchFromMouse += (dy * movementParameters.MOUSE_PITCH_SCALE * movementParameters.MOUSE_SENSITIVITY);
        pitchFromMouse = Math.max(-180, Math.min(180, pitchFromMouse));

        resetCursorPosition();
    }

    // Here we use a linear damping model - http://en.wikipedia.org/wiki/Damping#Linear_damping
    // Because we are using a critically damped model (no oscillation), ζ = 1 and
    // so we derive the formula: acceleration = -(2 * w0 * v) - (w0^2 * x)
    var W = movementParameters.W;
    yawAccel = (W * W * yawFromMouse) - (2 * W * yawSpeed);
    pitchAccel = (W * W * pitchFromMouse) - (2 * W * pitchSpeed);

    yawSpeed += yawAccel * dt;
    var yawMove = yawSpeed * dt;
    var newOrientation = Quat.multiply(MyAvatar.orientation, Quat.fromVec3Degrees( { x: 0, y: yawMove, z: 0 } ));
    MyAvatar.orientation = newOrientation;
    yawFromMouse -= yawMove;

    pitchSpeed += pitchAccel * dt;
    var pitchMove = pitchSpeed * dt;
    var newPitch = MyAvatar.headPitch + pitchMove;
    MyAvatar.headPitch = newPitch;
    pitchFromMouse -= pitchMove;


    if (DRIVE_AVATAR_ENABLED) {
        var targetVelocity = { x: 0, y: 0, z: 0 };
        var targetVelocityVertical = 0;
        var acceleration = movementParameters.ACCELERATION;

        if (keys[KEY_FORWARD]) {
            targetVelocity.z -= acceleration * dt;
        }
        if (keys[KEY_LEFT]) {
            targetVelocity.x -= acceleration * dt;
        }
        if (keys[KEY_BACKWARD]) {
            targetVelocity.z += acceleration * dt;
        }
        if (keys[KEY_RIGHT]) {
            targetVelocity.x += acceleration * dt;
        }
        if (keys[KEY_UP]) {
            targetVelocityVertical += acceleration * dt;
        }
        if (keys[KEY_DOWN]) {
            targetVelocityVertical -= acceleration * dt;
        }

        // If force isn't being applied in a direction, add drag;
        var drag = Math.max(movementParameters.DRAG_COEFFICIENT * dt, 1.0);
        if (targetVelocity.x == 0) {
            targetVelocity.x = -velocity.x * drag;
        }
        if (targetVelocity.z == 0) {
            targetVelocity.z = -velocity.z * drag;
        }
        velocity = Vec3.sum(velocity, targetVelocity);

        var maxSpeed = movementParameters.MAX_SPEED;
        velocity.x = Math.max(-maxSpeed, Math.min(maxSpeed, velocity.x));
        velocity.z = Math.max(-maxSpeed, Math.min(maxSpeed, velocity.z));
        var v = Vec3.multiplyQbyV(MyAvatar.headOrientation, velocity);

        if (targetVelocityVertical == 0) {
            targetVelocityVertical -= (velocityVertical * movementParameters.DRAG_COEFFICIENT * dt);
        }
        velocityVertical += targetVelocityVertical;
        velocityVertical = Math.max(-maxSpeed, Math.min(maxSpeed, velocityVertical));
        v.y += velocityVertical;

        MyAvatar.motorVelocity = v;
        Vec3.print('vel', v);
    }
}

function vecToString(vec) {
    return vec.x + ", " + vec.y + ", " + vec.z;
}

function scriptEnding() {
    disable();
}

function resetCursorPosition() {
    var newX = Math.floor(Window.x + Window.innerWidth / 2);
    var newY = Math.floor(Window.y + Window.innerHeight / 2);
    Reticle.setPosition({ x: newX, y: newY});
    lastX = newX;
    lastY = newY;
}


function toggleEnabled() {
    if (enabled) {
        disable();
    } else {
        enable();
    }
}


var timerID = null;
function enable() {
    if (!enabled && Window.hasFocus()) {
        enabled = true;

        resetCursorPosition();

        // Reset movement variables
        yawFromMouse = 0;
        pitchFromMouse = 0;
        yawSpeed = 0;
        pitchSpeed = 0;
        velocityVertical = 0;
        velocity = { x: 0, y: 0, z: 0 };

        MyAvatar.motorReferenceFrame = 'world';
        MyAvatar.motorVelocity = { x: 0, y: 0, z: 0 };
        MyAvatar.motorTimescale = 1;

        for (var i = 0; i < CAPTURED_KEYS.length; i++) {
            Controller.captureKeyEvents({ text: CAPTURED_KEYS[i] });
        }
        Reticle.setVisible(false);
        if (USE_INTERVAL) {
            var lastTime = Date.now();
            timerID = Script.setInterval(function() {
                var now = Date.now();
                var dt = now - lastTime;
                lastTime = now;
                update(dt / 1000);
            }, (1.0 / UPDATE_RATE) * 1000);
        } else {
            Script.update.connect(update);
        }
    }
}

function disable() {
    if (enabled) {
        enabled = false;
        for (var i = 0; i < CAPTURED_KEYS.length; i++) {
            Controller.releaseKeyEvents({ text: CAPTURED_KEYS[i] });
        }
        Reticle.setVisible(true);
        MyAvatar.motorVelocity = { x: 0, y: 0, z: 0 };
        if (USE_INTERVAL) {
            Script.clearInterval(timerID);
            timerID = null;
        } else {
            Script.update.disconnect(update);
        }
    }
}

Controller.keyPressEvent.connect(keyPressEvent);
Controller.keyReleaseEvent.connect(keyReleaseEvent);

Script.scriptEnding.connect(scriptEnding);