Class ObjectPicker

constructor

• new ObjectPicker(root, domElement, camera, selectionCondition?): ObjectPicker

• Parameters

  • root: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

  • domElement: HTMLElement

  • camera: ICamera<ICameraEvent, ICameraEventTypes>

  • Optional selectionCondition: ((o) => boolean)

    • • (o): boolean

      • Parameters

        • o: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

        Returns boolean

  Returns ObjectPicker

cursorStyles

domElement

hoverEnabled

mouse

raycaster

selectionCondition

camera

• get camera(): ICamera<ICameraEvent, ICameraEventTypes>

• Returns ICamera<ICameraEvent, ICameraEventTypes>

• set camera(value): void

• Parameters

  • value: ICamera<ICameraEvent, ICameraEventTypes>

  Returns void

hoverObject

• get hoverObject(): null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]

• Returns null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]

• set hoverObject(object): void

• Parameters

  • object: null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]

  Returns void

isMouseDown

• get isMouseDown(): boolean

• Returns boolean

mouseDownDeltaTime

• get mouseDownDeltaTime(): number

• Returns number

selectedObject

• get selectedObject(): null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

• Returns null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

• set selectedObject(object): void

• Parameters

  • object: null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

  Returns void

time

• get time(): number

• Returns number

checkIntersection

• checkIntersection(): null | {
      intersect: Intersection<IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>>;
      intersects: Intersection<IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>>[];
      mouse: Vector2Tuple;
      selectedObject: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>;
  }

• Returns null | {
      intersect: Intersection<IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>>;
      intersects: Intersection<IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>>[];
      mouse: Vector2Tuple;
      selectedObject: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>;
  }

dispose

• dispose(): void

• Returns void

isHovering

• isHovering(): boolean

• Returns boolean

isSelected

• isSelected(): boolean

• Returns boolean

updateMouseFromEvent

• updateMouseFromEvent(event): void

• Parameters

  • event: PointerEvent

  Returns void