Class WatchHandsPlugin

Hierarchy

AViewerPluginSync
- WatchHandsPlugin

Index

Constructors

constructor

new WatchHandsPlugin(): WatchHandsPlugin
Creates THREE.EventDispatcher | EventDispatcher object.

Returns WatchHandsPlugin
Inherited from AViewerPluginSync.constructor
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:55

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}

analog

analog: boolean = true

axis

axis: "x" | "y" | "z" = 'y'

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

dependencies

dependencies: never[] = []

enabled

enabled: boolean = true

hands

hands: { object: Object3D; type: "hour" | "minute" | "second" }[] = []

hour

hour: string = '.*hour.*'

hourOffset

hourOffset: number = 0

invertAxis

invertAxis: boolean = false

isViewerPluginSync

isViewerPluginSync: true = ...

minute

minute: string = '.*minute.*'

minuteOffset

minuteOffset: number = 0

regex

regex: boolean = true

second

second: string = '.*second.*'

secondOffset

secondOffset: number = 0

`Optional`uiConfig

uiConfig?: UiObjectConfig<any, string, any> = undefined

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "WatchHandsPlugin" = 'WatchHandsPlugin'

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:113
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:117

Methods

`Protected`_onViewerEvent

_onViewerEvent(e: IViewerEvent): IViewerEvent
Parameters
- e: IViewerEvent
Returns IViewerEvent
Inherited from AViewerPluginSync._onViewerEvent
- Defined in src/viewer/AViewerPlugin.ts:69

`Protected`_storeKey

_storeKey(prefix?: string): string
Parameters
- Optionalprefix: string
Returns string
Inherited from AViewerPluginSync._storeKey
- Defined in src/viewer/AViewerPlugin.ts:55

disable

disable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:76

dispose

dispose(): void
Returns void
Inherited from AViewerPluginSync.dispose
- Defined in src/viewer/AViewerPlugin.ts:35

enable

enable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:81

exportState

exportState(): ISerializedConfig | Record<string, never>
Returns ISerializedConfig | Record<string, never>
Inherited from AViewerPluginSync.exportState
- Defined in src/viewer/AViewerPlugin.ts:60

fromJSON

fromJSON(
data: ISerializedConfig,
meta?: SerializationMetaType,
): WatchHandsPlugin | Promise<WatchHandsPlugin | null> | null
Parameters
- data: ISerializedConfig
- Optionalmeta: SerializationMetaType
Returns WatchHandsPlugin | Promise<WatchHandsPlugin | null> | null
Inherited from AViewerPluginSync.fromJSON
- Defined in src/viewer/AViewerPlugin.ts:47

importState

importState(state: any): Promise<void>
Parameters
- state: any
Returns Promise<void>
Inherited from AViewerPluginSync.importState
- Defined in src/viewer/AViewerPlugin.ts:63

isDisabled

isDisabled(): boolean
Returns boolean
Inherited from AViewerPluginSync.isDisabled
- Defined in src/viewer/AViewerPlugin.ts:86

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in plugins/webgi-plugins/src/plugins/extras/WatchHandsPlugin.ts:70

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in plugins/webgi-plugins/src/plugins/extras/WatchHandsPlugin.ts:75

refresh

refresh(): void
Returns void
- Defined in plugins/webgi-plugins/src/plugins/extras/WatchHandsPlugin.ts:133

`Optional`setDirty

setDirty?(...args: any[]): any
Parameters
- ...args: any[]
Returns any
Inherited from AViewerPluginSync.setDirty
- Defined in src/viewer/AViewerPlugin.ts:90

toJSON

toJSON(meta?: SerializationMetaType): ISerializedConfig
Parameters
- Optionalmeta: SerializationMetaType
Returns ISerializedConfig
Inherited from AViewerPluginSync.toJSON
- Defined in src/viewer/AViewerPlugin.ts:39

Class WatchHandsPlugin

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns WatchHandsPlugin

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

analog

axis

constructor

dependencies

enabled

hands

hour

hourOffset

invertAxis

isViewerPluginSync

minute

minuteOffset

regex

second

secondOffset

OptionaluiConfig

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

Methods

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns WatchHandsPlugin | Promise<WatchHandsPlugin | null> | null

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

refresh

Returns void

OptionalsetDirty

Parameters

Returns any

toJSON

Parameters

Returns ISerializedConfig

Settings

On This Page

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Optional`uiConfig

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey

`Optional`setDirty