added examples for messages synchronization

examples/entityScripts/synchronizerEntityScript.js

@@ -0,0 +1,87 @@
+//
+//  synchronizerEntityScript.js
+//  examples/entityScripts
+//
+//  Created by Alessandro Signa on 11/12/15.
+//  Copyright 2015 High Fidelity, Inc.
+//
+
+//  This script shows how to create a synchronized event between avatars trhough an entity.
+//  It works using the entity's userData: the master change its value and every client checks it every frame
+//  This entity prints a message when the event starts and when it ends. 
+//  The client running synchronizerMaster.js is the event master and it decides when the event starts/ends by pressing a button.
+//  All the avatars in the area when the master presses the button will receive a message.
+//  
+
+//  Distributed under the Apache License, Version 2.0.
+//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
+
+
+
+
+(function() {
+    var insideArea = false;
+    var isJoiningTheEvent = false;
+    var _this;
+    
+    function update(){
+        var userData = JSON.parse(Entities.getEntityProperties(_this.entityID, ["userData"]).userData);
+        var valueToCheck = userData.myKey.valueToCheck;
+        if(valueToCheck && !isJoiningTheEvent){
+            _this.sendMessage();
+        }else if((!valueToCheck && isJoiningTheEvent) || (isJoiningTheEvent && !insideArea)){
+            _this.stopMessage();
+        }
+        
+    }
+
+    function ParamsEntity() {
+        _this = this;
+        return;
+    }
+    
+    
+    ParamsEntity.prototype = {
+        preload: function(entityID) {
+            print('entity loaded')
+            this.entityID = entityID;
+            Script.update.connect(update);
+        },
+        enterEntity: function(entityID) {       
+            print("enterEntity("+entityID+")");
+            var userData = JSON.parse(Entities.getEntityProperties(_this.entityID, ["userData"]).userData);
+            var valueToCheck = userData.myKey.valueToCheck;
+            if(!valueToCheck){
+                //i'm in the area in time (before the event starts)
+                insideArea = true;
+            }
+            change(entityID);
+        },
+        leaveEntity: function(entityID) {      
+            print("leaveEntity("+entityID+")");
+            Entities.editEntity(entityID, { color: { red: 255, green: 190, blue: 20} });
+            insideArea = false;
+        },
+        
+        sendMessage: function(myID){
+            if(insideArea && !isJoiningTheEvent){
+                print("The event started");
+                isJoiningTheEvent = true;
+            }
+        },
+        
+        stopMessage: function(myID){
+            if(isJoiningTheEvent){
+                print("The event ended");
+                isJoiningTheEvent = false;
+            }
+        }
+    }
+    
+    function change(entityID) {
+        Entities.editEntity(entityID, { color: { red: 255, green: 100, blue: 220} });
+    }
+    
+
+    return new ParamsEntity();
+});

examples/entityScripts/synchronizerMaster.js

@@ -0,0 +1,119 @@
+//
+//  synchronizerMaster.js
+//  examples/entityScripts
+//
+//  Created by Alessandro Signa on 11/12/15.
+//  Copyright 2015 High Fidelity, Inc.
+//
+//  Run this script to spawn a box (synchronizer) and drive the start/end of the event for anyone who is inside the box
+//  
+//  Distributed under the Apache License, Version 2.0.
+//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
+
+var PARAMS_SCRIPT_URL = 'https://raw.githubusercontent.com/AlessandroSigna/hifi/27fbef3e873d11648faf0a592bb2314a90c71624/examples/entityScripts/synchronizerEntityScript.js';
+
+
+HIFI_PUBLIC_BUCKET = "http://s3.amazonaws.com/hifi-public/";
+Script.include("../libraries/toolBars.js");
+Script.include("../libraries/utils.js");
+
+
+
+var rotation = Quat.safeEulerAngles(Camera.getOrientation());
+rotation = Quat.fromPitchYawRollDegrees(0, rotation.y, 0);
+var center = Vec3.sum(MyAvatar.position, Vec3.multiply(1, Quat.getFront(rotation)));
+
+var TOOL_ICON_URL = HIFI_PUBLIC_BUCKET + "images/tools/";
+var ALPHA_ON = 1.0;
+var ALPHA_OFF = 0.7;
+var COLOR_TOOL_BAR = { red: 0, green: 0, blue: 0 };
+
+var toolBar = null;
+var recordIcon;
+
+
+
+var isHappening = false;
+
+var testEntity = Entities.addEntity({
+    name: 'paramsTestEntity',
+    dimensions: {
+        x: 2,
+        y: 1,
+        z: 2
+    },
+    type: 'Box',
+    position: center,
+    color: {
+        red: 255,
+        green: 255,
+        blue: 255
+    },
+    visible: true,
+    ignoreForCollisions: true,
+    script: PARAMS_SCRIPT_URL,
+    
+    userData: JSON.stringify({
+        myKey: {
+            valueToCheck: false
+        }
+    })
+});
+
+
+setupToolBar();
+
+function setupToolBar() {
+    if (toolBar != null) {
+        print("Multiple calls to setupToolBar()");
+        return;
+    }
+    Tool.IMAGE_HEIGHT /= 2;
+    Tool.IMAGE_WIDTH /= 2;
+    
+    toolBar = new ToolBar(0, 0, ToolBar.HORIZONTAL);    //put the button in the up-left corner
+    
+    toolBar.setBack(COLOR_TOOL_BAR, ALPHA_OFF);
+    
+    recordIcon = toolBar.addTool({
+        imageURL: TOOL_ICON_URL + "recording-record.svg",
+        subImage: { x: 0, y: 0, width: Tool.IMAGE_WIDTH, height: Tool.IMAGE_HEIGHT },
+        x: 0, y: 0,
+        width: Tool.IMAGE_WIDTH,
+        height: Tool.IMAGE_HEIGHT,
+        alpha: MyAvatar.isPlaying() ? ALPHA_OFF : ALPHA_ON,
+        visible: true
+    }, true, isHappening);
+    
+}
+
+function mousePressEvent(event) {
+    clickedOverlay = Overlays.getOverlayAtPoint({ x: event.x, y: event.y });
+    if (recordIcon === toolBar.clicked(clickedOverlay, false)) {
+        if (!isHappening) {
+            print("I'm the event master. I want the event starts");
+            isHappening = true;
+            setEntityCustomData("myKey", testEntity, {valueToCheck: true});
+            
+        } else {
+            print("I want the event stops");
+            isHappening = false;
+            setEntityCustomData("myKey", testEntity, {valueToCheck: false});
+            
+        }
+    } 
+}
+
+Script.setTimeout(function() {
+    print('sending data to entity');
+    Entities.callEntityMethod(testEntity, 'testParams', data);
+}, 1500)
+
+function cleanup() {
+    Entities.deleteEntity(testEntity);
+}
+
+
+
+ Script.scriptEnding.connect(cleanup);
+ Controller.mousePressEvent.connect(mousePressEvent);