Class SAO

Configures Scalable Ambient Obscurance (SAO) for a View.

Located at View.sao.
View will apply SAO when View.renderMode is set to one of the values specified in SAO.renderModes.

See @xeokit/sdk/viewer for usage info.

Hierarchy (View Summary)

Component
- SAO

Index

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 SAO belongs.

Accessors

applied

get applied(): boolean
Gets if SAO is currently applied.

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

Returns boolean
- Defined in packages/sdk/src/viewer/SAO.ts:346

bias

get bias(): number
Gets the SAO bias.

Default value is 0.5.

Returns number
- Defined in packages/sdk/src/viewer/SAO.ts:162
set bias(value: number): void
Sets the SAO bias.

Default value is 0.5.
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewer/SAO.ts:171

blendCutoff

get blendCutoff(): number
Gets the SAO blend cutoff.

Default value is 0.3.

Normally you don't need to alter this.

Returns number
- Defined in packages/sdk/src/viewer/SAO.ts:289
set blendCutoff(value: number): void
Sets the SAO blend cutoff.

Default value is 0.3.

Normally you don't need to alter this.
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewer/SAO.ts:300

blendFactor

get blendFactor(): number
Gets the SAO blend scale.

Default value is 1.0.

Normally you don't need to alter this.

Returns number
- Defined in packages/sdk/src/viewer/SAO.ts:318
set blendFactor(value: number): void
Sets the SAO blend factor.

Default value is 1.0.

Normally you don't need to alter this.
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewer/SAO.ts:329

blur

get blur(): boolean
Gets whether Guassian blur is enabled.

Default value is true.

Returns boolean
- Defined in packages/sdk/src/viewer/SAO.ts:264
set blur(value: boolean): void
Sets whether Guassian blur is enabled.

Default value is true.
Parameters
- value: boolean
Returns void
- Defined in packages/sdk/src/viewer/SAO.ts:273

intensity

get intensity(): number
Gets the degree of darkening (ambient obscurance) produced by the SAO effect.

Default value is 0.15.

Returns number
- Defined in packages/sdk/src/viewer/SAO.ts:137
set intensity(value: number): void
Sets the degree of darkening (ambient obscurance) produced by the SAO effect.

Default value is 0.15.
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewer/SAO.ts:146

kernelRadius

get kernelRadius(): number
Gets the maximum area that SAO takes into account when checking for possible occlusion for each fragment.

Default value is 100.0.

Returns number
- Defined in packages/sdk/src/viewer/SAO.ts:112
set kernelRadius(value: number): void
Sets the maximum area that SAO takes into account when checking for possible occlusion for each fragment.

Default value is 100.0.
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewer/SAO.ts:121

minResolution

get minResolution(): number
Gets the SAO minimum resolution.

Default value is 0.0.

Returns number
- Defined in packages/sdk/src/viewer/SAO.ts:212
set minResolution(value: number): void
Sets the SAO minimum resolution.

Default value is 0.0.
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewer/SAO.ts:221

numSamples

get numSamples(): number
Gets the number of SAO samples.

Default value is 10.

Returns number
- Defined in packages/sdk/src/viewer/SAO.ts:237
set numSamples(value: number): void
Sets the number of SAO samples.

Default value is 10.

Update this sparingly, since it causes a shader recompile.
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewer/SAO.ts:248

renderModes

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

The View will apply SAO whenever View.renderMode has been set one of these values.

Default value is [QualityRender].

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

The View will apply SAO whenever View.renderMode has been set one of these values.

Default value is [QualityRender].
Parameters
- value: number[]
Returns void
- Defined in packages/sdk/src/viewer/SAO.ts:63

scale

get scale(): number
Gets the SAO occlusion scale.

Default value is 1.0.

Returns number
- Defined in packages/sdk/src/viewer/SAO.ts:187
set scale(value: number): void
Sets the SAO occlusion scale.

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

supported

get supported(): boolean
Gets whether SAO is supported by this browser and GPU.

Even when enabled, SAO will only work if supported.

Returns boolean
- Defined in packages/sdk/src/viewer/SAO.ts:84

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(saoParams: SAOParams): void
Configures this SAO.
Parameters
- saoParams: SAOParams
Returns void
- Defined in packages/sdk/src/viewer/SAO.ts:378

`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(): SAOParams
Gets the current configuration of this SAO.

Returns SAOParams
- Defined in packages/sdk/src/viewer/SAO.ts:358

`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.

Class SAO

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Events

Properties

destroyed

Protecteddirty

id

Readonlyview

Accessors

applied

Returns boolean

bias

Returns number

Parameters

Returns void

blendCutoff

Returns number

Parameters

Returns void

blendFactor

Returns number

Parameters

Returns void

blur

Returns boolean

Parameters

Returns void

intensity

Returns number

Parameters

Returns void

kernelRadius

Returns number

Parameters

Returns void

minResolution

Returns number

Parameters

Returns void

numSamples

Returns number

Parameters

Returns void

renderModes

Returns number[]

Parameters

Returns void

scale

Returns number

Parameters

Returns void

supported

Returns boolean

Methods

Protectedclean

Returns void

ProtectedcleanIfDirty

Returns void

Protectederror

Parameters

Returns void

fromParams

Parameters

Returns void

Protectedlog

Parameters

Returns void

ProtectedsetDirty

Returns void

toParams

Returns SAOParams

Protectedwarn

Parameters

Returns void

Events

onDestroyed

`Protected`dirty

`Readonly`view

`Protected`clean

`Protected`cleanIfDirty

`Protected`error

`Protected`log

`Protected`setDirty

`Protected`warn