Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenvergenz committed Feb 8, 2018
1 parent 8aceda0 commit 2529fc2
Show file tree
Hide file tree
Showing 36 changed files with 348 additions and 36 deletions.
7 changes: 5 additions & 2 deletions dist/altspace.js
Original file line number Diff line number Diff line change
Expand Up @@ -2922,7 +2922,10 @@ var NLayoutBrowser = (function (NativeComponent$$1) {
* @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
* may have better performance, materials, and colliders than normal SDK objects.
* This feature is a work in progress, with improvements going out periodically.
* Because of the higher-fidelity material system, using this feature may cause
* framerates to drop, so proceed with caution. @aframe
*/
var NGLTF = (function (NativeComponent$$1) {
function NGLTF() {NativeComponent$$1.call(this, 'n-gltf'); }
Expand All @@ -2935,7 +2938,7 @@ var NGLTF = (function (NativeComponent$$1) {
prototypeAccessors.schema.get = function () {
return {
/**
* The URL of the glTF model.
* The URL of a glTF model.
* @instance
* @member {vec3} url
* @memberof module:altspace/components.n-gltf
Expand Down
2 changes: 1 addition & 1 deletion doc/aframe/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<label for="nav-trigger" class="overlay"></label>

<nav onscroll='saveVerticalScrollPosition(event)'>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-altspace_components.html">altspace/components</a></li><li><a href="module-altspace_resources.html">altspace/resources</a></li></ul><h3>Classes</h3><ul><li><a href="module-altspace_components.AFrameComponent.html">AFrameComponent</a></li><li><a href="module-altspace_components.AFrameSystem.html">AFrameSystem</a></li><li><a href="module-altspace_components.altspace.html">altspace</a></li><li><a href="module-altspace_components.altspace-cursor-collider.html">altspace-cursor-collider</a></li><li><a href="module-altspace_components.altspace-tracked-controls.html">altspace-tracked-controls</a></li><li><a href="module-altspace_components.collapse-model.html">collapse-model</a></li><li><a href="module-altspace_components.instantiator.html">instantiator</a></li><li><a href="module-altspace_components.n-billboard.html">n-billboard</a></li><li><a href="module-altspace_components.n-box-collider.html">n-box-collider</a></li><li><a href="module-altspace_components.n-capsule-collider.html">n-capsule-collider</a></li><li><a href="module-altspace_components.n-cockpit-parent.html">n-cockpit-parent</a></li><li><a href="module-altspace_components.n-collider.html">n-collider</a></li><li><a href="module-altspace_components.n-container.html">n-container</a></li><li><a href="module-altspace_components.n-layout-browser.html">n-layout-browser</a></li><li><a href="module-altspace_components.n-mesh-collider.html">n-mesh-collider</a></li><li><a href="module-altspace_components.n-object.html">n-object</a></li><li><a href="module-altspace_components.n-portal.html">n-portal</a></li><li><a href="module-altspace_components.n-skeleton-parent.html">n-skeleton-parent</a></li><li><a href="module-altspace_components.n-sound.html">n-sound</a></li><li><a href="module-altspace_components.n-spawner.html">n-spawner</a></li><li><a href="module-altspace_components.n-sphere-collider.html">n-sphere-collider</a></li><li><a href="module-altspace_components.n-text.html">n-text</a></li><li><a href="module-altspace_components.NativeComponent.html">NativeComponent</a></li><li><a href="module-altspace_components.one-per-user.html">one-per-user</a></li><li><a href="module-altspace_components.sync.html">sync</a><ul class='methods'><li data-type='method'><a href="module-altspace_components.sync.html#takeOwnership">takeOwnership</a></li></ul></li><li><a href="module-altspace_components.sync-color.html">sync-color</a></li><li><a href="module-altspace_components.sync-n-skeleton-parent.html">sync-n-skeleton-parent</a></li><li><a href="module-altspace_components.sync-n-sound.html">sync-n-sound</a></li><li><a href="module-altspace_components.sync-system.html">sync-system</a><ul class='methods'><li data-type='method'><a href="module-altspace_components.sync-system.html#instantiate">instantiate</a></li><li data-type='method'><a href="module-altspace_components.sync-system.html#isMasterClient">isMasterClient</a></li></ul></li><li><a href="module-altspace_components.sync-transform.html">sync-transform</a></li><li><a href="module-altspace_components.wire.html">wire</a></li></ul><h3>Events</h3><ul><li><a href="module-altspace_components.sync-system.html#event:clientjoined">clientjoined</a></li><li><a href="module-altspace_components.sync-system.html#event:clientleft">clientleft</a></li><li><a href="module-altspace_components.sync-system.html#event:connected">connected</a></li><li><a href="module-altspace_components.sync%250DFired%2520when%2520the%2520connection%2520with%2520the%2520sync%2520server%2520is%2520established..html#event:connected">connected</a></li><li><a href="module-altspace_components.n-container.html#.event:container-count-changed">container-count-changed</a></li><li><a href="module-altspace_components.n-container.html#.event:container-empty">container-empty</a></li><li><a href="module-altspace_components.n-container.html#.event:container-full">container-full</a></li><li><a href="module-altspace_components.n-sound.html#event:n-sound-loaded">n-sound-loaded</a></li><li><a href="module-altspace_components.n-sound.html#event:sound-paused">sound-paused</a></li><li><a href="module-altspace_components.n-sound.html#event:sound-played">sound-played</a></li><li><a href="module-altspace_components.n-collider.html#.event:triggerenter">triggerenter</a></li><li><a href="module-altspace_components.n-collider.html#.event:triggerexit">triggerexit</a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-altspace_components.html">altspace/components</a></li><li><a href="module-altspace_resources.html">altspace/resources</a></li></ul><h3>Classes</h3><ul><li><a href="module-altspace_components.AFrameComponent.html">AFrameComponent</a></li><li><a href="module-altspace_components.AFrameSystem.html">AFrameSystem</a></li><li><a href="module-altspace_components.altspace.html">altspace</a></li><li><a href="module-altspace_components.altspace-cursor-collider.html">altspace-cursor-collider</a></li><li><a href="module-altspace_components.altspace-tracked-controls.html">altspace-tracked-controls</a></li><li><a href="module-altspace_components.collapse-model.html">collapse-model</a></li><li><a href="module-altspace_components.instantiator.html">instantiator</a></li><li><a href="module-altspace_components.n-billboard.html">n-billboard</a></li><li><a href="module-altspace_components.n-box-collider.html">n-box-collider</a></li><li><a href="module-altspace_components.n-capsule-collider.html">n-capsule-collider</a></li><li><a href="module-altspace_components.n-cockpit-parent.html">n-cockpit-parent</a></li><li><a href="module-altspace_components.n-collider.html">n-collider</a></li><li><a href="module-altspace_components.n-container.html">n-container</a></li><li><a href="module-altspace_components.n-gltf.html">n-gltf</a></li><li><a href="module-altspace_components.n-layout-browser.html">n-layout-browser</a></li><li><a href="module-altspace_components.n-mesh-collider.html">n-mesh-collider</a></li><li><a href="module-altspace_components.n-object.html">n-object</a></li><li><a href="module-altspace_components.n-portal.html">n-portal</a></li><li><a href="module-altspace_components.n-skeleton-parent.html">n-skeleton-parent</a></li><li><a href="module-altspace_components.n-sound.html">n-sound</a></li><li><a href="module-altspace_components.n-spawner.html">n-spawner</a></li><li><a href="module-altspace_components.n-sphere-collider.html">n-sphere-collider</a></li><li><a href="module-altspace_components.n-text.html">n-text</a></li><li><a href="module-altspace_components.NativeComponent.html">NativeComponent</a></li><li><a href="module-altspace_components.one-per-user.html">one-per-user</a></li><li><a href="module-altspace_components.sync.html">sync</a><ul class='methods'><li data-type='method'><a href="module-altspace_components.sync.html#takeOwnership">takeOwnership</a></li></ul></li><li><a href="module-altspace_components.sync-color.html">sync-color</a></li><li><a href="module-altspace_components.sync-n-skeleton-parent.html">sync-n-skeleton-parent</a></li><li><a href="module-altspace_components.sync-n-sound.html">sync-n-sound</a></li><li><a href="module-altspace_components.sync-system.html">sync-system</a><ul class='methods'><li data-type='method'><a href="module-altspace_components.sync-system.html#instantiate">instantiate</a></li><li data-type='method'><a href="module-altspace_components.sync-system.html#isMasterClient">isMasterClient</a></li></ul></li><li><a href="module-altspace_components.sync-transform.html">sync-transform</a></li><li><a href="module-altspace_components.wire.html">wire</a></li></ul><h3>Events</h3><ul><li><a href="module-altspace_components.sync-system.html#event:clientjoined">clientjoined</a></li><li><a href="module-altspace_components.sync-system.html#event:clientleft">clientleft</a></li><li><a href="module-altspace_components.sync-system.html#event:connected">connected</a></li><li><a href="module-altspace_components.sync%250DFired%2520when%2520the%2520connection%2520with%2520the%2520sync%2520server%2520is%2520established..html#event:connected">connected</a></li><li><a href="module-altspace_components.n-container.html#.event:container-count-changed">container-count-changed</a></li><li><a href="module-altspace_components.n-container.html#.event:container-empty">container-empty</a></li><li><a href="module-altspace_components.n-container.html#.event:container-full">container-full</a></li><li><a href="module-altspace_components.n-sound.html#event:n-sound-loaded">n-sound-loaded</a></li><li><a href="module-altspace_components.n-sound.html#event:sound-paused">sound-paused</a></li><li><a href="module-altspace_components.n-sound.html#event:sound-played">sound-played</a></li><li><a href="module-altspace_components.n-collider.html#.event:triggerenter">triggerenter</a></li><li><a href="module-altspace_components.n-collider.html#.event:triggerexit">triggerexit</a></li></ul>
</nav>
<script>loadVerticalScrollPosition()</script>

Expand Down
2 changes: 1 addition & 1 deletion doc/aframe/module-altspace_components.AFrameComponent.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<label for="nav-trigger" class="overlay"></label>

<nav onscroll='saveVerticalScrollPosition(event)'>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-altspace_components.html">altspace/components</a></li><li><a href="module-altspace_resources.html">altspace/resources</a></li></ul><h3>Classes</h3><ul><li><a href="module-altspace_components.AFrameComponent.html">AFrameComponent</a></li><li><a href="module-altspace_components.AFrameSystem.html">AFrameSystem</a></li><li><a href="module-altspace_components.altspace.html">altspace</a></li><li><a href="module-altspace_components.altspace-cursor-collider.html">altspace-cursor-collider</a></li><li><a href="module-altspace_components.altspace-tracked-controls.html">altspace-tracked-controls</a></li><li><a href="module-altspace_components.collapse-model.html">collapse-model</a></li><li><a href="module-altspace_components.instantiator.html">instantiator</a></li><li><a href="module-altspace_components.n-billboard.html">n-billboard</a></li><li><a href="module-altspace_components.n-box-collider.html">n-box-collider</a></li><li><a href="module-altspace_components.n-capsule-collider.html">n-capsule-collider</a></li><li><a href="module-altspace_components.n-cockpit-parent.html">n-cockpit-parent</a></li><li><a href="module-altspace_components.n-collider.html">n-collider</a></li><li><a href="module-altspace_components.n-container.html">n-container</a></li><li><a href="module-altspace_components.n-layout-browser.html">n-layout-browser</a></li><li><a href="module-altspace_components.n-mesh-collider.html">n-mesh-collider</a></li><li><a href="module-altspace_components.n-object.html">n-object</a></li><li><a href="module-altspace_components.n-portal.html">n-portal</a></li><li><a href="module-altspace_components.n-skeleton-parent.html">n-skeleton-parent</a></li><li><a href="module-altspace_components.n-sound.html">n-sound</a></li><li><a href="module-altspace_components.n-spawner.html">n-spawner</a></li><li><a href="module-altspace_components.n-sphere-collider.html">n-sphere-collider</a></li><li><a href="module-altspace_components.n-text.html">n-text</a></li><li><a href="module-altspace_components.NativeComponent.html">NativeComponent</a></li><li><a href="module-altspace_components.one-per-user.html">one-per-user</a></li><li><a href="module-altspace_components.sync.html">sync</a><ul class='methods'><li data-type='method'><a href="module-altspace_components.sync.html#takeOwnership">takeOwnership</a></li></ul></li><li><a href="module-altspace_components.sync-color.html">sync-color</a></li><li><a href="module-altspace_components.sync-n-skeleton-parent.html">sync-n-skeleton-parent</a></li><li><a href="module-altspace_components.sync-n-sound.html">sync-n-sound</a></li><li><a href="module-altspace_components.sync-system.html">sync-system</a><ul class='methods'><li data-type='method'><a href="module-altspace_components.sync-system.html#instantiate">instantiate</a></li><li data-type='method'><a href="module-altspace_components.sync-system.html#isMasterClient">isMasterClient</a></li></ul></li><li><a href="module-altspace_components.sync-transform.html">sync-transform</a></li><li><a href="module-altspace_components.wire.html">wire</a></li></ul><h3>Events</h3><ul><li><a href="module-altspace_components.sync-system.html#event:clientjoined">clientjoined</a></li><li><a href="module-altspace_components.sync-system.html#event:clientleft">clientleft</a></li><li><a href="module-altspace_components.sync-system.html#event:connected">connected</a></li><li><a href="module-altspace_components.sync%250DFired%2520when%2520the%2520connection%2520with%2520the%2520sync%2520server%2520is%2520established..html#event:connected">connected</a></li><li><a href="module-altspace_components.n-container.html#.event:container-count-changed">container-count-changed</a></li><li><a href="module-altspace_components.n-container.html#.event:container-empty">container-empty</a></li><li><a href="module-altspace_components.n-container.html#.event:container-full">container-full</a></li><li><a href="module-altspace_components.n-sound.html#event:n-sound-loaded">n-sound-loaded</a></li><li><a href="module-altspace_components.n-sound.html#event:sound-paused">sound-paused</a></li><li><a href="module-altspace_components.n-sound.html#event:sound-played">sound-played</a></li><li><a href="module-altspace_components.n-collider.html#.event:triggerenter">triggerenter</a></li><li><a href="module-altspace_components.n-collider.html#.event:triggerexit">triggerexit</a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-altspace_components.html">altspace/components</a></li><li><a href="module-altspace_resources.html">altspace/resources</a></li></ul><h3>Classes</h3><ul><li><a href="module-altspace_components.AFrameComponent.html">AFrameComponent</a></li><li><a href="module-altspace_components.AFrameSystem.html">AFrameSystem</a></li><li><a href="module-altspace_components.altspace.html">altspace</a></li><li><a href="module-altspace_components.altspace-cursor-collider.html">altspace-cursor-collider</a></li><li><a href="module-altspace_components.altspace-tracked-controls.html">altspace-tracked-controls</a></li><li><a href="module-altspace_components.collapse-model.html">collapse-model</a></li><li><a href="module-altspace_components.instantiator.html">instantiator</a></li><li><a href="module-altspace_components.n-billboard.html">n-billboard</a></li><li><a href="module-altspace_components.n-box-collider.html">n-box-collider</a></li><li><a href="module-altspace_components.n-capsule-collider.html">n-capsule-collider</a></li><li><a href="module-altspace_components.n-cockpit-parent.html">n-cockpit-parent</a></li><li><a href="module-altspace_components.n-collider.html">n-collider</a></li><li><a href="module-altspace_components.n-container.html">n-container</a></li><li><a href="module-altspace_components.n-gltf.html">n-gltf</a></li><li><a href="module-altspace_components.n-layout-browser.html">n-layout-browser</a></li><li><a href="module-altspace_components.n-mesh-collider.html">n-mesh-collider</a></li><li><a href="module-altspace_components.n-object.html">n-object</a></li><li><a href="module-altspace_components.n-portal.html">n-portal</a></li><li><a href="module-altspace_components.n-skeleton-parent.html">n-skeleton-parent</a></li><li><a href="module-altspace_components.n-sound.html">n-sound</a></li><li><a href="module-altspace_components.n-spawner.html">n-spawner</a></li><li><a href="module-altspace_components.n-sphere-collider.html">n-sphere-collider</a></li><li><a href="module-altspace_components.n-text.html">n-text</a></li><li><a href="module-altspace_components.NativeComponent.html">NativeComponent</a></li><li><a href="module-altspace_components.one-per-user.html">one-per-user</a></li><li><a href="module-altspace_components.sync.html">sync</a><ul class='methods'><li data-type='method'><a href="module-altspace_components.sync.html#takeOwnership">takeOwnership</a></li></ul></li><li><a href="module-altspace_components.sync-color.html">sync-color</a></li><li><a href="module-altspace_components.sync-n-skeleton-parent.html">sync-n-skeleton-parent</a></li><li><a href="module-altspace_components.sync-n-sound.html">sync-n-sound</a></li><li><a href="module-altspace_components.sync-system.html">sync-system</a><ul class='methods'><li data-type='method'><a href="module-altspace_components.sync-system.html#instantiate">instantiate</a></li><li data-type='method'><a href="module-altspace_components.sync-system.html#isMasterClient">isMasterClient</a></li></ul></li><li><a href="module-altspace_components.sync-transform.html">sync-transform</a></li><li><a href="module-altspace_components.wire.html">wire</a></li></ul><h3>Events</h3><ul><li><a href="module-altspace_components.sync-system.html#event:clientjoined">clientjoined</a></li><li><a href="module-altspace_components.sync-system.html#event:clientleft">clientleft</a></li><li><a href="module-altspace_components.sync-system.html#event:connected">connected</a></li><li><a href="module-altspace_components.sync%250DFired%2520when%2520the%2520connection%2520with%2520the%2520sync%2520server%2520is%2520established..html#event:connected">connected</a></li><li><a href="module-altspace_components.n-container.html#.event:container-count-changed">container-count-changed</a></li><li><a href="module-altspace_components.n-container.html#.event:container-empty">container-empty</a></li><li><a href="module-altspace_components.n-container.html#.event:container-full">container-full</a></li><li><a href="module-altspace_components.n-sound.html#event:n-sound-loaded">n-sound-loaded</a></li><li><a href="module-altspace_components.n-sound.html#event:sound-paused">sound-paused</a></li><li><a href="module-altspace_components.n-sound.html#event:sound-played">sound-played</a></li><li><a href="module-altspace_components.n-collider.html#.event:triggerenter">triggerenter</a></li><li><a href="module-altspace_components.n-collider.html#.event:triggerexit">triggerexit</a></li></ul>
</nav>
<script>loadVerticalScrollPosition()</script>

Expand Down
Loading

0 comments on commit 2529fc2

Please sign in to comment.