Class NavCubePlugin

Viewer plugin that lets us look at the entire Scene from along a chosen axis or diagonal.

Hierarchy

Plugin
- NavCubePlugin

Index

Constructors

constructor

new NavCubePlugin(viewer: Viewer, cfg?: NavCubePluginConfiguration): NavCubePlugin

Overrides Plugin.constructor
- Defined in plugins/NavCubePlugin/NavCubePlugin.d.ts:53
Parameters
- viewer: Viewer
  
  The Viewer.
- Optional cfg: NavCubePluginConfiguration
  
  NavCubePlugin configuration.
Returns NavCubePlugin

Properties

id

id: string

ID for this Plugin, unique within its Viewer.

viewer

viewer: Viewer

The Viewer that contains this Plugin.

Methods

destroy

destroy(): void

Inherited from Plugin.destroy
- Defined in viewer/Plugin.d.ts:68
Destroys this Plugin and removes it from its Viewer.

Returns void

error

error(msg: string): void

Inherited from Plugin.error
- Defined in viewer/Plugin.d.ts:63
Logs an error message to the JavaScript developer console, prefixed with the ID of this Plugin.

Parameters
- msg: string
  
  The error message
Returns void

fire

fire(event: string, value: any): void

Inherited from Plugin.fire
- Defined in viewer/Plugin.d.ts:42
Fires an event at this Plugin.

Parameters
- event: string
  
  The event type name
- value: any
  
  The event parameters
Returns void

getCameraFitFOV

getCameraFitFOV(): number

- Defined in plugins/NavCubePlugin/NavCubePlugin.d.ts:125
Gets how much of the field-of-view, in degrees, that the Scene should fill the canvas when flying or jumping the Camera to each selected axis or diagonal.

Default value is 45.

Returns number
Current FOV value.

getCameraFly

getCameraFly(): boolean

- Defined in plugins/NavCubePlugin/NavCubePlugin.d.ts:105
Gets whether the Camera flies or jumps to each selected axis or diagonal.

Default is true, to fly.

Returns boolean
Returns true to fly, else false to jump.

getCameraFlyDuration

getCameraFlyDuration(): boolean

- Defined in plugins/NavCubePlugin/NavCubePlugin.d.ts:143
When flying the Camera to each new axis or diagonal, gets how long, in seconds, that the Camera takes to get there.

Default is 0.5.

Returns boolean
Camera flight duration in seconds.

getFitVisible

getFitVisible(): boolean

- Defined in plugins/NavCubePlugin/NavCubePlugin.d.ts:87
Gets whether the axis, corner and edge-aligned views will fit the view to the entire Scene or just to visible object-Entitys.

Entitys are visible objects when Entity.isObject and Entity.visible are both true.

Returns boolean
True when fitting only visible object-Entitys.

getSynchProjection

getSynchProjection(): boolean

- Defined in plugins/NavCubePlugin/NavCubePlugin.d.ts:159
Gets whether the NavCube switches between perspective and orthographic projections in synchrony with the Camera. When false, the NavCube will always be rendered with perspective projection.

Returns boolean
True when NavCube projection is synchronized with Camera.projection.

getVisible

getVisible(): boolean

- Defined in plugins/NavCubePlugin/NavCubePlugin.d.ts:67
Gets if the NavCube is visible.

Returns boolean
True when the NavCube is visible.

log

log(msg: string): void

Inherited from Plugin.log
- Defined in viewer/Plugin.d.ts:49
Logs a message to the JavaScript developer console, prefixed with the ID of this Plugin.

Parameters
- msg: string
  
  The error message
Returns void

on

on(event: string, callback: () => void): void

Inherited from Plugin.on
- Defined in viewer/Plugin.d.ts:35
Subscribes to an event fired at this Plugin.

Parameters
- event: string
  
  The event
- callback: () => void
  
  Callback fired on the event
  - - (): void
    - Returns void
Returns void

setCameraFitFOV

setCameraFitFOV(value: number): void

- Defined in plugins/NavCubePlugin/NavCubePlugin.d.ts:115
Sets how much of the field-of-view, in degrees, that the Scene should fill the canvas when flying or jumping the Camera to each selected axis or diagonal.

Default value is 45.

Parameters
- value: number
  
  New FOV value.
Returns void

setCameraFly

setCameraFly(value: boolean): void

- Defined in plugins/NavCubePlugin/NavCubePlugin.d.ts:96
Sets whether the Camera flies or jumps to each selected axis or diagonal.

Default is true, to fly.

Parameters
- value: boolean
  
  Set true to fly, else false to jump.
Returns void

setCameraFlyDuration

setCameraFlyDuration(value: boolean): void

- Defined in plugins/NavCubePlugin/NavCubePlugin.d.ts:134
When flying the Camera to each new axis or diagonal, sets how long, in seconds, that the Camera takes to get there.

Default is 0.5.

Parameters
- value: boolean
  
  Camera flight duration in seconds.
Returns void

setFitVisible

setFitVisible(value: boolean): void

- Defined in plugins/NavCubePlugin/NavCubePlugin.d.ts:77
Sets whether the axis, corner and edge-aligned views will fit the view to the entire Scene or just to visible object-Entitys.

Entitys are visible objects when Entity.isObject and Entity.visible are both true.

Parameters
- value: boolean
  
  Set true to fit only visible object-Entitys.
Returns void

setSynchProjection

setSynchProjection(value: boolean): void

- Defined in plugins/NavCubePlugin/NavCubePlugin.d.ts:151
Sets whether the NavCube switches between perspective and orthographic projections in synchrony with the Camera. When false, the NavCube will always be rendered with perspective projection.

Parameters
- value: boolean
  
  Set true to keep NavCube projection synchronized with Camera.projection.
Returns void

setVisible

setVisible(value?: boolean): void

- Defined in plugins/NavCubePlugin/NavCubePlugin.d.ts:60
Sets if the NavCube is visible.

Parameters
- Optional value: boolean
  
  Whether or not the NavCube is visible.
Returns void

warn

warn(msg: string): void

Inherited from Plugin.warn
- Defined in viewer/Plugin.d.ts:56
Logs a warning message to the JavaScript developer console, prefixed with the ID of this Plugin.

Parameters
- msg: string
  
  The error message
Returns void

Generated using TypeDoc