ThreePipe
    Preparing search index...

    Class PickingPlugin

    Base Class for Sync Viewer Plugins

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _dirty _viewer? _viewerListeners autoApplyMaterialOnDrop autoFocus autoFocusHover constructor dependencies duplicateMode enabled isViewerPluginSync materialTypes multiSelectEnabled selectionMode uiConfig widgetEnabled OldPluginType PluginType

    Accessors

    dirty hoverEnabled picker widget

    Methods

    _onViewerEvent _storeKey _widgetEnabledChange canRemoveMaterial clearSelection copySelected cutSelected deleteSelected disable dispose duplicateSelected enable exportState focusObject focusSelected fromJSON getPlaceholderMaterial getSelectedObject getSelectedObjects importState isDisabled objectMaterialManageUiConfig objectSelectionUiConfig onAdded onRemove pasteFromClipboard refreshUiChildren removeMaterial resetTransform selectAll setDirty setSelectedObject toggleSelectedObject toggleVisibilitySelected toJSON unhideAll

    Constructors

    Properties

    Protected_dirty

    _dirty: boolean = false

    Protected Optional_viewer

    _viewer?: ThreeViewer

    Protected_viewerListeners

    _viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}
    autoApplyMaterialOnDrop: boolean = true
    autoFocus: boolean
    autoFocusHover: boolean = false
    constructor: typeof AViewerPluginSync & typeof AViewerPlugin
    dependencies: typeof CameraViewPlugin[] = ...
    duplicateMode: DuplicateMode = 'simple'

    Duplicate offset mode:

    • simple: position/rotation/scale applied independently (Figma-style, straight lines)
    • compound: full matrix delta (circular arrays, spirals)
    enabled: boolean = true
    isViewerPluginSync: true = ...
    materialTypes: (
        | {
            cls: typeof UnlitMaterial;
            def: UnlitMaterial<IMaterialEventMap>;
            line?: undefined;
            name: string;
        }
        | {
            cls: typeof UnlitLineMaterial;
            def: UnlitLineMaterial<IMaterialEventMap>;
            line: boolean;
            name: string;
        }
        | {
            cls: typeof LineMaterial2;
            def: LineMaterial2<IMaterialEventMap>;
            line: boolean;
            name: string;
        }
        | {
            cls: typeof PhysicalMaterial;
            def?: undefined;
            line?: undefined;
            name: string;
        }
    )[] = ...
    multiSelectEnabled: boolean = true
    selectionMode: "object" | "material" | "texture" | "geometry" = 'object'
    uiConfig: UiObjectConfig = ...
    widgetEnabled: boolean = true

    Note: this is for runtime use only, not serialized

    OldPluginType: "PickingPlugin" = 'PickingPlugin'
    PluginType: "Picking" = 'Picking'

    Accessors

    Methods

    Protected_onViewerEvent

    Protected_storeKey

    Protected_widgetEnabledChange

    • Reset position, rotation, or scale of selected objects to identity. All resets are in local space and undoable.

      Parameters

      • component: "rotation" | "scale" | "position"

      Returns void

    • Toggle visibility of selected objects based on primary selected object's state. If primary is visible → hide all selected. If primary is hidden → show all selected.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods