Skip to main content

Class: ObjectRotationPlugin

Plugins.ObjectRotationPlugin

Hierarchy​

Properties​

PluginType​

▪ Static Readonly PluginType: "ObjectRotationPlugin"


enabled​

• enabled: boolean

Overrides​

AViewerPlugin.enabled


rotations​

• rotations: number = 1


axis​

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


skips​

• skips: string = ''


_dirty​

• Protected _dirty: boolean = false

Inherited from​

AViewerPlugin._dirty


_viewer​

• Protected Optional _viewer: ViewerApp

Inherited from​

AViewerPlugin._viewer

Accessors​

dirty​

• get dirty(): boolean

Returns​

boolean

Inherited from​

AViewerPlugin.dirty

• set dirty(value): void

Parameters​

NameType
valueboolean

Returns​

void

Inherited from​

AViewerPlugin.dirty


viewer​

• get viewer(): undefined | ViewerApp

Returns​

undefined | ViewerApp

Inherited from​

AViewerPlugin.viewer

Methods​

onDispose​

▸ onDispose(viewer): Promise<void>

Parameters​

NameType
viewerViewerApp

Returns​

Promise<void>

Inherited from​

AViewerPlugin.onDispose


onRemove​

▸ onRemove(viewer): Promise<void>

Parameters​

NameType
viewerViewerApp

Returns​

Promise<void>

Inherited from​

AViewerPlugin.onRemove


toJSON​

▸ toJSON(meta?): any

Parameters​

NameType
meta?any

Returns​

any

Inherited from​

AViewerPlugin.toJSON


fromJSON​

▸ fromJSON(data, meta?): null | ObjectRotationPlugin | Promise<null | ObjectRotationPlugin>

Parameters​

NameType
dataany
meta?any

Returns​

null | ObjectRotationPlugin | Promise<null | ObjectRotationPlugin>

Inherited from​

AViewerPlugin.fromJSON


exportState​

▸ exportState(): any

Returns​

any

Inherited from​

AViewerPlugin.exportState


importState​

▸ importState(state): Promise<void>

Parameters​

NameType
stateany

Returns​

Promise<void>

Inherited from​

AViewerPlugin.importState


storeState​

▸ storeState(prefix?, storage?, data?): void

Parameters​

NameType
prefix?string
storage?Storage
data?any

Returns​

void

Inherited from​

AViewerPlugin.storeState


loadState​

▸ loadState(prefix?, storage?): Promise<void>

Parameters​

NameType
prefix?string
storage?Storage

Returns​

Promise<void>

Inherited from​

AViewerPlugin.loadState


onAdded​

▸ onAdded(v): Promise<void>

Parameters​

NameType
vViewerApp

Returns​

Promise<void>

Overrides​

AViewerPlugin.onAdded


_storeKey​

▸ Protected _storeKey(prefix?): string

Parameters​

NameType
prefix?string

Returns​

string

Inherited from​

AViewerPlugin._storeKey

Constructors​

constructor​

• new ObjectRotationPlugin(enabled?)

Parameters​

NameTypeDefault value
enabledbooleantrue

Overrides​

AViewerPlugin.constructor