script to display entity-action details in an overlay

examples/actionInspector.js

@@ -0,0 +1,127 @@
+//
+//  actionInspector.js
+//  examples
+//
+//  Created by Seth Alves on 2015-9-30.
+//  Copyright 2015 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
+//
+
+Script.include("libraries/utils.js");
+
+
+var INSPECT_RADIUS = 10;
+var overlays = {};
+
+
+var toType = function(obj) {
+  return ({}).toString.call(obj).match(/\s([a-zA-Z]+)/)[1].toLowerCase()
+}
+
+
+function actionArgumentsToString(actionArguments) {
+    var result = "type: " + actionArguments["type"] + "\n";
+    for (var argumentName in actionArguments) {
+        if (actionArguments.hasOwnProperty(argumentName)) {
+            if (argumentName == "type") {
+                continue;
+            }
+            var arg = actionArguments[argumentName];
+            var argType = toType(arg);
+            var argString = arg;
+            if (argType == "object") {
+                if (Object.keys(arg).length == 3) {
+                    argString = vec3toStr(arg, 1);
+                }
+            } else if (argType == "number") {
+                argString = arg.toFixed(2);
+            }
+            result += argumentName + ": "
+                // + toType(arg) + " -- "
+                + argString + "\n";
+        }
+    }
+
+    return result;
+}
+
+
+function updateOverlay(entityID, actionText) {
+    var properties = Entities.getEntityProperties(entityID, ["position"]);
+    var position = Vec3.sum(properties.position, {x:0, y:1, z:0});
+    // print("position: " + vec3toStr(position) + " " + actionText);
+    if (entityID in overlays) {
+        var overlay = overlays[entityID];
+        Overlays.editOverlay(overlay, {
+            text: actionText,
+            position: position
+        });
+    } else {
+        var lines = actionText.split(/\r\n|\r|\n/);
+
+        var maxLineLength = lines[0].length;
+        for (var i = 1; i < lines.length; i++) {
+            if (lines[i].length > maxLineLength) {
+                maxLineLength = lines[i].length;
+            }
+        }
+
+        var textWidth = maxLineLength * 0.034; // XXX how to know this?
+        var textHeight = .5;
+        var numberOfLines = lines.length;
+        var textMargin = 0.05;
+        var lineHeight = (textHeight - (2 * textMargin)) / numberOfLines;
+
+        overlays[entityID] = Overlays.addOverlay("text3d", {
+            position: position,
+            dimensions: { x: textWidth, y: textHeight },
+            backgroundColor: { red: 0, green: 0, blue: 0},
+            color: { red: 255, green: 255, blue: 255},
+            topMargin: textMargin,
+            leftMargin: textMargin,
+            bottomMargin: textMargin,
+            rightMargin: textMargin,
+            text: actionText,
+            lineHeight: lineHeight,
+            alpha: 0.9,
+            backgroundAlpha: 0.9,
+            ignoreRayIntersection: true,
+            visible: true,
+            isFacingAvatar: true
+        });
+    }
+}
+
+
+function cleanup() {
+    for (var entityID in overlays) {
+        Overlays.deleteOverlay(overlays[entityID]);
+    }
+}
+
+
+Script.setInterval(function() {
+    var nearbyEntities = Entities.findEntities(MyAvatar.position, INSPECT_RADIUS);
+    for (var entityIndex = 0; entityIndex < nearbyEntities.length; entityIndex++) {
+        var entityID = nearbyEntities[entityIndex];
+        var actionIDs = Entities.getActionIDs(entityID);
+        var actionText = ""
+        for (var actionIndex = 0; actionIndex < actionIDs.length; actionIndex++) {
+            var actionID = actionIDs[actionIndex];
+            var actionArguments = Entities.getActionArguments(entityID, actionID);
+            var actionArgumentText = actionArgumentsToString(actionArguments);
+            if (actionArgumentText != "") {
+                actionText += "-----------------\n";
+                actionText += actionArgumentText;
+            }
+        }
+        if (actionText != "") {
+            updateOverlay(entityID, actionText);
+        }
+    }
+}, 1000);
+
+
+Script.scriptEnding.connect(cleanup);