Add documentation, trigger testing

AltspaceVR · Jan 27, 2018 · c99c75d · c99c75d
1 parent d5b89e7
commit c99c75d
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 2 deletions.
diff --git a/examples/aframe/native-gltf.html b/examples/aframe/native-gltf.html
@@ -2,12 +2,23 @@
 <html>
 <head>
 	<title>Native glTF</title>
-	<script src="https://aframe.io/releases/0.3.0/aframe.min.js"></script>
+	<script src="https://aframe.io/releases/0.7.0/aframe.min.js"></script>
 	<script src='../../dist/altspace.js'></script>
+	<script>
+	AFRAME.registerComponent('detect-click', {
+		init: function(){
+			var self = this;
+			this.el.addEventListener('click', function(){
+				self.el.nextElementSibling.setAttribute('color', '#0f0');
+			});
+		}
+	});
+	</script>
 </head>
 <body>
 <a-scene altspace debug>
-	<a-entity id='model' n-gltf='url: resources/glTF/Corset.gltf; scene-index: 0'></a-entity>
+	<a-entity id='model' detect-click n-gltf='url: resources/glTF/Corset.gltf'></a-entity>
+	<a-box width='.3' height='.3' depth='.3' position='0 -1 0'></a-box>
 </a-scene>
 </body>
 </html>
diff --git a/src/components/NGLTF.js b/src/components/NGLTF.js
@@ -1,11 +1,32 @@
 import NativeComponent from './NativeComponent';
 import Url from 'urllib';
 
+/**
+* @name module:altspace/components.n-gltf
+* @class
+* @extends module:altspace/components.NativeComponent
+* @classdesc Load a 3D model as a native asset, and attach it to this node.
+* As a native asset, the model will be inaccessible from javascript, but
+* will have better performance, materials, and colliders than normal SDK objects. @aframe
+*/
 export default class NGLTF extends NativeComponent {
 	constructor() {super('n-gltf'); }
 	get schema() {
 		return {
+			/**
+			* The URL of the glTF model.
+			* @instance
+			* @member {vec3} url
+			* @memberof module:altspace/components.n-gltf
+			*/
 			url: { type: 'string' },
+
+			/**
+			* If the model file describes multiple scenes, load this one instead of the default.
+			* @instance
+			* @member {vec3} sceneIndex
+			* @memberof module:altspace/components.n-gltf
+			*/
 			sceneIndex: { type: 'int' }
 		};
 	}