ADragInteraction | anigraphx-react

Hierarchy

ADragInteractionBase
- ADragInteraction

Constructors

constructor

new ADragInteraction(element: AReceivesInteractionsInterface, eventListeners?: AInteractionEventListener[], handle?: string): ADragInteraction

Inherited from ADragInteractionBase.constructor
- Defined in src/anigraph/ainteraction/AInteraction.ts:271
Parameters
- element: AReceivesInteractionsInterface
- Optional eventListeners: AInteractionEventListener[]
- Optional handle: string
Returns ADragInteraction

Properties

_dragCallbacks

_dragCallbacks: {} = {}

Type declaration

[name: string]: CallbackType

_dragSetCallback

_dragSetCallback: null | CallbackType

active

active: boolean

dragStartPosition

dragStartPosition: Vec2

element

element: AReceivesInteractionsInterface

element is typically the thing being interacted with. For example, if you are adding a click interaction to a THREE.Mesh, then the element would be the THREE.Mesh.

handle

handle: string

interactionState

interactionState: {} = {}

Type declaration

[name: string]: any

onlyOnFirstIntersection

onlyOnFirstIntersection: boolean = true

owner

owner: AControllerInterface<any>

owner is whatever holds the interactions.

Accessors

eventListeners

get eventListeners(): AInteractionEventListener[]

- Defined in src/anigraph/ainteraction/AInteraction.ts:262
Get eventListeners

Returns AInteractionEventListener[]

Methods

_addDragListeners

_addDragListeners(): void

Inherited from ADragInteractionBase._addDragListeners
- Defined in src/anigraph/ainteraction/ADragInteraction.ts:85
Returns void

_deactivateEventListeners

_deactivateEventListeners(): void

Inherited from ADragInteractionBase._deactivateEventListeners
- Defined in src/anigraph/ainteraction/AInteraction.ts:452
Returns void

_removeDragListeners

_removeDragListeners(): void

Inherited from ADragInteractionBase._removeDragListeners
- Defined in src/anigraph/ainteraction/ADragInteraction.ts:82
Returns void

_shouldIgnoreEvent

_shouldIgnoreEvent(event: InteractionEvent | Event): boolean

Inherited from ADragInteractionBase._shouldIgnoreEvent
- Defined in src/anigraph/ainteraction/AInteraction.ts:238
Parameters
- event: InteractionEvent | Event
Returns boolean

_updateDragListeners

_updateDragListeners(): void

Inherited from ADragInteractionBase._updateDragListeners
- Defined in src/anigraph/ainteraction/ADragInteraction.ts:78
Returns void

activate

activate(): void

Inherited from ADragInteractionBase.activate
- Defined in src/anigraph/ainteraction/ADragInteraction.ts:25
Returns void

addDOMEventListener

addDOMEventListener(eventType: string, callback: (...args: any[]) => any, options?: boolean | AddEventListenerOptions): { addListener: () => void; eventType: string; removeListener: () => void }

Inherited from ADragInteractionBase.addDOMEventListener
- Defined in src/anigraph/ainteraction/AInteraction.ts:412
Parameters
- eventType: string
- callback: (...args: any[]) => any
  - - (...args: any[]): any
    - Parameters
      - Rest ...args: any[]
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns { addListener: () => void; eventType: string; removeListener: () => void }
- addListener: () => void
  - - (): void
    - Returns void
- eventType: string
- removeListener: () => void
  - - (): void
    - Returns void

addEventListener

addEventListener(eventType: string, callback: (...args: any[]) => any): { addListener: () => void; eventType: string; removeListener: () => void }

Inherited from ADragInteractionBase.addEventListener
- Defined in src/anigraph/ainteraction/AInteraction.ts:281
Parameters
- eventType: string
- callback: (...args: any[]) => any
  - - (...args: any[]): any
    - Parameters
      - Rest ...args: any[]
      Returns any
Returns { addListener: () => void; eventType: string; removeListener: () => void }
- addListener: () => void
  - - (): void
    - Returns void
- eventType: string
- removeListener: () => void
  - - (): void
    - Returns void

addSceneEventListener

addSceneEventListener(eventType: string, callback: (...args: any[]) => any, options?: boolean | AddEventListenerOptions): { addListener: () => void; eventType: string; removeListener: () => void }

Inherited from ADragInteractionBase.addSceneEventListener
- Defined in src/anigraph/ainteraction/AInteraction.ts:378
Parameters
- eventType: string
- callback: (...args: any[]) => any
  - - (...args: any[]): any
    - Parameters
      - Rest ...args: any[]
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns { addListener: () => void; eventType: string; removeListener: () => void }
- addListener: () => void
  - - (): void
    - Returns void
- eventType: string
- removeListener: () => void
  - - (): void
    - Returns void

bindMethods

bindMethods(): void

Inherited from ADragInteractionBase.bindMethods
- Defined in src/anigraph/ainteraction/AInteraction.ts:277
Returns void

callDragEndCallback

callDragEndCallback(event: any): any

Inherited from ADragInteractionBase.callDragEndCallback
- Defined in src/anigraph/ainteraction/ADragInteraction.ts:74
Parameters
- event: any
Returns any

callDragMoveCallback

callDragMoveCallback(event: any): any

Inherited from ADragInteractionBase.callDragMoveCallback
- Defined in src/anigraph/ainteraction/ADragInteraction.ts:58
Parameters
- event: any
Returns any

callDragStartCallback

callDragStartCallback(event: any): any

Inherited from ADragInteractionBase.callDragStartCallback
- Defined in src/anigraph/ainteraction/ADragInteraction.ts:46
Parameters
- event: any
Returns any

clearEventListeners

clearEventListeners(): void

Inherited from ADragInteractionBase.clearEventListeners
- Defined in src/anigraph/ainteraction/AInteraction.ts:458
Returns void

clearInteractionState

clearInteractionState(): void

Inherited from ADragInteractionBase.clearInteractionState
- Defined in src/anigraph/ainteraction/AInteraction.ts:220
Returns void

deactivate

deactivate(): void

Inherited from ADragInteractionBase.deactivate
- Defined in src/anigraph/ainteraction/ADragInteraction.ts:32
Returns void

dispose

dispose(): void

Inherited from ADragInteractionBase.dispose
- Defined in src/anigraph/ainteraction/ADragInteraction.ts:19
Returns void

getDragEndCallback

getDragEndCallback(): CallbackType

Inherited from ADragInteractionBase.getDragEndCallback
- Defined in src/anigraph/ainteraction/ADragInteraction.ts:73
Returns CallbackType

getDragMoveCallback

getDragMoveCallback(): CallbackType

Inherited from ADragInteractionBase.getDragMoveCallback
- Defined in src/anigraph/ainteraction/ADragInteraction.ts:57
Returns CallbackType

getDragStartCallback

getDragStartCallback(): CallbackType

Inherited from ADragInteractionBase.getDragStartCallback
- Defined in src/anigraph/ainteraction/ADragInteraction.ts:45
Returns CallbackType

getInteractionState

getInteractionState(name: string): any

Inherited from ADragInteractionBase.getInteractionState
- Defined in src/anigraph/ainteraction/AInteraction.ts:217
Parameters
- name: string
Returns any

getSceneElement

getSceneElement(): Scene

Inherited from ADragInteractionBase.getSceneElement
- Defined in src/anigraph/ainteraction/AInteraction.ts:248
Returns Scene

getWindowElement

getWindowElement(): Window & typeof globalThis

Inherited from ADragInteractionBase.getWindowElement
- Defined in src/anigraph/ainteraction/AInteraction.ts:244
Returns Window & typeof globalThis

setDragEndCallback

setDragEndCallback(dragEndCallback?: CallbackType): void

Inherited from ADragInteractionBase.setDragEndCallback
- Defined in src/anigraph/ainteraction/ADragInteraction.ts:62
Parameters
- Optional dragEndCallback: CallbackType
Returns void

setDragMoveCallback

setDragMoveCallback(dragMoveCallback: CallbackType): void

Inherited from ADragInteractionBase.setDragMoveCallback
- Defined in src/anigraph/ainteraction/ADragInteraction.ts:50
Parameters
- dragMoveCallback: CallbackType
Returns void

setDragStartCallback

setDragStartCallback(dragStartCallback: CallbackType): void

Inherited from ADragInteractionBase.setDragStartCallback
- Defined in src/anigraph/ainteraction/ADragInteraction.ts:37
Parameters
- dragStartCallback: CallbackType
Returns void

setInteractionState

setInteractionState(name: string, value: any): void

Inherited from ADragInteractionBase.setInteractionState
- Defined in src/anigraph/ainteraction/AInteraction.ts:214
Parameters
- name: string
- value: any
Returns void

Static Create

Create(element: any, dragStartCallback: ADragInteractionCallback, dragMoveCallback: ADragInteractionCallback, dragEndCallback?: ADragInteractionCallback, handle?: string): ADragInteraction

- Defined in src/anigraph/ainteraction/ADragInteraction.ts:155
Adds a drag interaction to a specified threejs object with the given callbacks. Most of the time you probably want to leave out the handle argument, unless you know what you are doing and it's for debugging.

Parameters
- element: any
  
  a THREE.Object3D, (or Mesh, or any other object that inherits THREE.Object3D)
- dragStartCallback: ADragInteractionCallback
- dragMoveCallback: ADragInteractionCallback
- Optional dragEndCallback: ADragInteractionCallback
- Optional handle: string
Returns ADragInteraction

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

element: AReceivesInteractionsInterface

Optional eventListeners: AInteractionEventListener[]

Optional handle: string

Returns ADragInteraction

Properties

_dragCallbacks

Type declaration

[name: string]: CallbackType

_dragSetCallback

Protected _eventListeners

_mouseDownEventListener

_mouseMoveEventListener

_mouseUpEventListener

active

dragStartPosition

element

handle

interactionState

Type declaration

[name: string]: any

onlyOnFirstIntersection

owner

Accessors

eventListeners

Returns AInteractionEventListener[]

Methods

_addDragListeners

Returns void

_deactivateEventListeners

Returns void

_removeDragListeners

Returns void

_shouldIgnoreEvent

Parameters

event: InteractionEvent | Event

Returns boolean

_updateDragListeners

Returns void

activate

Returns void

addDOMEventListener

Parameters

eventType: string

callback: (...args: any[]) => any

Parameters

Rest ...args: any[]

Returns any

Optional options: boolean | AddEventListenerOptions

Returns { addListener: () => void; eventType: string; removeListener: () => void }

addListener: () => void

Returns void

eventType: string

removeListener: () => void

Returns void

addEventListener

Parameters

eventType: string

callback: (...args: any[]) => any

Parameters

Rest ...args: any[]

Returns any

Returns { addListener: () => void; eventType: string; removeListener: () => void }

addListener: () => void

Returns void

eventType: string

removeListener: () => void

Returns void

addSceneEventListener

Parameters

eventType: string

callback: (...args: any[]) => any