v0.18.0

Author: h-ikeda

.gitignore

@@ -0,0 +1,6 @@
+---
+has_children: true
+nav_order: 3
+---
+
+# Components (API)

components/README.md

@@ -0,0 +1,7 @@
+---
+parent: Components (API)
+has_children: true
+nav_order: 0
+---
+
+# Cameras

components/cameras/README.md

@@ -0,0 +1,40 @@
+---
+parent: Cameras
+grand_parent: Components (API)
+nav_order: 0
+---
+# VglCamera
+
+This is abstract base component for cameras,
+corresponding [THREE.Camera](https://threejs.org/docs/index.html#api/cameras/Camera).
+This component should always be mixined (inherited).
+You probably want a [VglPerspectiveCamera](vgl-perspective-camera)
+and [VglOrthographicCamera](vgl-orthographic-camera).
+
+Properties of [VglObject3d](../core/vgl-object3d) are also available as mixin. 
+
+## props 
+
+- `orbit-target` ***vector3*** (*optional*) 
+
+  Position in 3D space for the camera to point towards.
+  This property overwrite rotation property when both defined. 
+
+- `orbit-position` ***spherical*** (*optional*) 
+
+  Spherical position around orbitTarget.
+  This property overwrite position and rotation properties.
+  If orbitTarget is not defined, automatically set to (0, 0, 0). 
+
+## computed properties 
+
+- `inst` 
+
+  The THREE.Camera instance. 
+
+## methods 
+
+- `emitAsCamera()` 
+
+  Emit an event in the `cameras` namespace. 
+

components/cameras/vgl-camera.md

@@ -0,0 +1,38 @@
+---
+parent: Cameras
+grand_parent: Components (API)
+nav_order: 1
+---
+# VglOrthographicCamera
+
+Camera that uses orthographic projection,
+corresponding [THREE.OrthographicCamera](https://threejs.org/docs/index.html#api/cameras/OrthographicCamera).
+Camera frustum top, bottom, left, and right planes are automatically set to the renderer size.
+
+Properties of [VglCamera](vgl-camera) are also available as mixin. 
+
+## props 
+
+- `zoom` ***number*** (*optional*) `default: 1` 
+
+  Zoom factor of the camera. 
+
+- `near` ***number*** (*optional*) `default: 0.1` 
+
+  Camera frustum near plane. 
+
+- `far` ***number*** (*optional*) `default: 2000` 
+
+  Camera frustum far plane. 
+
+## computed properties 
+
+- `inst` 
+
+  The THREE.OrthographicCamera instance. 
+
+
+## Example
+
+{% include example.html url='/examples/cameras/vgl-orthographic-camera.html' %}
+

components/cameras/vgl-orthographic-camera.md

@@ -0,0 +1,42 @@
+---
+parent: Cameras
+grand_parent: Components (API)
+nav_order: 2
+---
+# VglPerspectiveCamera
+
+Camera that uses perspective projection,
+corresponding [THREE.PerspectiveCamera](https://threejs.org/docs/index.html#api/cameras/PerspectiveCamera).
+Camera frustum aspect ratio is automatically set to the renderer aspect ratio.
+
+Properties of [VglCamera](vgl-camera) are also available as mixin. 
+
+## props 
+
+- `zoom` ***number*** (*optional*) `default: 1` 
+
+  Zoom factor of the camera. 
+
+- `near` ***number*** (*optional*) `default: 0.1` 
+
+  Camera frustum near plane. 
+
+- `far` ***number*** (*optional*) `default: 2000` 
+
+  Camera frustum far plane. 
+
+- `fov` ***number*** (*optional*) `default: 50` 
+
+  Camera frustum vertical field of view, from bottom to top of view, in degrees. 
+
+## computed properties 
+
+- `inst` 
+
+  The THREE.PerspectiveCamera instance. 
+
+
+## Example
+
+{% include example.html url='/examples/cameras/vgl-perspective-camera.html' %}
+

components/cameras/vgl-perspective-camera.md

@@ -0,0 +1,7 @@
+---
+parent: Components (API)
+has_children: true
+nav_order: 1
+---
+
+# Core

components/core/README.md

@@ -0,0 +1,47 @@
+---
+parent: Core
+grand_parent: Components (API)
+nav_order: 0
+---
+# VglGeometry
+
+This is the base mixin component for all geometry components,
+corresponding [THREE.Geometry](https://threejs.org/docs/index.html#api/core/Geometry).
+This can also be used directly for building custom geometries. 
+
+## props 
+
+- `name` ***name*** (*optional*) 
+
+  Name of the component. 
+
+- `position-attribute` ***floatArray*** (*optional*) 
+
+  The x, y, and z coordinates of each vertex in this geometry. 
+
+- `color-attribute` ***floatArray*** (*optional*) 
+
+  The red, green, and blue channels of vertex color of each vertex in this geometry. 
+
+- `normal-attribute` ***floatArray*** (*optional*) 
+
+  The x, y, and z components of the vertex normal vector of each vertex in this geometry. 
+
+## computed properties 
+
+- `inst` 
+
+  The THREE.BufferGeometry instance. 
+
+## methods 
+
+- `update()` 
+
+  Emit an event in `geometries` namespace. Call this method after editing instance's
+  properties. 
+
+
+## Example
+
+{% include example.html url='/examples/core/vgl-geometry.html' %}
+

components/core/vgl-geometry.md

@@ -0,0 +1,38 @@
+---
+parent: Core
+grand_parent: Components (API)
+nav_order: 1
+---
+# VglNamespace
+
+This component provides maps for managing objects by name (string), and also provides utility
+methods. `vglNamespace` object can be injected to descendant components for using it.
+It has following namespaces:
+
+- `vglNamespace.cameras`
+- `vglNamespace.scenes`
+- `vglNamespace.geometries`
+- `vglNamespace.materials`
+- `vglNamespace.textures`
+- `vglNamespace.curves`
+- `vglNamespace.object3ds`
+
+Each namespace internally has a map of strings and objects, and has methods to access them.
+Each namespace has following methods:
+
+- `Namespace.prototype.get(key: string)`
+Get an instance corresponding passed `key`.
+- `Namespace.prototype.set(key: string, inst: any)`
+Set an instance corresponding passed `key`.
+- `Namespace.prototype.delete(key: string, inst: any)`
+Delete an instance corresponding passed `key`, only if the instance exactly equals passed
+`inst`.
+- `Namespace.prototype.listen(key: string, callback: func)`
+Add a listener function that will be called when the instance corresponding passed key changes.
+- `Namespace.prototype.unlisten(key: string, callback: func)`
+Remove a listener function registered to passed key.
+
+When `VglNamespace` components are nested, they create nested namespaces except for `cameras` and
+`scenes`. Since a nested namespace search instances only in its ancestors, you can use same key
+string in sibling namespaces. 
+

components/core/vgl-namespace.md

@@ -0,0 +1,68 @@
+---
+parent: Core
+grand_parent: Components (API)
+nav_order: 2
+---
+# VglObject3d
+
+This is the base mixin component for most object components in VueGL,
+corresponding [THREE.Object3D](https://threejs.org/docs/index.html#api/core/Object3D).
+Object3d components inside a object3d component are added
+as children via THREE.Object3D.prototype.add() method.
+
+VglObject3d components inside default slots are added as children. 
+
+## props 
+
+- `position` ***vector3*** (*optional*) 
+
+  The object's local position as a 3D vector. 
+
+- `rotation` ***euler*** (*optional*) 
+
+  The object's local rotation as a euler angle. 
+
+- `rotation-quaternion` ***quaternion*** (*optional*) 
+
+  The object's local rotation as a quaternion (specified in x, y, z, w order).
+  Do not use in conjunction with the rotation prop, since they both control the same property
+  of the underlying THREE.Object3D object. 
+
+- `scale` ***vector3*** (*optional*) 
+
+  The object's local scale as a 3D vector. 
+
+- `cast-shadow` ***boolean*** (*optional*) 
+
+  Whether the object gets rendered into shadow map. 
+
+- `receive-shadow` ***boolean*** (*optional*) 
+
+  Whether the material receives shadows. 
+
+- `name` ***name*** (*optional*) 
+
+  Optional name of the object. 
+
+- `hidden` ***boolean*** (*optional*) 
+
+  Whether the object is visible. 
+
+## computed properties 
+
+- `inst` 
+
+  The THREE.Object3D instance. 
+- `parent` 
+
+  The parent THREE.Object3D instance. 
+
+   **dependencies:** `vglObject3d` 
+
+
+## methods 
+
+- `emitAsObject3d()` 
+
+  Emit an event in the `object3ds` namespace. 
+