Class GestureHandlers

GestureHandlers is the means by which a programmer can attach to an Entity code to run in response to each of the gestures that JetLag supports.

Index

Constructors

constructor

Properties

mouseHover? mouseUnHover? panMove? panStart? panStop? swipe? tap? touchDown? touchUp?

Constructors

constructor

new GestureHandlers(): GestureHandlers
Returns GestureHandlers

Properties

`Optional` mouseHover

mouseHover?: ((actor, worldCoords) => boolean)

code to run when the mouse hovers over the actor

Type declaration

- (actor, worldCoords): boolean
- code to run when the mouse hovers over the actor
  Parameters
  - actor: Actor
  - worldCoords: {
    x: number;
    y: number;
    }
    - x: number
    - y: number
  Returns boolean

`Optional` mouseUnHover

mouseUnHover?: ((actor) => boolean)

code to run when the mouse stops hovering over the actor

Type declaration

- (actor): boolean
- code to run when the mouse stops hovering over the actor
  Parameters
  - actor: Actor
  Returns boolean

`Optional` panMove

panMove?: ((actor, worldCoords) => boolean)

code to run on a pan move event

Type declaration

- (actor, worldCoords): boolean
- code to run on a pan move event
  Parameters
  - actor: Actor
  - worldCoords: {
    x: number;
    y: number;
    }
    - x: number
    - y: number
  Returns boolean

`Optional` panStart

panStart?: ((actor, worldCoords) => boolean)

code to run on a pan start event

Type declaration

- (actor, worldCoords): boolean
- code to run on a pan start event
  Parameters
  - actor: Actor
  - worldCoords: {
    x: number;
    y: number;
    }
    - x: number
    - y: number
  Returns boolean

`Optional` panStop

panStop?: ((actor, worldCoords) => boolean)

code to run on a pan stop event

Type declaration

- (actor, worldCoords): boolean
- code to run on a pan stop event
  Parameters
  - actor: Actor
  - worldCoords: {
    x: number;
    y: number;
    }
    - x: number
    - y: number
  Returns boolean

`Optional` swipe

swipe?: ((actor, point1, point2, time) => boolean)

code to run on a swipe event

Type declaration

- (actor, point1, point2, time): boolean
- code to run on a swipe event
  Parameters
  - actor: Actor
  - point1: {
    x: number;
    y: number;
    }
    - x: number
    - y: number
  - point2: {
    x: number;
    y: number;
    }
    - x: number
    - y: number
  - time: number
  Returns boolean

`Optional` tap

tap?: ((actor, worldCoords) => boolean)

code to run when this actor is tapped

Type declaration

- (actor, worldCoords): boolean
- code to run when this actor is tapped
  Parameters
  - actor: Actor
  - worldCoords: {
    x: number;
    y: number;
    }
    - x: number
    - y: number
  Returns boolean

`Optional` touchDown

touchDown?: ((actor, worldCoords) => boolean)

code to run on a down press event

Type declaration

- (actor, worldCoords): boolean
- code to run on a down press event
  Parameters
  - actor: Actor
  - worldCoords: {
    x: number;
    y: number;
    }
    - x: number
    - y: number
  Returns boolean

`Optional` touchUp

touchUp?: ((actor, worldCoords) => boolean)

code to run on a release event

Type declaration

- (actor, worldCoords): boolean
- code to run on a release event
  Parameters
  - actor: Actor
  - worldCoords: {
    x: number;
    y: number;
    }
    - x: number
    - y: number
  Returns boolean

Class GestureHandlers

Index

Constructors

Properties

Constructors

constructor

Returns GestureHandlers

Properties

Optional mouseHover

Type declaration

Parameters

actor: Actor

worldCoords: { x: number; y: number; }

x: number

y: number

Returns boolean

Optional mouseUnHover

Type declaration

Parameters

actor: Actor

Returns boolean

Optional panMove

Type declaration

Parameters

actor: Actor

worldCoords: { x: number; y: number; }

x: number

y: number

Returns boolean

Optional panStart

Type declaration

Parameters

actor: Actor

worldCoords: { x: number; y: number; }

x: number

y: number

Returns boolean

Optional panStop

Type declaration

Parameters

actor: Actor

worldCoords: { x: number; y: number; }

x: number

y: number

Returns boolean

Optional swipe

Type declaration

Parameters

actor: Actor

point1: { x: number; y: number; }

x: number

y: number

point2: { x: number; y: number; }

x: number

y: number

time: number

Returns boolean

Optional tap

Type declaration

Parameters

actor: Actor

worldCoords: { x: number; y: number; }

x: number

y: number

Returns boolean

Optional touchDown

Type declaration

Parameters

actor: Actor

worldCoords: { x: number; y: number; }

x: number

y: number

Returns boolean

Optional touchUp

Type declaration

Parameters

actor: Actor

worldCoords: { x: number; y: number; }

x: number

y: number

`Optional` mouseHover

worldCoords: {
x: number;
y: number;
}

`Optional` mouseUnHover

`Optional` panMove

worldCoords: {
x: number;
y: number;
}

`Optional` panStart

worldCoords: {
x: number;
y: number;
}

`Optional` panStop

worldCoords: {
x: number;
y: number;
}

`Optional` swipe

point1: {
x: number;
y: number;
}

point2: {
x: number;
y: number;
}

`Optional` tap

worldCoords: {
x: number;
y: number;
}

`Optional` touchDown

worldCoords: {
x: number;
y: number;
}

`Optional` touchUp

worldCoords: {
x: number;
y: number;
}