Class Touch

The touch point class

Hierarchy

Touch

Index

Constructors

constructor

Properties

Accessors

lastModified

Methods

Constructors

constructor

newTouch(x: number, y: number, id?: number): Touch

- Defined in cocos/core/platform/event-manager/touch.ts:50
Parameters
- x: number
  
  x position of the touch point
- y: number
  
  y position of the touch point
- Default value id: number = 0
  
  The id of the touch point
Returns Touch

Properties

Private _id

_id: number = 0

Private _lastModified

_lastModified: number = 0

Private _point

_point: Vec2 = new Vec2()

Private _prevPoint

_prevPoint: Vec2 = new Vec2()

Private _startPoint

_startPoint: Vec2 = new Vec2()

Private _startPointCaptured

_startPointCaptured: boolean = false

Accessors

lastModified

get lastModified(): number

- Defined in cocos/core/platform/event-manager/touch.ts:48
Returns number

Methods

getDelta

getDelta(out?: Vec2): Vec2

- Defined in cocos/core/platform/event-manager/touch.ts:187
Returns the delta distance from the previous touche to the current one.

Parameters
- Optional out: Vec2
  
  Pass the out object to avoid object creation, very good practice
Returns Vec2

getID

getID(): number

- Defined in cocos/core/platform/event-manager/touch.ts:260
Returns the id of the touch point.

Returns number

getLocation

getLocation(out?: Vec2): Vec2

- Defined in cocos/core/platform/event-manager/touch.ts:66
Returns the current touch location in OpenGL coordinates.、

Parameters
- Optional out: Vec2
  
  Pass the out object to avoid object creation, very good practice
Returns Vec2

getLocationInView

getLocationInView(out?: Vec2): Vec2

- Defined in cocos/core/platform/event-manager/touch.ts:219
Returns the current touch location in screen coordinates.

Parameters
- Optional out: Vec2
  
  Pass the out object to avoid object creation, very good practice
Returns Vec2

getLocationX

getLocationX(): number

- Defined in cocos/core/platform/event-manager/touch.ts:79
Returns X axis location value.

Returns number

getLocationY

getLocationY(): number

- Defined in cocos/core/platform/event-manager/touch.ts:87
Returns Y axis location value.

Returns number

getPreviousLocation

getPreviousLocation(out?: Vec2): Vec2

- Defined in cocos/core/platform/event-manager/touch.ts:129
Returns the previous touch location.

Parameters
- Optional out: Vec2
  
  Pass the out object to avoid object creation, very good practice
Returns Vec2

getPreviousLocationInView

getPreviousLocationInView(out?: Vec2): Vec2

- Defined in cocos/core/platform/event-manager/touch.ts:233
Returns the previous touch location in screen coordinates.

Parameters
- Optional out: Vec2
  
  Pass the out object to avoid object creation, very good practice
Returns Vec2

getStartLocation

getStartLocation(out?: Vec2): Vec2

- Defined in cocos/core/platform/event-manager/touch.ts:158
Returns the start touch location.

Parameters
- Optional out: Vec2
  
  Pass the out object to avoid object creation, very good practice
Returns Vec2

getStartLocationInView

getStartLocationInView(out?: Vec2): Vec2

- Defined in cocos/core/platform/event-manager/touch.ts:247
Returns the start touch location in screen coordinates.

Parameters
- Optional out: Vec2
  
  Pass the out object to avoid object creation, very good practice
Returns Vec2

getUIDelta

getUIDelta(out?: Vec2): Vec2

- Defined in cocos/core/platform/event-manager/touch.ts:202
Returns the delta distance from the previous touche to the current one in UI coordinates.

Parameters
- Optional out: Vec2
  
  Pass the out object to avoid object creation, very good practice
Returns Vec2

getUILocation

getUILocation(out?: Vec2): Vec2

- Defined in cocos/core/platform/event-manager/touch.ts:96
Returns the current touch location in UI coordinates.、

Parameters
- Optional out: Vec2
  
  Pass the out object to avoid object creation, very good practice
Returns Vec2

getUILocationX

getUILocationX(): number

- Defined in cocos/core/platform/event-manager/touch.ts:110
Returns X axis location value in UI coordinates.

Returns number

getUILocationY

getUILocationY(): number

- Defined in cocos/core/platform/event-manager/touch.ts:119
Returns Y axis location value in UI coordinates.

Returns number

getUIPreviousLocation

getUIPreviousLocation(out?: Vec2): Vec2

- Defined in cocos/core/platform/event-manager/touch.ts:143
Returns the previous touch location in UI coordinates.

Parameters
- Optional out: Vec2
  
  Pass the out object to avoid object creation, very good practice
Returns Vec2

getUIStartLocation

getUIStartLocation(out?: Vec2): Vec2

- Defined in cocos/core/platform/event-manager/touch.ts:172
Returns the start touch location in UI coordinates.

Parameters
- Optional out: Vec2
  
  Pass the out object to avoid object creation, very good practice
Returns Vec2

setPoint

setPoint(point: Vec2): void
setPoint(x: number, y: number): void

- Defined in cocos/core/platform/event-manager/touch.ts:287
Sets touch point location.

Parameters
- point: Vec2
  
  The location
Returns void
- Defined in cocos/core/platform/event-manager/touch.ts:295
Sets touch point location.

Parameters
- x: number
  
  x position
- y: number
  
  y position
Returns void

setPrevPoint

setPrevPoint(point: Vec2): void
setPrevPoint(x: number, y: number): void

- Defined in cocos/core/platform/event-manager/touch.ts:313
Sets the location previously registered for the current touch.

Parameters
- point: Vec2
  
  The location
Returns void
- Defined in cocos/core/platform/event-manager/touch.ts:321
Sets the location previously registered for the current touch.

Parameters
- x: number
  
  x position
- y: number
  
  y position
Returns void

setTouchInfo

setTouchInfo(id?: number, x?: undefined | number, y?: undefined | number): void

- Defined in cocos/core/platform/event-manager/touch.ts:271
Resets touch point information.

Parameters
- Default value id: number = 0
  
  The id of the touch point
- Optional x: undefined | number
  
  x position of the touch point
- Optional y: undefined | number
  
  y position of the touch point
Returns void

Generated using TypeDoc