PanGestureStartEvent
ClassTriggered when a pan gesture starts.
- Available on all platforms
Index
Example
function onPanStart(eventData) {
var translation = eventData.getTranslation();
var touches = eventData.getTouches();
}
var ev = script.createEvent("PanGestureStartEvent");
ev.bind(onPanStart);
Extends
Properties
enabled
enabled:
boolean
If true, the event is able to trigger. If false, the event will not trigger.
Default Value
true
Inherited from
Methods
bind()
bind(
evCallback):void
Binds a callback function to this event.
Parameters
| Parameter | Type |
|---|---|
evCallback | (arg1) => void |
Returns
void
Inherited from
getSceneObject()
getSceneObject():
SceneObject
Returns the SceneObject this Event is associated with.
Returns
Inherited from
SceneObjectEvent.getSceneObject
getTouches()
getTouches():
vec2[]
Normalized screen positions ([0,1] x [0,1]) of all touches at the start of the pan.
Returns
vec2[]
getTranslation()
getTranslation():
vec2
The change in position relative to the initial position of the gesture, in normalized screen coordinates.
Returns
getTypeName()
staticgetTypeName():TypeName<PanGestureStartEvent>
Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().
Returns
TypeName<PanGestureStartEvent>
Overrides
getTypeName()
getTypeName():
string
Returns the typename of the SceneEvent.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean