SamsaraJS

  • API Docs for Version: 0.2.0


    • Show:

    Inputs.TouchTracker Class

    Uses
    Defined in: samsara/inputs/TouchTracker.js:19

    Catalogues a history of touch events. Useful for creating more complex touch recognition for gestures. Currently only used by TouchInput to track previous touches to compute velocity.

    TouchTracker emits these events with the following payload data:

     x             - Displacement in x-direction
 y             - Displacement in y-direction
 identifier    - DOM event touch identifier
 timestamp     - Timestamp
 count         - DOM event for number of simultaneous touches
 history       - History of touches for the gesture

    Constructor

    Inputs.TouchTracker

    (
    • [options]
    )
    private

    Parameters:

    • [options] Object optional

      Options

      • [limit] Number optional

        Number of touches to record

    Methods

    "on"

    (
    • type
    • handler
    )

    Inherited from Core.OptionsManager:

    Adds a handler to the type channel which will be executed on emit.

    Parameters:

    get

    (
    • key
    )
    Object

    Inherited from Core.OptionsManager:

    Look up options value by key or get the full options hash.

    Parameters:

    Returns:

    Object:

    Associated object or full options hash

    getOptions

    ()

    Inherited from Core.OptionsManager:

    Alias for get

    key

    (
    • key
    )
    OptionsManager

    Inherited from Core.OptionsManager:

    Return OptionsManager based on sub-object retrieved by key.

    Parameters:

    Returns:

    OptionsManager:

    Value

    off

    (
    • type
    • handler
    )

    Inherited from Core.OptionsManager:

    Removes the handler from the type channel. This undoes the work of on.

    Parameters:

    OptionsManager.patch

    (
    • options
    • patch
    )
    Object

    Inherited from Core.OptionsManager but overwritten in

    Constructor method. Create OptionsManager from source dictionary with arguments overriden by patch dictionary.

    Parameters:

    • options Object

      Options to be patched

    • patch ...Object

      Options to overwrite

    Returns:

    Object:

    source

    patch

    (
    • options
    )
    OptionsManager

    Inherited from Core.OptionsManager:

    Patch options with provided patches. Triggers change event on the object.

    Parameters:

    • options Object

      Patch options

    Returns:

    OptionsManager:

    this

    set

    (
    • key
    • value
    )
    OptionsManager

    Inherited from Core.OptionsManager:

    Set key to value. Outputs change event if a value is overwritten.

    Parameters:

    Returns:

    OptionsManager:

    Updated OptionsManager

    setOptions

    ()

    Inherited from Core.OptionsManager:

    Alias for patch

    track

    (
    • data
    )
    private

    Record touch data, if selective is false.

    Parameters: