Skip to main content

MotionController.MotionControllerOptions

Class

Settings for configuring a motion controller.

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

Platform details

  • Snapchat — Not supported — SPECS only.

  • SPECS — Fully supported.

  • Camera Kit Web — Not supported — SPECS only.

  • Camera Kit Mobile — Not supported — SPECS only.

Settings for configuring a motion controller.

Index

Example

const MotionControllerModule = require("LensStudio:MotionControllerModule")
let options = MotionController.Options.create()
options.motionType = MotionController.MotionType.ThreeDoF
const motionController = MotionControllerModule.getController(options)

Extends

Properties

controllerId

controllerId: string

SPECS only

The unique identifier to connect to a motion controller. The only value currently supported is empty (""), which will result in the Mobile Controller being requested.

Default Value

""
@wearableOnly

motionType

motionType: MotionType

SPECS only

Represents the motion type of the motion controller.

Default Value

MotionController.MotionType.NoMotion
@wearableOnly

Methods

create()

static create(): MotionControllerOptions

SPECS only

Creates the configurations to be used with the MotionController

Returns

MotionControllerOptions


getTypeName()

static getTypeName(): TypeName<MotionControllerOptions>

SPECS only

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<MotionControllerOptions>

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


isOfType()

isOfType(type): boolean

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

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

ScriptObject.isOfType


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

ParameterType
otherScriptObject

Returns

boolean

Inherited from

ScriptObject.isSame