Classes

Note: This class must be imported via ```import { VR } from 'VR';``` before it can be used. This class will not be available on non-VR versions of Verto Studio.

Typedefs

Point3D : object
Point4D : object
InputDialogCallback : function: The inputDialog callback function
DialogParam : object
DialogOptions : object
ModelEditFinishCallback : function: The finish function used by Model.edit()
ModelEditFunction : function: The editor function used by Model.edit()
AnimationCallback ⇒ boolean: The Animation handler function that is called once per animation frame.
VRHMD : object
VRController : object

VertoStudio

A singleton that represents the Verto Studio editor application

Kind: global class

VertoStudio
- .globalState : object
- .alert(Msg)
- .version() ⇒ number
- .inputDialog(dialogOptions, callback)
- .onScriptEnd(callback)
- .isVR() ⇒ boolean
- .environmentType() ⇒ string

VertoStudio.globalState : `object`

Accesses the global state object. This object is persisted across multiple script executions.

Note: Any values stored in here will be readable by ALL other vertoJS scripts ran by the user.

Kind: static property of VertoStudio

VertoStudio.alert(Msg)

Presents up an OS-themed modal alert dialog.

Kind: static method of VertoStudio

Param	Type	Description
Msg	`string`	The message to display in the alert

VertoStudio.version() ⇒ `number`

Returns the Verto Studio version.

Kind: static method of VertoStudio
Returns: number - - The version of the application.

VertoStudio.inputDialog(dialogOptions, callback)

Presents an input dialog to the user with various parameter types.

Kind: static method of VertoStudio

Param	Type	Description
dialogOptions	`DialogOptions`	The options for presenting the dialog.
callback	`InputDialogCallback`	The callback that handles the user response.

VertoStudio.onScriptEnd(callback)

Registers a callback to signify the very end of the current script's execution, including all outstanding animations and input dialogs. This method can be useful for restoring the state of objects modified by transient operations such as animations.

Kind: static method of VertoStudio

Param	Type	Description
callback	`ScriptEndCallback`	The callback that signifies the end of the script execution.

VertoStudio.isVR() ⇒ `boolean`

Kind: static method of VertoStudio
Returns: boolean - True if running on a Virtual Reality device

VertoStudio.environmentType() ⇒ `string`

Obtains the current environment type that Verto Studio is running in.

Kind: static method of VertoStudio
Returns: string - 'PC', 'Tablet', 'Phone', 'Holographic', or 'VR'

Scene

A Verto Studio Scene

Kind: global class

Scene
- .current : Scene
- .models : Array.<Model>
- .camera : Camera
- .textures : Array.<Texture>
- .materials : Array.<Material>
- .selectionMode : string
- .editTarget : Model
- .editMode : boolean
- .selection : SceneSelection | VertexSelection | FaceSelection
- .lights() : Array.<Light>
- .loadAllTextures()
- .selectAll()
- .selectNone()
- .selectInverse()

scene.current : `Scene`

Accesses the currently active Scene

Kind: instance property of Scene
Read only: true

scene.models : `Array.<Model>`

The Scene's models

Kind: instance property of Scene
Read only: true

scene.camera : `Camera`

The Scene's current active camera

Kind: instance property of Scene
Read only: true

scene.textures : `Array.<Texture>`

The Scene's loaded textures

Kind: instance property of Scene
Read only: true

scene.materials : `Array.<Material>`

The Scene's materials

Kind: instance property of Scene
Read only: true

scene.selectionMode : `string`

The current selection mode ('vertex' or 'face')

Kind: instance property of Scene
Read only: true

scene.editTarget : `Model`

The current edit target (defined if editMode is true)

Kind: instance property of Scene
Read only: true

scene.editMode : `boolean`

Whether or not the Scene is currently in edit mode.

Kind: instance property of Scene
Read only: true

scene.selection : `SceneSelection` | `VertexSelection` | `FaceSelection`

The Scene selection

Kind: instance property of Scene

scene.lights() : `Array.<Light>`

The Scene's lights

Kind: instance method of Scene
Read only: true

scene.loadAllTextures()

Loads all of the Scene's textures

Kind: instance method of Scene

scene.selectAll()

Selects all models, vertices, or faces depending upon the current Scene's selection mode & edit mode state.

Kind: instance method of Scene

scene.selectNone()

Clears the current Scene's selection

Kind: instance method of Scene

scene.selectInverse()

Inverts the current Scene's selection

Kind: instance method of Scene

Texture

Kind: global class

Texture
- new Texture([scene], name, path)
- .mipmapped : boolean

new Texture([scene], name, path)

Creates a Texture and adds it to a Scene

Note: On macOS platforms, this method may trigger a security open dialog to prompt the user to allow access to the texture file.

Param	Type	Description
[scene]	`Scene`	The scene to add this texture to (defaults to Scene.current)
name	`string`	The unique name of this texture.
path	`string`	A full path to the texture's location on the disk. Currently PNG & JPG file formats are supported.

texture.mipmapped : `boolean`

The textures mipmap state

Kind: instance property of Texture

Material

Kind: global class

Material
- new Material([scene], [name])
- .texture : Texture
- .textureTileY : number
- .textureTileX : number
- .shininess : number
- .emissive : Array.<number>
- .specular : Array.<number>
- .ambient : Array.<number>
- .diffuse : Array.<number>

new Material([scene], [name])

Creates a Material and adds it to a Scene

Param	Type	Description
[scene]	`Scene`	The scene to add this material to (defaults to Scene.current)
[name]	`string`	The unique name of this material.

material.texture : `Texture`

The Material's texture assignment

Kind: instance property of Material

material.textureTileY : `number`

The Material's texture tiling in the Y(V) direction

Kind: instance property of Material

material.textureTileX : `number`

The Material's texture tiling in the X(U) direction

Kind: instance property of Material

material.shininess : `number`

The Material's shininess component (phong model)

Kind: instance property of Material

material.emissive : `Array.<number>`

The Material's RGBA emissive component (phong model)

Kind: instance property of Material

material.specular : `Array.<number>`

The Material's RGBA specular (reflective) component (phong model)

Kind: instance property of Material

material.ambient : `Array.<number>`

The Material's RGBA ambient component (phong model)

Kind: instance property of Material

material.diffuse : `Array.<number>`

The Material's RGBA diffuse (main color) component (phong model)

Kind: instance property of Material

Camera

A 3D camera that uses spherical coordinates for positioning.

Kind: global class

Camera
- .pos : Point3D
- .distance : number
- .phi : number
- .theta : number
- .center : Point3D
- .lookAt(newCenter, newVantage)

camera.pos : `Point3D`

The Camera's current position in 3D space

Kind: instance property of Camera
Read only: true

camera.distance : `number`

The Camera's r-value distance from its center in spherical coordinates.

Kind: instance property of Camera

camera.phi : `number`

The Camera's phi position in spherical coordinates (in degrees).

Kind: instance property of Camera

camera.theta : `number`

The Camera's theta position in spherical coordinates (in degrees).

Kind: instance property of Camera

camera.center : `Point3D`

The Camera's center position in spherical coordinates.

Kind: instance property of Camera

camera.lookAt(newCenter, newVantage)

Moves the camera to a given vantage point looking at a given center point.

Kind: instance method of Camera

Param	Type	Description
newCenter	`Point3D`	The new center position for which the camera will look towards.
newVantage	`Point3D`	The new vantage position from where the camera will look.

Model

A Verto Studio 3D model

Kind: global class

Model
- new Model()
- .name : string
- .cullBackfaces : boolean
- .quads : Uint32Array
- .triangles : Uint32Array
- .texcoords : Float32Array
- .normals : Float32Array
- .vertices : Float32Array
- .material : Material
- .hidden : boolean
- .scale : Array.<number>
- .orientation : Array.<number>
- .pos : Point3D
- .z : number
- .y : number
- .x : number
- .edit(callback)
- .fromSceneSpace(p) ⇒ Point3D
- .toSceneSpace(p) ⇒ Point3D

new Model()

Creates a new empty Model and adds it to a Scene

model.name : `string`

Accesses the Model's user-facing name.

Kind: instance property of Model

model.cullBackfaces : `boolean`

Change this to true to enable backface-culling on this model.

Kind: instance property of Model

model.quads : `Uint32Array`

Accesses the Model's Quad face index array

Note: Use Quad.array(model.quads) to obtain an array of Quad objects from this value.

Kind: instance property of Model
Read only: true

model.triangles : `Uint32Array`

Accesses the Model's Triangle face index array

Note: Use Triangle.array(model.triangles) to obtain an array of Triangle objects from this value.

Kind: instance property of Model
Read only: true

model.texcoords : `Float32Array`

Accesses the Model's texcoords vertex array

Note: Use Vec2.array(model.texcoords) to obtain an array of Vec2 objects from this value.

Kind: instance property of Model
Read only: true

model.normals : `Float32Array`

Accesses the Model's normals vertex array

Note: Use Vec3.array(model.normals) to obtain an array of Vec3 objects from this value.

Kind: instance property of Model
Read only: true

model.vertices : `Float32Array`

Accesses the Model's position (vertices) vertex array

Note: Use Vec3.array(model.vertices) to obtain an array of Vec3 objects from this value.

Kind: instance property of Model
Read only: true

model.material : `Material`

Accesses the Model's material

Kind: instance property of Model

model.hidden : `boolean`

Accesses the Model's hidden state.

Kind: instance property of Model

model.scale : `Array.<number>`

Accesses the Model's 3D XYZ scale value.

Kind: instance property of Model

model.orientation : `Array.<number>`

Accesses the Model's 3D XYZW quaternion orientation value

Note: You can use the Quat.fromAxisAngle() utility method to construct this value.

Kind: instance property of Model

model.pos : `Point3D`

Accesses the Model's 3D position

Kind: instance property of Model

model.z : `number`

Accesses the Model's 3D Z-position

Kind: instance property of Model

model.y : `number`

Accesses the Model's 3D Y-position

Kind: instance property of Model

model.x : `number`

Accesses the Model's 3D X-position

Kind: instance property of Model

model.edit(callback)

Performs an edit on this model. For the edit to be completed, the provided callback function must be called with the proper new model data values.

Kind: instance method of Model

Param	Type	Description
callback	`ModelEditFunction`	A function that implements the model edit.

model.fromSceneSpace(p) ⇒ `Point3D`

Converts the given vector from scene space to this model's space

Kind: instance method of Model
Returns: Point3D - - The converted position.

Param	Type	Description
p	`Point3D` \| `Point4D`	The position or vector to convert.

model.toSceneSpace(p) ⇒ `Point3D`

Converts the given vector from this model's space to scene space.

Kind: instance method of Model
Returns: Point3D - - The converted position.

Param	Type	Description
p	`Point3D` \| `Point4D`	The position or vector to convert.

Light

A Verto Studio 3D light

Kind: global class

Light
- new Light()
- .type : string
- .w : number
- .z : number
- .y : number
- .x : number
- .spotAngleCutoff : number
- .spotIntensity : number
- .spotDirection : Point3D
- .attenuation : Array.<number>
- .pos : Point3D
- .specular : Array.<number>
- .ambient : Array.<number>
- .diffuse : Array.<number>

new Light()

Creates a new Light and adds it to a Scene

Note: The default Verto Studio phong shader only supports up to 8 lights per scene.