Skip to main content

SpecsInteractionModule.FieldState

Enum

The targeting field an interactor is in, resolved by SpecsInteractionModule against the registered InteractionPlanes: targeting from a distance (FarField), h…

  • Snapchat: not supported
  • SPECS: fully supported
  • Camera Kit Web: not supported
  • Camera Kit Mobile: not supported
  • SnapchatNot supported — Available on SPECS only
  • SPECSFully supported
  • Camera Kit WebNot supported — Available on SPECS only
  • Camera Kit MobileNot supported — Available on SPECS only

Platform details

  • Snapchat — Not supported — Available on SPECS only.

  • SPECS — Fully supported.

  • Camera Kit Web — Not supported — Available on SPECS only.

  • Camera Kit Mobile — Not supported — Available on SPECS only.

Since Lens Scripting v375

The targeting field an interactor is in, resolved by SpecsInteractionModule against the registered InteractionPlanes: targeting from a distance (FarField), hovering inside a plane's near-field zone (NearField), touching its physical zone (Physical), or having passed behind it (BehindNearField). Read it from SpecsInteractionModule.Interactor#fieldState.

Index

Example

if (interactor.fieldState === SpecsInteractionModule.FieldState.Physical) {
print("interactor " + interactor.id + " is touching a plane");
}

Enumeration Members

BehindNearField

BehindNearField: number

SPECS

Behind an InteractionPlane's near-field volume.

Since

Lens Scripting Version 375


FarField

FarField: number

SPECS

Targeting from a distance, or a state this version does not recognize.

Since

Lens Scripting Version 375


NearField

NearField: number

SPECS

Inside an InteractionPlane's near-field zone.

Since

Lens Scripting Version 375


Physical

Physical: number

SPECS

Inside an InteractionPlane's physical zone.

Since

Lens Scripting Version 375