overte/scripts/system/controllers/controllerModules/webSurfaceLaserInput.js

"use strict";

//  webSurfaceLaserInput.js
//
//  Distributed under the Apache License, Version 2.0.
//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

/* global Script, Entities, Controller, RIGHT_HAND, LEFT_HAND, enableDispatcherModule, disableDispatcherModule,
   makeRunningValues, Messages, Quat, Vec3, makeDispatcherModuleParameters, Overlays, ZERO_VEC, HMD,
   INCHES_TO_METERS, DEFAULT_REGISTRATION_POINT, getGrabPointSphereOffset, COLORS_GRAB_SEARCHING_HALF_SQUEEZE,
   COLORS_GRAB_SEARCHING_FULL_SQUEEZE, COLORS_GRAB_DISTANCE_HOLD, DEFAULT_SEARCH_SPHERE_DISTANCE, TRIGGER_ON_VALUE,
   TRIGGER_OFF_VALUE, getEnabledModuleByName, PICK_MAX_DISTANCE, ContextOverlay, Picks, makeLaserParams
*/

Script.include("/~/system/libraries/controllerDispatcherUtils.js");
Script.include("/~/system/libraries/controllers.js");

(function() {
    function WebSurfaceLaserInput(hand) {
        this.hand = hand;
        this.otherHand = this.hand === RIGHT_HAND ? LEFT_HAND : RIGHT_HAND;
        this.running = false;

        // parameters for things to be working on
        this.isObjectEntity = false;
        this.objectID = null;

        this.parameters = makeDispatcherModuleParameters(
            160,
            this.hand === RIGHT_HAND ? ["rightHand"] : ["leftHand"],
            [],
            100,
            makeLaserParams(hand, true));

        this.grabModuleWantsNearbyOverlay = function(controllerData) {
            if (controllerData.triggerValues[this.hand] > TRIGGER_ON_VALUE) {
                var nearGrabName = this.hand === RIGHT_HAND ? "RightNearParentingGrabOverlay" : "LeftNearParentingGrabOverlay";
                var nearGrabModule = getEnabledModuleByName(nearGrabName);
                if (nearGrabModule) {
                    var candidateOverlays = controllerData.nearbyOverlayIDs[this.hand];
                    var grabbableOverlays = candidateOverlays.filter(function(overlayID) {
                        return Overlays.getProperty(overlayID, "grabbable");
                    });
                    var target = nearGrabModule.getTargetID(grabbableOverlays, controllerData);
                    if (target) {
                        return true;
                    }
                }
                nearGrabName = this.hand === RIGHT_HAND ? "RightNearParentingGrabEntity" : "LeftNearParentingGrabEntity";
                nearGrabModule = getEnabledModuleByName(nearGrabName);
                if (nearGrabModule && nearGrabModule.isReady(controllerData)) {
                    return nearGrabModule.isReady(controllerData).active;
                }
                nearGrabName = this.hand === RIGHT_HAND ? "RightNearActionGrabEntity" : "LeftNearActionGrabEntity";
                nearGrabModule = getEnabledModuleByName(nearGrabName);
                if (nearGrabModule && nearGrabModule.isReady(controllerData)) {
                    return nearGrabModule.isReady(controllerData).active;
                }
            }
            return false;
        };

        this.getOtherModule = function() {
            return this.hand === RIGHT_HAND ? leftOverlayLaserInput : rightOverlayLaserInput;
        };

        this.isPointingAtTriggerable = function(controllerData, triggerPressed) {
            // allow pointing at tablet, unlocked web entities, or web overlays automatically without pressing trigger,
            // but for pointing at locked web entities or non-web overlays user must be pressing trigger
            var intersection = controllerData.rayPicks[this.hand];
            var objectID = intersection.objectID;
            if (intersection.type === Picks.INTERSECTED_OVERLAY) {
                if ((HMD.tabletID && objectID === HMD.tabletID) ||
                    (HMD.tabletScreenID && objectID === HMD.tabletScreenID) ||
                    (HMD.homeButtonID && objectID === HMD.homeButtonID)) {
                    return true;
                } else {
                    var overlayType = Overlays.getOverlayType(objectID);
                    return overlayType === "web3d" || triggerPressed;
                }
            } else if (intersection.type === Picks.INTERSECTED_ENTITY) {
                var entityProperties = Entities.getEntityProperties(objectID);
                var entityType = entityProperties.type;
                var isLocked = entityProperties.locked;
                return entityType === "Web" && (!isLocked || triggerPressed);
            }
            return false;
        };

        this.deleteContextOverlay = function() {
            var farGrabModule = getEnabledModuleByName(this.hand === RIGHT_HAND
                ? "RightFarActionGrabEntity" : "LeftFarActionGrabEntity");
            if (farGrabModule) {
                var entityWithContextOverlay = farGrabModule.entityWithContextOverlay;

                if (entityWithContextOverlay) {
                    ContextOverlay.destroyContextOverlay(entityWithContextOverlay);
                    farGrabModule.entityWithContextOverlay = false;
                }
            }
        };

        this.updateAllwaysOn = function() {
            var PREFER_STYLUS_OVER_LASER = "preferStylusOverLaser";
            this.parameters.handLaser.allwaysOn = !Settings.getValue(PREFER_STYLUS_OVER_LASER, false);
        };

        this.getDominantHand = function() {
            return MyAvatar.getDominantHand() === "right" ? 1 : 0;
        };

        this.dominantHandOverride = false;

        this.isReady = function(controllerData) {
            var otherModuleRunning = this.getOtherModule().running;
            otherModuleRunning = otherModuleRunning && this.getDominantHand() !== this.hand; // Auto-swap to dominant hand.
            var isTriggerPressed = controllerData.triggerValues[this.hand] > TRIGGER_OFF_VALUE &&
                                   controllerData.triggerValues[this.otherHand] <= TRIGGER_OFF_VALUE;
            var allowThisModule = !otherModuleRunning || isTriggerPressed;

            if (allowThisModule && this.isPointingAtTriggerable(controllerData, isTriggerPressed)) {
                this.updateAllwaysOn();
                if (isTriggerPressed) {
                    this.dominantHandOverride = true; // Override dominant hand.
                    this.getOtherModule().dominantHandOverride = false;
                }
                if (this.parameters.handLaser.allwaysOn || isTriggerPressed) {
                    var intersection = controllerData.rayPicks[this.hand];
                    // the object is either an entity or an overlay.
                    this.isObjectEntity = (intersection.type === Picks.INTERSECTED_ENTITY);
                    this.objectID = intersection.objectID;
                    return makeRunningValues(true, [], []);
                }
            }
            return makeRunningValues(false, [], []);
        };

        this.run = function(controllerData, deltaTime) {
            var otherModuleRunning = this.getOtherModule().running;
            otherModuleRunning = otherModuleRunning && this.getDominantHand() !== this.hand; // Auto-swap to dominant hand.
            otherModuleRunning = otherModuleRunning || this.getOtherModule().dominantHandOverride; // Override dominant hand.
            var grabModuleNeedsToRun = this.grabModuleWantsNearbyOverlay(controllerData);
            // only allow for non-near grab
            var allowThisModule = !otherModuleRunning && !(grabModuleNeedsToRun && controllerData.secondaryValues[this.hand] > BUMPER_ON_VALUE);
            var isTriggerPressed = controllerData.triggerValues[this.hand] > TRIGGER_OFF_VALUE;
            var laserOn = isTriggerPressed || this.parameters.handLaser.allwaysOn;
            if (allowThisModule) {
                if (laserOn && this.isPointingAtTriggerable(controllerData, isTriggerPressed)) {
                    this.running = true;
                    return makeRunningValues(true, [], []);
                } else {
                    this.deleteContextOverlay();
                    this.running = false;
                    this.dominantHandOverride = false;
                    return makeRunningValues(false, [], []);
                }
            }
            this.deleteContextOverlay();
            this.running = false;
            this.dominantHandOverride = false;
            this.objectID = null;
            if (this.hand === LEFT_HAND) {
                print("allowThisModule = " + allowThisModule);
                print("isPointingAtTriggerable = " + (laserOn || this.isPointingAtTriggerable(controllerData, isTriggerPressed)));
            }
            return makeRunningValues(false, [], []);
        };
    }

    var leftOverlayLaserInput = new WebSurfaceLaserInput(LEFT_HAND);
    var rightOverlayLaserInput = new WebSurfaceLaserInput(RIGHT_HAND);

    enableDispatcherModule("LeftWebSurfaceLaserInput", leftOverlayLaserInput);
    enableDispatcherModule("RightWebSurfaceLaserInput", rightOverlayLaserInput);

    function cleanup() {
        disableDispatcherModule("LeftWebSurfaceLaserInput");
        disableDispatcherModule("RightWebSurfaceLaserInput");
    }
    Script.scriptEnding.connect(cleanup);
}());