Bump release v0.5.3

README.md

@@ -2,9 +2,13 @@
 
 The AltspaceVR SDK can be used together with [three.js] to create holographic, multi-user web apps for virtual reality. When running inside [AltspaceVR](http://altvr.com/) they can be experienced with consumer VR hardware including the Oculus Rift DK2.  
 
-**Latest Version: v0.5.2 -- [See Changes](https://github.com/AltspaceVR/AltspaceSDK/releases/tag/v0.5.2)**  
+**Latest Version: v0.5.3 -- [See Changes](https://github.com/AltspaceVR/AltspaceSDK/releases/tag/v0.5.3)**  
 
-<!-- THIS FILE IS GENERATED FROM README.md.template. EDIT THAT INSTEAD --> 
+<!-- 
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+THIS FILE IS GENERATED FROM README.md.template. EDIT THAT INSTEAD
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+--> 
 
 [Three.js](http://threejs.org/) is an open-source, render-agnostic 3D engine written in Javascript. It is used to construct much of the 3D graphics you see on the web, and can be used to create entire applications, or enhance existing webpages with 3D content.
 
@@ -29,7 +33,7 @@ Many APIs are present in the client without loading `altspace.js`, but please st
 
 Include the latest version of altspace in your app with:
 
-`<script src="http://sdk.altvr.com/libs/altspace.js/0.5.2/altspace.min.js"></script>`
+`<script src="http://sdk.altvr.com/libs/altspace.js/0.5.3/altspace.min.js"></script>`
 
 If you use npm, you can install altspace.js with:
 
@@ -84,18 +88,25 @@ The Debugger is essentially a remote Chrome inspector for AltspaceVR browsers.
 > Note that you cannot rename the OSX Debugger from Debugger.app after you extract it, or it won’t run due to legacy .app bundle structure — it needs an Info.plist with metadata.  
 
 ## Three.js Feature Support
+Altspace supports Three.js r69 to r73. r73 is recommended.
 
 **Currently supported:**
 * Object3D transformation and hierarchy
 * Most Geometries
 * MeshBasicMaterial map and color properties
-* Examples that should work: [Draggable Cubes] - [Voxel Painter] - [Falling Cubes] - [Flocking Birds] - [OBJ/MTL Import]
 
 **Not currently supported:**
+* Three.js r74
 * Lighting, custom shaders, screen space effects.
-* Examples that won't work: [Hemisphere Light] - [Material Reflection] - [Ocean Shader]
+* Texture wrap, filter, format, anisotropy, repeat, offset, flip
 * Using GIF images for textures
+* VideoTexture
+* Material opacity, transparency, blending, side
+* Wireframes
+* Face and vertex colors
+* Other material types including LineBasicMateral/MeshFaceMaterial/MultiMaterial
 * Line Geometries
+* Quad faces
 * Dynamic meshes, skinned meshes
 * Geometries with more than 65,000 vertices (Note: Calculated as &lt;number of faces&gt; * 3)
 
@@ -109,7 +120,19 @@ The Debugger is essentially a remote Chrome inspector for AltspaceVR browsers.
 * Bake ambient occlusion and other lighting into your models. All models currently render as unlit.  
 
 **Known Issues:**
-* Object visibility does not propagate to child objects in the scene graph. You can work around this by recursively setting the visibility on an object and its children.
+* Object visibility does not propagate to child objects in the scene graph. 
+  You can work around this by recursively setting the visibility on an object and its children.
+
+## Browser Feature Support
+Altspace's browser is based on Chromium version 28.
+
+**Currently supported:**
+* Libre audio and video codecs (ogg, webm)
+
+**Not currently supported:**
+* Proprietary audio and video codecs (h.264, mp4, mp3)
+* WebRTC
+* ES6
 
 [three.js]: http://threejs.org/
 

dist/altspace.js

@@ -1727,7 +1727,7 @@ window.altspace.utilities.behaviors = window.altspace.utilities.behaviors || {};
  *  E.g. To constraint th object to an XY plane: `{x: true, y: true}`  
  *  Each axis can also be an object specifying the minimum and maximum limits
  *  of the constraint. E.g. `{x: {min: -10, max: 20}, y: true}`  
- *  Currently you must specify exactly two axes.
+ *  **Note:** Currently you must specify exactly two axes.
  * @memberof module:altspace/utilities/behaviors
  */
 altspace.utilities.behaviors.Drag = function (config) {
@@ -2120,8 +2120,8 @@ window.altspace.utilities.behaviors = window.altspace.utilities.behaviors || {};
  * @param {Object} [config] Optional parameters.
  * @param {String} [config.event='cursorenter'] Specify the name of event which
  *  triggers the color change.  Default is 'cursorenter' for a hover effect.
- * @param {String} [config.color='yellow'] Color specified as a hexadecimal or
- *  a CSS-style string, for example, "red", "#ff0000", or "rgb(250, 0, 0)".
+ * @param {THREE.Color} [config.color=THREE.Color('yellow')] A THREE.Color value that will be applied to the object's
+ *  material.
  * @memberof module:altspace/utilities/behaviors
  */
 altspace.utilities.behaviors.HoverColor = function(config){
@@ -2225,7 +2225,9 @@ window.altspace.utilities = window.altspace.utilities || {};
 window.altspace.utilities.behaviors = window.altspace.utilities.behaviors || {};
 
 /**
- * The Object3DSync behavior syncs an object's transform and data
+ * The Object3DSync behavior syncs an object's transform and data.  
+ * **Note:** Object3DSync must be used in conjunction with 
+ * [SceneSync]{@link module:altspace/utilities/behaviors.SceneSync}
  *
  * @class Object3DSync
  * @param {Object} [config]
@@ -2400,7 +2402,8 @@ window.altspace.utilities.behaviors.Object3DSync = function (config){
     return exports;
 };
 
-//manual modifications to the ref's will not obey ownership status.
+//manual modifications to the ref's will not obey ownership status.
+
 window.altspace = window.altspace || {};
 window.altspace.utilities = window.altspace.utilities || {};
 window.altspace.utilities.behaviors = window.altspace.utilities.behaviors || {};
@@ -7756,7 +7759,7 @@ window.altspace.utilities.behaviors.Layout = Layout;
 
 (function () {
 
-    var version = '0.5.2';
+    var version = '0.5.3';
 
     if (window.altspace && window.altspace.requestVersion) {
         window.altspace.requestVersion(version);

doc/behaviors.Drag.html

@@ -130,7 +130,7 @@ <h5>Parameters:</h5>
             <td class="description last"><p>Specify the axes along which the object can be 
  dragged.
  E.g. To constraint th object to an XY plane: <code>{x: true, y: true}</code><br> Each axis can also be an object specifying the minimum and maximum limits
- of the constraint. E.g. <code>{x: {min: -10, max: 20}, y: true}</code><br> Currently you must specify exactly two axes.</p></td>
+ of the constraint. E.g. <code>{x: {min: -10, max: 20}, y: true}</code><br> <strong>Note:</strong> Currently you must specify exactly two axes.</p></td>
         </tr>
 
 

doc/behaviors.HoverColor.html

@@ -203,7 +203,7 @@ <h6>Properties</h6>
             <td class="type">
 
 
-<span class="param-type">String</span>
+<span class="param-type">THREE.Color</span>
 
 
 
@@ -224,13 +224,13 @@ <h6>Properties</h6>
 
                 <td class="default">
 
-                    'yellow'
+                    THREE.Color('yellow')
 
                 </td>
 
 
-            <td class="description last"><p>Color specified as a hexadecimal or
- a CSS-style string, for example, &quot;red&quot;, &quot;#ff0000&quot;, or &quot;rgb(250, 0, 0)&quot;.</p></td>
+            <td class="description last"><p>A THREE.Color value that will be applied to the object's
+ material.</p></td>
         </tr>
 
 

doc/behaviors.Object3DSync.html

@@ -63,7 +63,8 @@ <h4 class="name" id="Object3DSync"><span class="type-signature"></span>new Objec
 
 
 <div class="description">
-    <p>The Object3DSync behavior syncs an object's transform and data</p>
+    <p>The Object3DSync behavior syncs an object's transform and data.<br><strong>Note:</strong> Object3DSync must be used in conjunction with 
+<a href="behaviors.SceneSync.html">SceneSync</a></p>
 </div>
 
 

doc/index.html

@@ -49,8 +49,12 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-al
     <section class="readme">
         <article><h1 id="altspacevr-sdk">AltspaceVR SDK</h1>
 <p>The AltspaceVR SDK can be used together with <a href="http://threejs.org/">three.js</a> to create holographic, multi-user web apps for virtual reality. When running inside <a href="http://altvr.com/">AltspaceVR</a> they can be experienced with consumer VR hardware including the Oculus Rift DK2.  </p>
-<p><strong>Latest Version: v0.5.2 -- <a href="https://github.com/AltspaceVR/AltspaceSDK/releases/tag/v0.5.2">See Changes</a></strong>  </p>
-<!-- THIS FILE IS GENERATED FROM README.md.template. EDIT THAT INSTEAD --> 
+<p><strong>Latest Version: v0.5.3 -- <a href="https://github.com/AltspaceVR/AltspaceSDK/releases/tag/v0.5.3">See Changes</a></strong>  </p>
+<!-- 
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+THIS FILE IS GENERATED FROM README.md.template. EDIT THAT INSTEAD
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+--> 
 <p><a href="http://threejs.org/">Three.js</a> is an open-source, render-agnostic 3D engine written in Javascript. It is used to construct much of the 3D graphics you see on the web, and can be used to create entire applications, or enhance existing webpages with 3D content.</p>
 <h2 id="resources">Resources</h2>
 <p><strong><a href="https://developer.altvr.com/get-started/">Getting Started</a> - If you&#39;re new to the SDK, start here!</strong><br><strong><a href="http://altspacevr.github.io/AltspaceSDK/doc/">API Reference</a> - Reference for built in API functions, utilities, and more</strong><br><strong><a href="http://developer.altvr.com">Developer Portal</a> - Tutorials, projects, initiative program, and app submission</strong><br><strong><a href="http://answers.altvr.com">Developer Answers</a> - Questions and answers about the SDK</strong><br><strong><a href="https://developer.altvr.com/local-dev/">Local Dev Setup</a> - Instructions for setting up a local dev environment</strong><br><strong><a href="https://slack-files.com/T0B35FQCT-F0LED1QC9-299cb2300f">App Guidelines</a> - Suggestions for building apps that work well in Altspace and Gear VR</strong><br><strong><a href="https://altspacevrsdk.slack.com">Slack</a> - Chat with other members of the community and AltspaceVR devs.  <a href="http://altspacevr-slackin.herokuapp.com">Register for Slack</a></strong>  </p>
@@ -59,7 +63,7 @@ <h2 id="altspace-js">altspace.js</h2>
 <p>Many APIs are present in the client without loading <code>altspace.js</code>, but please still include it, as this may change in the future.  </p>
 <p><strong>The version baked into the altspace.js script you include will determine which version of the entire SDK that the client will provide your app.</strong> This means that if we make any breaking internal changes to things like rendering or cursor events, and you are using an older version of <code>altspace.js</code> we will try to return legacy behavior appropriate to your version of <code>altspace.js</code>. Versioning will follow <a href="http://semver.org/">SEMVER</a> as closely as possible. Details for each version can be found in the <a href="https://github.com/AltspaceVR/AltspaceSDK/releases">Release Notes</a>.</p>
 <p>Include the latest version of altspace in your app with:</p>
-<p><code>&lt;script src=&quot;http://sdk.altvr.com/libs/altspace.js/0.5.2/altspace.min.js&quot;&gt;&lt;/script&gt;</code></p>
+<p><code>&lt;script src=&quot;http://sdk.altvr.com/libs/altspace.js/0.5.3/altspace.min.js&quot;&gt;&lt;/script&gt;</code></p>
 <p>If you use npm, you can install altspace.js with:</p>
 <p><code>npm install altspace</code></p>
 <h2 id="api-overview">API Overview</h2>
@@ -107,19 +111,26 @@ <h2 id="debugger">Debugger</h2>
 <p>Note that you cannot rename the OSX Debugger from Debugger.app after you extract it, or it won’t run due to legacy .app bundle structure — it needs an Info.plist with metadata.  </p>
 </blockquote>
 <h2 id="three-js-feature-support">Three.js Feature Support</h2>
+<p>Altspace supports Three.js r69 to r73. r73 is recommended.</p>
 <p><strong>Currently supported:</strong></p>
 <ul>
 <li>Object3D transformation and hierarchy</li>
 <li>Most Geometries</li>
 <li>MeshBasicMaterial map and color properties</li>
-<li>Examples that should work: <a href="http://threejs.org/examples/#webgl_interactive_draggablecubes" title="Click-and-drag to move objects around.">Draggable Cubes</a> - <a href="http://threejs.org/examples/#webgl_interactive_voxelpainter" title="Interactively add objects to the world.">Voxel Painter</a> - <a href="http://chandlerprall.github.io/Physijs/examples/collisions.html" title="Gravity/collision simulation using Physijs plugin.">Falling Cubes</a> - <a href="http://threejs.org/examples/canvas_geometry_birds.html" title="Objects simulating the Boid flocking algorithm.">Flocking Birds</a> - <a href="http://threejs.org/examples/#webgl_loader_obj_mtl" title="Load objects from OBJ/MTL files from Blender.">OBJ/MTL Import</a></li>
 </ul>
 <p><strong>Not currently supported:</strong></p>
 <ul>
+<li>Three.js r74</li>
 <li>Lighting, custom shaders, screen space effects.</li>
-<li>Examples that won&#39;t work: <a href="http://threejs.org/examples/#webgl_lights_hemisphere" title="Flying bird, with a dynamic shadow and toggleable lighting.">Hemisphere Light</a> - <a href="http://threejs.org/examples/#webgl_materials_cars_camaro" title="Car with a reflective material that can change color.">Material Reflection</a> - <a href="http://threejs.org/examples/#webgl_shaders_ocean" title="Sphere submerging into an ocean rendered with a custom WebGL shader.">Ocean Shader</a></li>
+<li>Texture wrap, filter, format, anisotropy, repeat, offset, flip</li>
 <li>Using GIF images for textures</li>
+<li>VideoTexture</li>
+<li>Material opacity, transparency, blending, side</li>
+<li>Wireframes</li>
+<li>Face and vertex colors</li>
+<li>Other material types including LineBasicMateral/MeshFaceMaterial/MultiMaterial</li>
 <li>Line Geometries</li>
+<li>Quad faces</li>
 <li>Dynamic meshes, skinned meshes</li>
 <li>Geometries with more than 65,000 vertices (Note: Calculated as &lt;number of faces&gt; * 3)</li>
 </ul>
@@ -135,7 +146,20 @@ <h2 id="three-js-feature-support">Three.js Feature Support</h2>
 </ul>
 <p><strong>Known Issues:</strong></p>
 <ul>
-<li>Object visibility does not propagate to child objects in the scene graph. You can work around this by recursively setting the visibility on an object and its children.</li>
+<li>Object visibility does not propagate to child objects in the scene graph. 
+You can work around this by recursively setting the visibility on an object and its children.</li>
+</ul>
+<h2 id="browser-feature-support">Browser Feature Support</h2>
+<p>Altspace&#39;s browser is based on Chromium version 28.</p>
+<p><strong>Currently supported:</strong></p>
+<ul>
+<li>Libre audio and video codecs (ogg, webm)</li>
+</ul>
+<p><strong>Not currently supported:</strong></p>
+<ul>
+<li>Proprietary audio and video codecs (h.264, mp4, mp3)</li>
+<li>WebRTC</li>
+<li>ES6</li>
 </ul>
 <hr>
 <p><a href="https://david-dm.org/AltspaceVR/AltspaceSDK/#info=devDependencies"><img src="https://david-dm.org/AltspaceVR/AltspaceSDK/dev-status.svg" alt="dev dependency status"></a></p>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "altspace",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "repository": "AltspaceVR/AltspaceSDK",
   "devDependencies": {
     "aws-sdk": "^2.2.38",