Interface InteractionComponent

Allows the MeshVisual provided to this component to handle touches on the screen (blocking Snapchat from receiving the touches), and optionally let certain touch types to pass through (let Snapchat handle the touch).

Possible TouchType values:

"TouchTypeNone" "TouchTypeTouch" "TouchTypeTap" "TouchTypeDoubleTap" "TouchTypeScale" "TouchTypePan" "TouchTypeSwipe"

Example

// Pass in a MeshVisual
// @input Component.BaseMeshVisual myMeshVisual

// Get a reference to the InteractionComponent
var interactionComponent = script.getComponent("Component.InteractionComponent");

// Sets the MeshVisual to handle touches
interactionComponent.addMeshVisual(script.myMeshVisual);

// Allow certain touch types to be passed to Snapchat
interactionComponent.addTouchBlockingException("TouchTypeDoubleTap");

//@input Component.InteractionComponent interactionComponent

// Subscribe to the onTap event
var onTapEvent = script.interactionComponent.onTap.add(function(tapEventArgs){
    print("onTap!"); 
});

// Unsubscribe from the onTap event
script.interactionComponent.onTap.remove(onTapEvent);
interface InteractionComponent {
    enabled: boolean;
    isFilteredByDepth: boolean;
    isFocused: boolean;
    isSelected: boolean;
    onFocusEnd: event1<FocusEndEventArgs, void>;
    onFocusStart: event1<FocusStartEventArgs, void>;
    onSelectEnd: event1<SelectEndEventArgs, void>;
    onSelectStart: event1<SelectStartEventArgs, void>;
    onTap: event1<TapEventArgs, void>;
    onTouchEnd: event1<TouchEndEventArgs, void>;
    onTouchMove: event1<TouchMoveEventArgs, void>;
    onTouchStart: event1<TouchStartEventArgs, void>;
    onTriggerPrimary: event1<TriggerPrimaryEventArgs, void>;
    sceneObject: SceneObject;
    uniqueIdentifier: string;
    addMeshVisual(meshVisual: BaseMeshVisual): void;
    addTouchBlockingException(exception: string): void;
    destroy(): void;
    getMinimumTouchSize(): number;
    getSceneObject(): SceneObject;
    getTransform(): Transform;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
    removeMeshVisual(meshVisual: BaseMeshVisual): void;
    setCamera(camera: Camera): void;
    setMinimumTouchSize(value: number): void;
}

Hierarchy (view full)

Properties

enabled isFilteredByDepth isFocused isSelected onFocusEnd onFocusStart onSelectEnd onSelectStart onTap onTouchEnd onTouchMove onTouchStart onTriggerPrimary sceneObject uniqueIdentifier

Methods

addMeshVisual addTouchBlockingException destroy getMinimumTouchSize getSceneObject getTransform getTypeName isOfType isSame removeMeshVisual setCamera setMinimumTouchSize

Properties

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

isFilteredByDepth

isFilteredByDepth: boolean

When enabled, interaction events will be invoked only on the"closest" object, where order is defined by distance from camera and camera render order.

ReadonlyisFocused

isFocused: boolean

Returns whether the user is currently gazing at the object on wearable devices, and when the user is touching on mobile devices.

ReadonlyisSelected

isSelected: boolean

Returns whether the user is currently selecting and gazing at an object on wearable devices, or touching it on mobile devices.

ReadonlyonFocusEnd

onFocusEnd: event1<FocusEndEventArgs, void>

On mobile devices, this is triggered when the user releases their touch. On wearable devices, this is triggered when the user looks away from the current object.

ReadonlyonFocusStart

onFocusStart: event1<FocusStartEventArgs, void>

On mobile devices, this is triggered when the user starts touching. On wearable devices, this is triggered when the user gazes on the current object.

ReadonlyonSelectEnd

onSelectEnd: event1<SelectEndEventArgs, void>

On mobile devices, this is triggered when the user releases their touch. On wearable devices, this is triggered when the user stops touching the current object.

ReadonlyonSelectStart

onSelectStart: event1<SelectStartEventArgs, void>

On mobile devices, this is triggered when the user starts touching the current object. On wearable devices, this is triggered when the user touches the touchpad while focusing on an object.

ReadonlyonTap

onTap: event1<TapEventArgs, void>

Triggered when the user taps on the screen.

ReadonlyonTouchEnd

onTouchEnd: event1<TouchEndEventArgs, void>

Triggered when a touch event ends.

ReadonlyonTouchMove

onTouchMove: event1<TouchMoveEventArgs, void>

Triggered when a touch position on the screen is moved.

ReadonlyonTouchStart

onTouchStart: event1<TouchStartEventArgs, void>

Triggered when a touch event starts--either on the screen or on a touchpad. On wearables with touchpad, the coordinate returned are based on the touchpad and not the screen.

ReadonlyonTriggerPrimary

onTriggerPrimary: event1<TriggerPrimaryEventArgs, void>

Gets called when the user triggers the primary input on their device. For example touch on touch screens.

ReadonlysceneObject

sceneObject: SceneObject

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

addMeshVisual

  • addMeshVisual(meshVisual): void

  • Adds a MeshVisual as a target for interaction detection.

    Parameters

    Returns void

addTouchBlockingException

  • addTouchBlockingException(exception): void

  • Adds a touch type that this component will ignore.

    Parameters

    • exception: string

    Returns void

destroy

  • destroy(): void

  • Destroys the component.

    Returns void

getMinimumTouchSize

  • getMinimumTouchSize(): number

  • Returns the minimum bounding box size used for detecting touches. Value range is from [0-1], relative to screen width.

    Returns number

getSceneObject

getTransform

getTypeName

  • getTypeName(): string

  • Returns the name of this object's type.

    Returns string

isOfType

  • isOfType(type): boolean

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

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

    Returns boolean

removeMeshVisual

  • removeMeshVisual(meshVisual): void

  • Removes a MeshVisual as a target for interaction detection.

    Parameters

    Returns void

setCamera

  • setCamera(camera): void

  • Sets the camera that will be used for interaction detection.

    Parameters

    Returns void

setMinimumTouchSize

  • setMinimumTouchSize(value): void

  • Sets the minimum bounding box size used for detecting touches. Value range is from [0-1], relative to screen width.

    Parameters

    • value: number

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods