Class Texturing

Configures whether a View shows textures on its ViewObjects.

Located at View.texturing.

See @xeokit/sdk/viewer for usage info.

Hierarchy (View Summary)

Component
- Texturing

Index

Properties

destroyed dirty id view

Accessors

applied enabled renderModes

Methods

clean cleanIfDirty error log setDirty 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 Texturing belongs.

Accessors

applied

get applied(): boolean
Gets if textures are currently applied.

This is true when Texturing.enabled is true and View.renderMode is in Texturing.renderModes.

Returns boolean
- Defined in packages/sdk/src/viewer/Texturing.ts:98

enabled

get enabled(): boolean
Gets if textures on ViewObjects are visible.

Default is true.

Returns boolean
- Defined in packages/sdk/src/viewer/Texturing.ts:87
set enabled(value: boolean): void
Sets if textures on ViewObjects are visible.

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

renderModes

get renderModes(): number[]
Gets which rendering modes in which to render textures.

Accepted modes are constants!QualityRender and constants!FastRender.

Default value is [constants!QualityRender].

Returns number[]
- Defined in packages/sdk/src/viewer/Texturing.ts:65
set renderModes(value: number[]): void
Sets which rendering modes in which to render textures.

Accepted modes are constants!QualityRender and constants!FastRender.

Default value is [constants!QualityRender].
Parameters
- value: number[]
Returns void
- Defined in packages/sdk/src/viewer/Texturing.ts:53

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

`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

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