Class ResolutionScale

Configures canvas resolution scaling for a View.

Located at View.resolutionScale.
Resolution scaling reduces the pixel resolution of a View's canvas to improve its frame rate, typically applied temporarily during camera movement to enhance responsiveness.
View will apply resulotion scaling when View.renderMode is set to one of the values specified in ResolutionScale.renderModes.

See @xeokit/sdk/viewer for usage info.

Hierarchy (View Summary)

Component
- ResolutionScale

Index

Properties

destroyed dirty id view

Accessors

applied renderModes resolutionScale

Methods

clean cleanIfDirty error fromParams log setDirty toParams warn

Events

Properties

destroyed

destroyed: boolean

True once this Component has been destroyed.

Don't use this Component if this is true.

`Protected`dirty

dirty: boolean

id

id: string

Unique ID of this Component.

`Readonly`view

view: View

The View to which this ResolutionScale belongs.

Accessors

applied

get applied(): boolean
Gets if resolution scaling is currently applied.

This is true when View.renderMode is in ResolutionScale.renderModes.

Returns boolean
- Defined in packages/sdk/src/viewer/ResolutionScale.ts:133

renderModes

get renderModes(): number[]
Gets which rendering modes in which to apply ResolutionScale.

Default value is [FastRender].

Returns number[]
- Defined in packages/sdk/src/viewer/ResolutionScale.ts:101
set renderModes(value: number[]): void
Sets which rendering modes in which to apply ResolutionScale.

Default value is [FastRender].
Parameters
- value: number[]
Returns void
- Defined in packages/sdk/src/viewer/ResolutionScale.ts:91

resolutionScale

get resolutionScale(): number
Gets the scale when ResolutionScale is applied.

Default is 1.0.

Returns number
- Defined in packages/sdk/src/viewer/ResolutionScale.ts:123
set resolutionScale(value: number): void
Sets the scale when ResolutionScale is applied.

Default is 1.0.
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewer/ResolutionScale.ts:110

Methods

`Protected`clean

clean(): void
Forces this component to action any deferred state updates.

Returns void
Inherited from Component.clean
- Defined in packages/sdk/src/core/Component.ts:119

`Protected`cleanIfDirty

cleanIfDirty(): void
Gives this component an opportunity to action any defered state updates.

Returns void
Inherited from Component.cleanIfDirty
- Defined in packages/sdk/src/core/Component.ts:109

`Protected`error

error(message: string): void
Protected
Logs an error for this component to the JavaScript console.

The console message will have this format: [ERROR] [<component type> =<component id>: <message>
Parameters
- message: string
  The error message to log
Returns void
Inherited from Component.error
- Defined in packages/sdk/src/core/Component.ts:95

fromParams

fromParams(resolutionScaleParams: ResolutionScaleParams): void
Configures this ResolutionScale.
Parameters
- resolutionScaleParams: ResolutionScaleParams
Returns void
- Defined in packages/sdk/src/viewer/ResolutionScale.ts:147

`Protected`log

log(message: string): void
Protected
Logs a message for this component.

The message will have this format: [LOG] [<component type> <component id>: <message>
Parameters
- message: string
  The message to log
Returns void
Inherited from Component.log
- Defined in packages/sdk/src/core/Component.ts:71

`Protected`setDirty

setDirty(): void
Flags this component as having a defered state updates it needs to perform.

Returns void
Inherited from Component.setDirty
- Defined in packages/sdk/src/core/Component.ts:102

toParams

toParams(): ResolutionScaleParams
Gets the current configuration of this ResolutionScale.

Returns ResolutionScaleParams
- Defined in packages/sdk/src/viewer/ResolutionScale.ts:159

`Protected`warn

warn(message: string): void
Protected
Logs a warning for this component to the JavaScript console.

The console message will have this format: [WARN] [<component type> =<component id>: <message>
Parameters
- message: string
  The warning message to log
Returns void
Inherited from Component.warn
- Defined in packages/sdk/src/core/Component.ts:83

Events

onDestroyed

onDestroyed: EventEmitter<Component, null>

Emits an event when the Component has been destroyed.