NGL@1.0.0-beta.7 Home Manual Reference Source Gallery

import ViewerControls from 'ngl/src/controls/viewer-controls.js'

public class | source

ViewerControls

Viewer controls

Constructor Summary

Public Constructor
public	constructor(stage: Stage)

Member Summary

Public Members
public get	position: Vector3 scene center position
public get	rotation: Quaternion scene rotation
public	signals: {changed: Signal}
public	stage
public	viewer

Method Summary

Public Methods
public	align(basis: Matrix4 \| Array): undefined align scene to basis matrix
public	applyMatrix(matrix: Matrix4 \| Array): undefined apply rotation matrix to scene
public	center(position: Vector3 \| Array): undefined center scene
public	changed(): undefined Trigger render and emit changed event
public	distance(z: Number): undefined camera distance
public	getOrientation(optionalTarget: Matrix4): OrientationMatrix get scene orientation
public	getPositionOnCanvas()
public	orient(orientation: OrientationMatrix \| Array): undefined set scene orientation
public	rotate(quaternion: Quaternion \| Array): undefined rotate scene
public	spin(axis: Vector3 \| Array, angle: Number): undefined spin scene on axis
public	translate(vector: Vector3 \| Array): undefined translate scene
public	zoom(delta: Number): undefined zoom scene

Public Constructors

public constructor(stage: Stage) source

Params:

Name	Type	Attribute	Description
stage	Stage		the stage object

Public Members

public get position: Vector3 source

scene center position

public get rotation: Quaternion source

scene rotation

public signals: {changed: Signal} source

public stage source

public viewer source

Public Methods

public align(basis: Matrix4 | Array): undefined source

align scene to basis matrix

Params:

Name	Type	Attribute	Description
basis	Matrix4 \| Array		basis matrix

Return:

public applyMatrix(matrix: Matrix4 | Array): undefined source

apply rotation matrix to scene

Params:

Name	Type	Attribute	Description
matrix	Matrix4 \| Array		rotation matrix

Return:

public center(position: Vector3 | Array): undefined source

center scene

Params:

Name	Type	Attribute	Description
position	Vector3 \| Array		center position

Return:

public changed(): undefined source

Trigger render and emit changed event

Return:

Emit:

ViewerControls.signals.changed

public distance(z: Number): undefined source

camera distance

Params:

Name	Type	Attribute	Description
z	Number		distance

Return:

public getOrientation(optionalTarget: Matrix4): OrientationMatrix source

get scene orientation

Params:

Name	Type	Attribute	Description
optionalTarget	Matrix4		pre-allocated target matrix

Return:

OrientationMatrix

scene orientation

public getPositionOnCanvas() source

public orient(orientation: OrientationMatrix | Array): undefined source

set scene orientation

Params:

Name	Type	Attribute	Description
orientation	OrientationMatrix \| Array		scene orientation

Return:

public rotate(quaternion: Quaternion | Array): undefined source

rotate scene

Params:

Name	Type	Attribute	Description
quaternion	Quaternion \| Array		rotation quaternion

Return:

public spin(axis: Vector3 | Array, angle: Number): undefined source

spin scene on axis

Params:

Name	Type	Attribute	Description
axis	Vector3 \| Array		rotation axis
angle	Number		amount to spin

Return:

public translate(vector: Vector3 | Array): undefined source

translate scene

Params:

Name	Type	Attribute	Description
vector	Vector3 \| Array		translation vector

Return:

public zoom(delta: Number): undefined source

zoom scene

Params:

Name	Type	Attribute	Description
delta	Number		zoom change

Return: