Class ViewerControls

Viewer controls

Hierarchy

ViewerControls

Index

Constructors

constructor

Properties

stage
viewer

Accessors

Methods

Object literals

signals

Constructors

constructor

new ViewerControls(stage: Stage): ViewerControls

- Defined in src/controls/viewer-controls.ts:42
Parameters
- stage: Stage
  
  the stage object
Returns ViewerControls

Properties

stage

stage: Stage

the stage object

viewer

viewer: Viewer

Accessors

position

get position(): Vector3

- Defined in src/controls/viewer-controls.ts:55
scene center position

type

{Vector3}

Returns Vector3

rotation

get rotation(): Quaternion

- Defined in src/controls/viewer-controls.ts:63
scene rotation

type

{Quaternion}

Returns Quaternion

Methods

align

align(basis: Matrix4 | number[]): void

- Defined in src/controls/viewer-controls.ts:210
align scene to basis matrix

Parameters
- basis: Matrix4 | number[]
  
  basis matrix
Returns void

applyMatrix

applyMatrix(matrix: Matrix4 | number[]): void

- Defined in src/controls/viewer-controls.ts:222
apply rotation matrix to scene

Parameters
- matrix: Matrix4 | number[]
  
  rotation matrix
Returns void

center

center(position: Vector3 | number[]): void

- Defined in src/controls/viewer-controls.ts:153
center scene

Parameters
- position: Vector3 | number[]
  
  center position
Returns void

changed

changed(): void

- Defined in src/controls/viewer-controls.ts:72
Trigger render and emit changed event

emits

{ViewerControls.signals.changed}

Returns void

distance

distance(z: number): void

- Defined in src/controls/viewer-controls.ts:173
camera distance

Parameters
- z: number
  
  distance
Returns void

getCanvasScaleFactor

getCanvasScaleFactor(z?: number): number

- Defined in src/controls/viewer-controls.ts:92
Parameters
- Default value z: number = 0
Returns number

getOrientation

getOrientation(optionalTarget?: Matrix4): any

- Defined in src/controls/viewer-controls.ts:110
get scene orientation

Parameters
- Optional optionalTarget: Matrix4
  
  pre-allocated target matrix
Returns any

scene orientation

getPositionOnCanvas

getPositionOnCanvas(position: Vector3, optionalTarget?: Vector2): any

- Defined in src/controls/viewer-controls.ts:77
Parameters
- position: Vector3
- Optional optionalTarget: Vector2
Returns any

orient

orient(orientation?: Matrix4): void

- Defined in src/controls/viewer-controls.ts:126
set scene orientation

Parameters
- Optional orientation: Matrix4
  
  scene orientation
Returns void

rotate

rotate(quaternion: Quaternion | number[]): void

- Defined in src/controls/viewer-controls.ts:199
rotate scene

Parameters
- quaternion: Quaternion | number[]
  
  rotation quaternion
Returns void

spin

spin(axis: Vector3 | number[], angle: number): void

- Defined in src/controls/viewer-controls.ts:185
spin scene on axis

Parameters
- axis: Vector3 | number[]
  
  rotation axis
- angle: number
  
  amount to spin
Returns void

translate

translate(vector: Vector3 | number[]): void

- Defined in src/controls/viewer-controls.ts:142
translate scene

Parameters
- vector: Vector3 | number[]
  
  translation vector
Returns void

zoom

zoom(delta: number): void

- Defined in src/controls/viewer-controls.ts:164
zoom scene

Parameters
- delta: number
  
  zoom change
Returns void

Object literals

signals

signals: object

changed

changed: Signal<T> = new Signal()

Generated using TypeDoc