Class: PosePlugin

Plugins.PosePlugin

Hierarchy

• AViewerPlugin<"">

  ↳ PosePlugin

Properties

PluginType

▪ Static Readonly PluginType: "PosePlugin"

---

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

---

toJSON

• toJSON: any = undefined

Overrides

AViewerPlugin.toJSON

---

autoUpdateGround

• autoUpdateGround: boolean = true

---

_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

Name	Type
value	boolean

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

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | PosePlugin | Promise<null | PosePlugin>

Inherited from

AViewerPlugin.fromJSON

---

exportState

▸ exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

AViewerPlugin.storeState

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

---

computeStablePoses

▸ computeStablePoses(object): { distance: number = dist; faceNormal: Vector3 = normal; area: number = area; face: Face = face; maxEdgeLength: number = maxEdgeData.maxEdgeLength; xform: Matrix4 = rotTransform1; edgePoint: Vector3 = edgePoint }[]

Parameters

Name	Type
object	Object3D<Object3DEventMap>

Returns

{ distance: number = dist; faceNormal: Vector3 = normal; area: number = area; face: Face = face; maxEdgeLength: number = maxEdgeData.maxEdgeLength; xform: Matrix4 = rotTransform1; edgePoint: Vector3 = edgePoint }[]

---

setMostStablePose

▸ setMostStablePose(object): undefined | () => void | () => void | ...

Parameters

Name	Type
object	Object3D<Object3DEventMap>

Returns

undefined | () => void | () => void | ...

---

setVerticalPose

▸ setVerticalPose(object): undefined | () => void | () => void | ...

Parameters

Name	Type
object	Object3D<Object3DEventMap>

Returns

undefined | () => void | () => void | ...

---

setNextPose

▸ setNextPose(object): undefined | () => void | () => void | ...

Parameters

Name	Type
object	Object3D<Object3DEventMap>

Returns

undefined | () => void | () => void | ...

---

setPreviousPose

▸ setPreviousPose(object): undefined | () => void | () => void | ...

Parameters

Name	Type
object	Object3D<Object3DEventMap>

Returns

undefined | () => void | () => void | ...

---

setOriginalPose

▸ setOriginalPose(object): void

Parameters

Name	Type
object	Object3D<Object3DEventMap>

Returns

void

---

clearPoses

▸ clearPoses(object): void

Parameters

Name	Type
object	Object3D<Object3DEventMap>

Returns

void

---

setPose

▸ setPose(object, index): undefined | () => void | () => void | ...

Parameters

Name	Type
object	Object3D<Object3DEventMap>
index	number

Returns

undefined | () => void | () => void | ...

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

Constructors

constructor

• new PosePlugin()

Overrides

AViewerPlugin.constructor