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
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
| Component | Module path | What it does | Script access |
|---|---|---|---|
InteractionManager | Core/InteractionManager/InteractionManager | Registers every interactor and Interactable and dispatches their events. See Interaction System. | IK.InteractionManager |
CursorController | Components/Interaction/InteractorCursor/CursorController | Creates a cursor and a ray for each interactor. See Cursor. | IK.CursorController (returns CursorControllerProvider) |
Input providers
| Provider | Module path | What it does | Script access |
|---|---|---|---|
HandInputData | Providers/HandInputData/HandInputData | Hand tracking data for each hand. See Hand Tracking. | IK.HandInputData |
MobileInputData | Providers/MobileInputData/MobileInputData | Input from a phone used as a motion controller. On SPECS 27 a phone is no longer available as a motion controller. | IK.MobileInputData |
Configuration
| Component | Module path | What it does |
|---|---|---|
ConfigurationValidator | Core/ConfigurationValidator/ConfigurationValidator | Checks the project setup when the Lens starts, and stops the Lens if the Preview panel doesn't run it as SPECS. |
IKLogLevelConfiguration | Core/LogLevelConfiguration/IKLogLevelConfiguration | Sets 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
| Component | Module path | What it does |
|---|---|---|
HandInteractor | Core/HandInteractor/HandInteractor | Targets and triggers Interactables with a hand: ray targeting from a distance, direct pinch, and poke. The InteractionKit prefab has one per hand. |
MouseInteractor | Core/MouseInteractor/MouseInteractor | Lets 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. |
MobileInteractor | Core/MobileInteractor/MobileInteractor | Targets and triggers Interactables with a phone, through MobileInputData. It isn't in the InteractionKit prefab. |
Behaviors
| Component | Module path | What it does |
|---|---|---|
Interactable | Components/Interaction/Interactable/Interactable | Makes a scene object with a collider respond to interactors, and exposes its hover, trigger, and drag events. See Interaction System. |
InteractableManipulation | Components/Interaction/InteractableManipulation/InteractableManipulation | Lets the user move, rotate, and scale an object. Needs an Interactable on the same scene object. |
InteractionPlane | Components/Interaction/InteractionPlane/InteractionPlane | Defines a rectangular zone in front of dense 2D UI where hands switch to near-field targeting. See Interaction System. |
Signifiers
| Component | Module path | What it does |
|---|---|---|
InteractorCursor | Components/Interaction/InteractorCursor/InteractorCursor | Shows where an interactor is pointing. CursorController creates one per interactor. See Cursor. |
InteractorRayVisual | Components/Interaction/InteractorRayVisual/InteractorRayVisual | Draws a ray from an interactor to its cursor, with a length and opacity driven by the cursor. CursorController creates one per interactor. |
HandVisual | Components/Interaction/HandVisual/HandVisual | Can draw a mesh over the user's hand. See Hand Visualization. |
InteractorLineVisual | Components/Interaction/InteractorLineVisual/InteractorLineVisual | Deprecated: no longer recommended for new projects. Use InteractorRayVisual. |
Anchor dynamics
| Component | Module path | What it does |
|---|---|---|
Billboard | Components/Interaction/Billboard/Billboard | Rotates an object to face the camera. See Anchor Dynamics. |
Headlock | Components/Interaction/Headlock/Headlock | Keeps 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.
| Component | Module path | What it does |
|---|---|---|
InteractableAudioFeedback | Components/Helpers/InteractableAudioFeedback | Plays a sound when a trigger starts and when it ends. |
InteractableColorFeedback | Components/Helpers/InteractableColorFeedback | Changes the color of mesh visuals on hover, pinch, and disable. |
InteractableOutlineFeedback | Components/Helpers/InteractableOutlineFeedback | Outlines mesh visuals on hover and pinch. |
InteractableSquishFeedback | Components/Helpers/InteractableSquishFeedback | Squishes an object on hover and trigger. |
Modifiers and sensors
| Component | Module path | What it does |
|---|---|---|
ScreenTransformAdapter | Components/Helpers/ScreenTransformAdapter | Adapts an object's transform to a ScreenTransform when the object is a child of a Canvas, keeping its position and rotation. |
ProximitySensor | Components/Helpers/ProximitySensor | A 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.
Related
- Interaction Kit Get Started: add the kit and its prefab to a project.
- Interaction System: Interactable events and inputs in detail.
- Architecture: how the providers, interactors, and InteractionManager connect.