Lens Scripting API

Editor Scripting API Guide Docs

Packages/SpectaclesInteractionKit/Utils/Spatial

Module Packages/SpectaclesInteractionKit/Utils/Spatial

Interfaces

Spatial

Settings

Member Visibility

Inherited
Deprecated

Theme

On This Page

Interfaces

Editor Scripting API Guide Docs

Lens Scripting API

Full API List
Assets List
Components List
Providers List
SceneEvents List
Privacy Restrictions
Built-In
Packages
- LSTween
  LSTween
  LSTween
  RotationInterpolationType
  RotationInterpolationType
  TweenJS
  Easing
  default
  Easing
  EasingFunction
  EasingFunctionGroup
  Group
  default
  Index
  add
  Easing
  getAll
  Group
  Interpolation
  nextId
  now
  remove
  removeAll
  Sequence
  Tween
  update
  VERSION
  Interpolation
  default
  InterpolationFunction
  mainGroup
  mainGroup
  Now
  default
  Sequence
  default
  Tween
  default
  Tween
  UnknownProps
  Version
  default
- SpectaclesInteractionKit
  Components
  Helpers
  ButtonFeedback
  ButtonFeedback
  CapsuleMeshCustomizer
  CapsuleMeshCustomizer
  InteractableAudioFeedback
  InteractableAudioFeedback
  InteractableColorFeedback
  InteractableColorFeedback
  InteractableOutlineFeedback
  InteractableOutlineFeedback
  InteractableSquishFeedback
  InteractableSquishFeedback
  ScreenTransformAdapter
  ScreenTransformAdapter
  ScrollBarFeedback
  ScrollBarFeedback
  SliderFeedback
  SliderFeedback
  ToggleFeedback
  ToggleFeedback
  Interaction
  Billboard
  Billboard
  Billboard
  BillboardController
  BillboardConfig
  default
  RotationAxis
  BillboardRotationCalculator
  ALMOST_ONE
  default
  RotationCalculatorConfig
  HandVisual
  GlowEffectView
  GlowEffectView
  GlowEffectViewConfig
  GlowEffectViewModel
  GlowEffectStates
  GlowEffectViewModel
  GlowEffectViewModelConfig
  StateMachineSignals
  HandVisual
  HandVisual
  HandVisualSelection
  Headlock
  Headlock
  Headlock
  HeadlockController
  default
  DefaultHeadlockConfig
  RotationAxis
  HeadlockRotationCalculator
  default
  RotationCalculatorConfig
  HeadlockTranslationCalculator
  default
  TranslationCalculatorConfig
  Interactable/Interactable
  Interactable
  InteractableEventArgs
  SyncInteractionType
  InteractableManipulation/InteractableManipulation
  InteractableManipulation
  RotationAxis
  RotationEventArg
  ScaleEventArg
  ScaleLimitEventArg
  TransformEventArg
  TranslateEventArg
  InteractionPlane/InteractionPlane
  InteractionPlane
  ZoneProjection
  InteractorCursor
  CircleVisual
  CircleVisual
  CircleVisualConfig
  CircleVisualMaterialParameters
  CircleVisualTextureConfig
  CursorController
  CursorController
  CursorViewModel
  CursorData
  CursorInteractor
  CursorState
  CursorViewModel
  CursorViewState
  ManipulateLineData
  InteractorCursor
  CursorMode
  CursorParameters
  InteractorCursor
  InteractorLineVisual
  InteractorLineRenderer
  default
  VisualStyle
  InteractorLineVisual
  InteractorLineConfig
  InteractorLineVisual
  UI
  ContainerFrame
  ContainerFrame
  ContainerFrame
  ContainerFrameConfig
  InputState
  modules
  CursorHandler
  CursorHandler
  CursorManagerOptions
  CursorModes
  ForceContainerParent
  ContainerParentConfig
  forceContainerParent
  FRAME_PARENT_NAME
  FrameInputHandler
  FrameInputHandler
  FrameInputOptions
  FrameState
  Modes
  HoverBehavior
  HoverBehavior
  LabeledPinchButton
  LabeledPinchButton
  LabeledPinchButtonOptions
  SimpleLODRenderMeshVisual/SimpleLODRenderMeshVisual
  SimpleLODRenderMeshVisual
  SmoothFollow
  SmoothFollow
  SmoothFollowOptions
  SnappableBehavior
  SnappableBehavior
  SnappableOptions
  PinchButton/PinchButton
  PinchButton
  ScrollBar/ScrollBar
  ScrollBar
  ScrollView
  boundariesProvider
  BoundariesProvider
  BoundariesProvider
  BufferedBoundariesProvider
  BufferedBoundariesProvider
  SceneObjectBoundariesProvider
  SceneObjectBoundariesProvider
  ScreenTransformBoundariesProvider
  ScreenTransformBoundariesProvider
  VisualBoundariesProvider
  VisualBoundariesProvider
  GridContentCreator
  GridContentCreator
  ScrollArea
  ScrollArea
  ScrollProvider
  ScrollProvider
  ScrollProviderConfig
  ScrollView
  AXIS_DIRECTION
  AxisDirection
  EDGE_TYPE
  EdgeSelector
  EdgeType
  ScrollView
  ScrollViewEventArgs
  ScrollViewFocusEventArgs
  Slider/Slider
  DragUpdate
  Slider
  SliderBounds
  SliderState
  TrackState
  ToggleButton/ToggleButton
  ToggleButton
  Core
  ConfigurationValidator/ConfigurationValidator
  ConfigurationValidator
  HandInteractor/HandInteractor
  FieldTargetingMode
  HandInteractor
  MINIMUM_PINCH_STRENGTH
  RaycastType
  InteractionManager
  EventDispatcher
  EventDispatcher
  SceneObjectMap
  StoppableEventArgs
  InteractionManager
  InteractionManager
  Interactor
  BaseInteractor
  default
  ColliderTargetProvider
  ColliderTargetProvider
  ColliderTargetProviderConfig
  DirectTargetProvider
  DirectTargetProvider
  DirectTargetProviderConfig
  DragProvider
  DragProvider
  HandRayProvider
  HandRayProvider
  HandRayProviderConfig
  IndirectTargetProvider
  default
  IndirectTargetProviderConfig
  Interactor
  DragType
  Interactor
  InteractorInputType
  InteractorTriggerType
  TargetingMode
  InteractorEvent
  DispatchableEventArgs
  DragInteractorEvent
  EventPropagationPhase
  InteractableEventName
  InteractorEvent
  MobileRayProvider
  MobileRayProvider
  MouseTargetProvider
  default
  MouseTargetProviderConfig
  PokeTargetProvider
  PokeTargetProvider
  PokeTargetProviderConfig
  raycastAlgorithms
  AxisAngle
  default
  ContinousIrInteractionTransition
  default
  IrInteractionTransition
  IrInteractionTransition
  PinchJumpSuppressor
  DeltaMode
  KnuckleSmoothingSpace
  PinchJumpSuppressor
  PinchSpeedDescriptor
  RayData
  SuppressionState
  RaycastBase
  default
  LEFT_HAND
  RayAlgorithmData
  RIGHT_HAND
  RaycastProxy
  default
  RgbIrTransitionJumpSuppressor
  Bone
  default
  Delta
  DeltaConfig
  HandOverDetection
  ModifiedValues
  SwitchIrInteractionTransition
  default
  SwitchIrInteractionTransitionConfig
  TimeDataContainer
  TimedData
  TimedDataContainer
  WindowMode
  TimedVec2Container
  TimedVec2Container
  TimedVec3Container
  TimedVec3Container
  TimeScalarContainer
  TimedScalarContainer
  RayProvider
  RaycastInfo
  RayProvider
  TouchRayProvider
  TouchRayProvider
  LogLevelConfiguration
  LogLevelConfiguration
  LogLevelConfiguration
  SIKLogLevelConfiguration
  SIKLogLevelConfiguration
  MobileInteractor/MobileInteractor
  MobileInteractor
  MouseInteractor/MouseInteractor
  MouseInteractor
  Decorators/Singleton
  Singleton
  Providers
  CameraProvider
  ARCameraFinderProvider
  default
  BaseCameraFinderProvider
  default
  BaseWorldCameraProvider
  default
  CameraProvider
  default
  WorldCameraFinderProvider
  default
  CursorControllerProvider/CursorControllerProvider
  CursorControllerProvider
  HandInputData
  BaseHand
  BaseHand
  DefaultHandTrackingAssetProvider
  default
  GestureProvider
  GestureModuleProvider
  default
  PalmTapDetection
  PalmTapDetector
  default
  PalmTapDetectorStateMachine
  default
  PalmTapDetectorState
  PalmTapDetectionEvent
  PalmTapDetectionEvent
  PalmTapEvent
  PalmTapEventType
  PinchDetection
  DetectionStrategies
  HciPinchDetectionStrategy
  default
  HciPinchDetectionStrategyConfig
  HeuristicPinchDetectionStrategy
  default
  HeuristicPinchDetectionStrategyConfig
  PinchDetectionStrategy
  PinchDetectionStrategy
  PinchDetector
  PinchDetectionSelection
  PinchDetector
  PinchDetectorConfig
  PinchDetectorStateMachine
  default
  PinchDetectorState
  PinchEventType
  PinchEvent
  PinchEventType
  HandInputData
  HandInputData
  HandInputDataConfig
  HandTrackingAssetProvider
  default
  HandType
  AllHandTypes
  HandType
  HandVisuals
  HandVisuals
  Joints
  JOINT_HIERARCHY
  JointNode
  Keypoint
  Keypoint
  LandmarkNames
  allLandmarks
  Fingers
  Hands
  INDEX_BASE
  INDEX_TIP
  indexLandmarks
  LandmarkName
  mapLandmarkToFinger
  MIDDLE_BASE
  MIDDLE_TIP
  midLandmarks
  PINKY_BASE
  PINKY_TIP
  pinkyLandmarks
  RING_BASE
  RING_TIP
  ringLandmarks
  stubLandmarks
  THUMB_BASE
  THUMB_TIP
  thumbLandmarks
  wristLandmarks
  TrackedHand
  BaseHandConfig
  default
  OrientationVectors
  PalmState
  TrackingEvent
  InteractionConfigurationProvider
  InteractionConfigurationProvider
  CustomComponentName
  InteractionConfigurationProvider
  LogLevelProvider
  default
  SIKLogLevelProvider
  default
  MobileInputData
  MobileInputData
  MobileInputData
  MotionControllerProvider
  default
  TargetProvider
  TargetingData
  TargetingData
  TargetProvider
  default
  InteractableHitInfo
  SIK
  SIK
  SIKAPI
  Utils
  aabb
  aabb
  algorithms
  applyToDescendants
  bfs
  filterTrees
  animate
  AnimateConfig
  AnimationManager
  AnimationManager
  RequestAnimationFrameType
  CancelFunction
  CancelSet
  CancelSet
  CancelSetClass
  CancelSetConfig
  default
  easingFunctions
  mix
  onAnimationStart
  onAnimationStop
  BistableThreshold
  BistableThresholdConfig
  default
  NullableBoolean
  color
  BLACK
  ColorStop
  CRITICAL_COLOR_STOPS
  DARKGRAY
  DEFAULT_COLOR_STOPS
  getMostCommonHue
  GRAY
  HSLToRGB
  HSLToRGBInPlace
  parseColor
  RED
  RGBToHSL
  RGBToHSLInPlace
  WHITE
  withAlpha
  withoutAlpha
  YELLOW
  Event
  callback
  default
  PublicApi
  unsubscribe
  Filter
  default
  NoOpFilter
  FunctionTimingUtils
  AnyArg
  CancelToken
  clearTimeout
  debounce
  setTimeout
  throttle
  InputChecker
  InputChecker
  InspectorCallbacks
  createCallback
  lazyProperty
  lazyProperty
  LensConfig
  LensConfig
  logger
  formatLogMessage
  formatWithTag
  logWithTag
  LogLevel
  LogLevel
  mathUtils
  averageVec2
  averageVec3
  clamp
  DegToRad
  interpolateVec3
  inverseLerp
  lerp
  mapValue
  NANOSECONDS_PER_MILLISECOND
  RadToDeg
  smoothDamp
  smoothDampAngle
  smoothSlide
  transformPoint
  MovingAverageFilter
  MovingAverageFilter
  NativeLogger
  default
  notEmpty
  notEmpty
  OneEuroFilter
  LowPassFilter
  LowPassFilterVec3_v2
  OneEuroFilter
  OneEuroFilterConfig
  OneEuroFilterQuat
  OneEuroFilterVec2
  OneEuroFilterVec3
  ReplayEvent
  default
  SafeReference
  getSafeReference
  SampleOps
  SampleOps
  ScalarSampleOps
  Vec2SampleOps
  Vec3SampleOps
  SceneObjectUtils
  findSceneObjectByName
  isDescendantOf
  SeededRandomNumberGenerator
  SeededRandomNumberGenerator
  Spatial
  Spatial
  springAnimate
  SpringAnimate
  State
  Callback
  CheckSignalCallback
  CheckUpdateCallback
  default
  StateConfig
  Transition
  TransitionConfig
  TransitionExecutionCallback
  StateMachine
  default
  UpdateDispatcher
  BaseDispatchedEvent
  DispatchedDelayedEvent
  DispatchedUpdateEvent
  IUpdateDispatcher
  UpdateDispatcher
  validate
  validate
  views
  LineRenderer
  LineMeshUtils
  buildSegment
  buildVertex
  getEndWidth
  getMiterOffset
  getSegmentNormalized
  getTangent
  lineVertex
  LineRenderer
  default
  LineViewConfig
  MeshView
  default
  MeshViewConfig
  View
  default
  Defaults
  OnDestroyCallback
  ViewConfig
TypeScript

Generated using TypeDoc