Class PivotEditPlugin

PivotEditPlugin provides interactive pivot point (origin) editing for objects. Toggle "Edit Pivot" mode to show a translate-only gizmo at the object's pivot. Dragging moves only the pivot while the object mesh stays visually in place.

Works alongside both TransformControlsPlugin and PivotControlsPlugin.

Hierarchy (View Summary)

AViewerPluginSync
- PivotEditPlugin

Constructors

constructor

new PivotEditPlugin(enabled?: boolean): PivotEditPlugin
Parameters
- enabled: boolean = true
Returns PivotEditPlugin
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/interaction/PivotEditPlugin.ts:53

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: { preFrame: () => void } = ...

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

dependencies

dependencies: typeof PickingPlugin[] = ...

editPivot

editPivot: boolean = false

enabled

enabled: boolean = true

isViewerPluginSync

isViewerPluginSync: true = ...

markerColor

markerColor: number = 0xffff00

markerScale

markerScale: number = 0.5

showPivotMarker

showPivotMarker: boolean = true

toJSON

toJSON: any = undefined

`Optional`uiConfig

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

`Optional`undoManager

undoManager?: JSUndoManager

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "PivotEditPlugin" = 'PivotEditPlugin'

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,
): null | PivotEditPlugin | Promise<null | PivotEditPlugin>
Parameters
- data: ISerializedConfig
- Optionalmeta: SerializationMetaType
Returns null | PivotEditPlugin | Promise<null | PivotEditPlugin>
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

pivotToPoint

pivotToPoint(point: Vector3): void
Parameters
- point: Vector3
Returns void
- Defined in src/plugins/interaction/PivotEditPlugin.ts:199

`Optional`setDirty

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

Class PivotEditPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PivotEditPlugin

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

constructor

dependencies

editPivot

enabled

isViewerPluginSync

markerColor

markerScale

showPivotMarker

toJSON

OptionaluiConfig

OptionalundoManager

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 null | PivotEditPlugin | Promise<null | PivotEditPlugin>

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

pivotToBottom

Returns void

pivotToCenter

Returns void

pivotToOrigin

Returns void

pivotToPoint

Parameters

Returns void

OptionalsetDirty

Parameters

Returns any

Settings

On This Page

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Optional`uiConfig

`Optional`undoManager

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey

`Optional`setDirty