Skip to main content

Components List

Every component and provider in Interaction Kit 4.0.0 for SPECS: interactors, Interactables, cursors, rays, hand visuals, anchoring, and feedback helpers.

  • Snapchat: not supported
  • SPECS: fully supported
  • Camera Kit Web: not supported
  • Camera Kit Mobile: not supported
  • SnapchatNot supported
  • SPECSFully supported
  • Camera Kit WebNot supported
  • Camera Kit MobileNot supported

Platform details

  • Snapchat — Not supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Not supported.

  • Camera Kit Mobile — Not supported.

This page lists the components and providers in Interaction Kit 4.0.0, grouped by role, with the module path each one is imported from. Every path starts with the package prefix InteractionKit.lspkg/. In scripts, reach the shared providers through the IK entry point:

import { IK } from 'InteractionKit.lspkg/IK';

Interaction Kit core: conductors, providers, and configuration

Conductors

ComponentModule pathWhat it doesScript access
InteractionManagerCore/InteractionManager/InteractionManagerRegisters every interactor and Interactable and dispatches their events. See Interaction System.IK.InteractionManager
CursorControllerComponents/Interaction/InteractorCursor/CursorControllerCreates a cursor and a ray for each interactor. See Cursor.IK.CursorController (returns CursorControllerProvider)

Input providers

ProviderModule pathWhat it doesScript access
HandInputDataProviders/HandInputData/HandInputDataHand tracking data for each hand. See Hand Tracking.IK.HandInputData
MobileInputDataProviders/MobileInputData/MobileInputDataInput from a phone used as a motion controller. On SPECS 27 a phone is no longer available as a motion controller.IK.MobileInputData

Configuration

ComponentModule pathWhat it does
ConfigurationValidatorCore/ConfigurationValidator/ConfigurationValidatorChecks the project setup when the Lens starts, and stops the Lens if the Preview panel doesn't run it as SPECS.
IKLogLevelConfigurationCore/LogLevelConfiguration/IKLogLevelConfigurationSets which Interaction Kit messages reach the Logger (Log Level Filter: Error, Warning, Info, Debug, Verbose) and draws debug gizmos for interactors and Interactables (Debug Mode Enabled). Script access: IK.IKLogLevelProvider.

Both live on the Configuration object of the InteractionKit prefab.

Interaction Kit interaction components

Interactors

ComponentModule pathWhat it does
HandInteractorCore/HandInteractor/HandInteractorTargets and triggers Interactables with a hand: ray targeting from a distance, direct pinch, and poke. The InteractionKit prefab has one per hand.
MouseInteractorCore/MouseInteractor/MouseInteractorLets the mouse stand in for a hand in the Lens Studio Preview panel. Mouse Targeting Mode sets which targeting mode it reports; Move In Depth moves it back and forth along its ray to test depth.
MobileInteractorCore/MobileInteractor/MobileInteractorTargets and triggers Interactables with a phone, through MobileInputData. It isn't in the InteractionKit prefab.

Behaviors

ComponentModule pathWhat it does
InteractableComponents/Interaction/Interactable/InteractableMakes a scene object with a collider respond to interactors, and exposes its hover, trigger, and drag events. See Interaction System.
InteractableManipulationComponents/Interaction/InteractableManipulation/InteractableManipulationLets the user move, rotate, and scale an object. Needs an Interactable on the same scene object.
InteractionPlaneComponents/Interaction/InteractionPlane/InteractionPlaneDefines a rectangular zone in front of dense 2D UI where hands switch to near-field targeting. See Interaction System.

Signifiers

ComponentModule pathWhat it does
InteractorCursorComponents/Interaction/InteractorCursor/InteractorCursorShows where an interactor is pointing. CursorController creates one per interactor. See Cursor.
InteractorRayVisualComponents/Interaction/InteractorRayVisual/InteractorRayVisualDraws a ray from an interactor to its cursor, with a length and opacity driven by the cursor. CursorController creates one per interactor.
HandVisualComponents/Interaction/HandVisual/HandVisualCan draw a mesh over the user's hand. See Hand Visualization.
InteractorLineVisualComponents/Interaction/InteractorLineVisual/InteractorLineVisualDeprecated: no longer recommended for new projects. Use InteractorRayVisual.

Anchor dynamics

ComponentModule pathWhat it does
BillboardComponents/Interaction/Billboard/BillboardRotates an object to face the camera. See Anchor Dynamics.
HeadlockComponents/Interaction/Headlock/HeadlockKeeps an object at a set distance in front of the user's head, with lag you configure. See Anchor Dynamics.

Interaction Kit helpers

Feedback

Each feedback component reacts to the Interactable on its own scene object. See Helpers.

ComponentModule pathWhat it does
InteractableAudioFeedbackComponents/Helpers/InteractableAudioFeedbackPlays a sound when a trigger starts and when it ends.
InteractableColorFeedbackComponents/Helpers/InteractableColorFeedbackChanges the color of mesh visuals on hover, pinch, and disable.
InteractableOutlineFeedbackComponents/Helpers/InteractableOutlineFeedbackOutlines mesh visuals on hover and pinch.
InteractableSquishFeedbackComponents/Helpers/InteractableSquishFeedbackSquishes an object on hover and trigger.

Modifiers and sensors

ComponentModule pathWhat it does
ScreenTransformAdapterComponents/Helpers/ScreenTransformAdapterAdapts an object's transform to a ScreenTransform when the object is a child of a Canvas, keeping its position and rotation.
ProximitySensorComponents/Helpers/ProximitySensorA spherical sensor that reports the colliders inside its Radius.

UI components moved to UI Kit

Interaction Kit 4.0.0 has no UI components. The buttons, toggles, sliders, scroll bars, scroll views, and container frames of earlier versions, with their ToggleFeedback, SliderFeedback, and CapsuleMeshCustomizer helpers, are replaced by UI Kit, which builds its controls on Interaction Kit.