Class ObjectPicker

Hierarchy

EventDispatcher<ObjectPickerEventMap>
- ObjectPicker

Constructors

constructor

new ObjectPicker(
    root: IObject3D,
    domElement: HTMLElement,
    camera: ICamera,
    selectionCondition?: (o: IObject3D) => boolean,
): ObjectPicker
Parameters
- root: IObject3D
- domElement: HTMLElement
- camera: ICamera
- OptionalselectionCondition: (o: IObject3D) => boolean
Returns ObjectPicker
Overrides EventDispatcher<ObjectPickerEventMap>.constructor
- Defined in src/three/utils/ObjectPicker.ts:68

Properties

cursorStyles

cursorStyles: { default: string; down: string }

domElement

domElement: HTMLElement

extraObjects

extraObjects: IObject3D<
    IObject3DEventMap,
    undefined
    | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
    undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
>[] = []

hoverEnabled

hoverEnabled: boolean = false

mouse

mouse: Vector2

multiSelectEnabled

multiSelectEnabled: boolean = true

Allow selecting multiple objects with Shift/Ctrl+Click.

pickingMode

pickingMode: PickingModeType = 'auto'

raycaster

raycaster: Raycaster

selectionCondition

selectionCondition: (o: IObject3D) => boolean

selectionMode

selectionMode: SelectionModeType = 'object'

`Optional`undoManager

undoManager?: JSUndoManager

`Static`PointerClickMaxDistance

PointerClickMaxDistance: number = 0.1

Distance threshold for a pointer click event

`Static`PointerClickMaxTime

PointerClickMaxTime: number = 200

Time threshold for a pointer click event

Accessors

camera

get camera(): ICamera<ICameraEventMap>
Returns ICamera<ICameraEventMap>
- Defined in src/three/utils/ObjectPicker.ts:120
set camera(value: ICamera<ICameraEventMap>): void
Parameters
- value: ICamera<ICameraEventMap>
Returns void
- Defined in src/three/utils/ObjectPicker.ts:124

hoverObject

get hoverObject(): SelectionObject
Returns SelectionObject
- Defined in src/three/utils/ObjectPicker.ts:206

isMouseDown

get isMouseDown(): boolean
Returns boolean
- Defined in src/three/utils/ObjectPicker.ts:235

mouseDownDeltaTime

get mouseDownDeltaTime(): number
Returns number
- Defined in src/three/utils/ObjectPicker.ts:239

selectedObject

get selectedObject(): SelectionObject
Returns SelectionObject
- Defined in src/three/utils/ObjectPicker.ts:128

selectedObjects

get selectedObjects(): SelectionObjectArr
Returns SelectionObjectArr
- Defined in src/three/utils/ObjectPicker.ts:132

time

get time(): number
Returns number
- Defined in src/three/utils/ObjectPicker.ts:230

Methods

`Protected`_onSelectedRemoved

_onSelectedRemoved(
    e: {
        target:
            | IMaterial<IMaterialEventMap>
            | IObject3D<
                IObject3DEventMap,
                undefined
                | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,

                    | undefined
                    | IMaterial<IMaterialEventMap>
                    | IMaterial<IMaterialEventMap>[],
            >;
    },
): void
Parameters
- e: {
      target:
          | IMaterial<IMaterialEventMap>
          | IObject3D<
              IObject3DEventMap,
              undefined
              | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
              undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
          >;
  }
Returns void
- Defined in src/three/utils/ObjectPicker.ts:140

checkIntersection

checkIntersection(): null | HitIntersects
Returns null | HitIntersects
- Defined in src/three/utils/ObjectPicker.ts:370

dispose

dispose(): void
Returns void
- Defined in src/three/utils/ObjectPicker.ts:107

isHovering

isHovering(): boolean
Returns boolean
- Defined in src/three/utils/ObjectPicker.ts:446

isSelected

isSelected(): boolean
Returns boolean
- Defined in src/three/utils/ObjectPicker.ts:450

setHoverObject

setHoverObject(
    object: SelectionObject,
    _record?: boolean,
    intersects?: HitIntersects,
): void
Parameters
- object: SelectionObject
- _record: boolean = true
- Optionalintersects: HitIntersects
Returns void
- Defined in src/three/utils/ObjectPicker.ts:211

setSelected

setSelected(
    object: SelectionObject,
    record?: boolean,
    intersects?: HitIntersects,
): void
Parameters
- object: SelectionObject
- record: boolean = true
- Optionalintersects: HitIntersects
Returns void
- Defined in src/three/utils/ObjectPicker.ts:148

updateMouseFromEvent

updateMouseFromEvent(event: PointerEvent): void
Parameters
- event: PointerEvent
Returns void
- Defined in src/three/utils/ObjectPicker.ts:272

Class ObjectPicker

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ObjectPicker

Properties

cursorStyles

domElement

extraObjects

hoverEnabled

mouse

multiSelectEnabled

pickingMode

raycaster

selectionCondition

selectionMode

OptionalundoManager

StaticPointerClickMaxDistance

StaticPointerClickMaxTime

Accessors

camera

Returns ICamera<ICameraEventMap>

Parameters

Returns void

hoverObject

Returns SelectionObject

isMouseDown

Returns boolean

mouseDownDeltaTime

Returns number

selectedObject

Returns SelectionObject

selectedObjects

Returns SelectionObjectArr

time

Returns number

Methods

Protected_onSelectedRemoved

Parameters

Returns void

checkIntersection

Returns null | HitIntersects

dispose

Returns void

isHovering

Returns boolean

isSelected

Returns boolean

setHoverObject

Parameters

Returns void

setSelected

Parameters

Returns void

updateMouseFromEvent

Parameters

Returns void

Settings

On This Page

`Optional`undoManager

`Static`PointerClickMaxDistance

`Static`PointerClickMaxTime

`Protected`_onSelectedRemoved