Class ViewCullPlugin

Viewer plugin that performs view frustum culling to accelerate rendering performance.

Hierarchy

Plugin
- ViewCullPlugin

Index

Constructors

constructor

Properties

Accessors

enabled

Methods

Constructors

constructor

new ViewCullPlugin(viewer: Viewer, cfg?: ViewCullPluginConfiguration): ViewCullPlugin

Overrides Plugin.constructor
- Defined in plugins/ViewCullPlugin/ViewCullPlugin.d.ts:19
Parameters
- viewer: Viewer
  
  The Viewer.
- Optional cfg: ViewCullPluginConfiguration
  
  Plugin configuration.
Returns ViewCullPlugin

Properties

id

id: string

ID for this Plugin, unique within its Viewer.

viewer

viewer: Viewer

The Viewer that contains this Plugin.

Accessors

enabled

get enabled(): boolean
set enabled(arg: boolean): void

- Defined in plugins/ViewCullPlugin/ViewCullPlugin.d.ts:33
Gets whether view culling is enabled.

retutns
{Boolean} Whether view culling is enabled.

Returns boolean
- Defined in plugins/ViewCullPlugin/ViewCullPlugin.d.ts:26
Sets whether view culling is enabled.

Parameters
- arg: boolean
Returns void

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

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

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