Class Magnetometer

OptionalcalibrationData

createdTimestamp

displayName

frequency

parentUID

uid

value

angularVelocity

• get angularVelocity(): AngularVelocity

  Returns AngularVelocity

• set angularVelocity(velocity: AngularVelocity): void

  Parameters

  • velocity: AngularVelocity

  Returns void

linearVelocity

• get linearVelocity(): LinearVelocity

  Returns LinearVelocity

• set linearVelocity(velocity: LinearVelocity): void

  Parameters

  • velocity: LinearVelocity

  Returns void

orientation

• get orientation(): Orientation

  Get the orientation of the object relative to the global reference space

  Returns Orientation

• set orientation(orientation: Orientation): void

  Set the orientation of the object relative to the global reference space

  Parameters

  • orientation: Orientation

  Returns void

position

• get position(): AbsolutePosition

  Get the current absolute position of the object relative to the global reference space

  Returns AbsolutePosition

  Absolute position of data object

• set position(position: AbsolutePosition): void

  Set the current absolute position of the object relative to the global reference space

  Parameters

  • position: AbsolutePosition

  Returns void

raw

• get raw(): T

  Raw value before calibration

  Returns T

  raw sensor value

• set raw(value: T): void

  Parameters

  • value: T

  Returns void

relativePositions

• get relativePositions(): RelativePosition<any, Unit>[]

  Get relative positions

  Returns RelativePosition<any, Unit>[]

  Array of relative positions

• set relativePositions(relativePostions: RelativePosition<any, Unit>[]): void

  Parameters

  • relativePostions: RelativePosition<any, Unit>[]

  Returns void

timestamp

• get timestamp(): number

  Get the sensor timestamp

  Returns number

  timestamp

velocity

• get velocity(): Velocity

  Returns Velocity

• set velocity(velocity: Velocity): void

  Parameters

  • velocity: Velocity

  Returns void

addRelativePosition

• addRelativePosition(relativePosition: RelativePosition<any>): this

  Add a relative position to this data object

  Parameters

  • relativePosition: RelativePosition<any>

    Relative position to add

  Returns this

  Data object instance

bind

• bind(
      service: DataService<string, Magnetometer>,
  ): DataObjectBinding<Magnetometer>

  Bind the data object to a service

  Parameters

  • service: DataService<string, Magnetometer>

    Service to bind it to

  Returns DataObjectBinding<Magnetometer>

  Data object binding with a service

clone

• clone<T extends Magnetometer>(dataType?: Constructor<T>): T

  Clone the data object

  Type Parameters

  • T extends Magnetometer

  Parameters

  • OptionaldataType: Constructor<T>

    Data type to clone to

  Returns T

  Cloned data object

getPosition

• getPosition(referenceSpace?: TransformationSpace): AbsolutePosition

  Get the current absolute position of the object

  Parameters

  • OptionalreferenceSpace: TransformationSpace

    Reference space to transform it to

  Returns AbsolutePosition

  Position of the data object

getRelativePosition

• getRelativePosition(
      referenceObjectUID: string,
      type?: string,
  ): RelativePosition<any>

  Get relative position of a specified object

  Parameters

  • referenceObjectUID: string

    Reference object identifier

  • Optionaltype: string

    Constructor type of the relative position

  Returns RelativePosition<any>

  Relative position to reference object

getRelativePositions

• getRelativePositions(referenceObjectUID?: string): RelativePosition<any, Unit>[]

  Get relative positions for a different target

  Parameters

  • OptionalreferenceObjectUID: string

    Reference object identifier

  Returns RelativePosition<any, Unit>[]

  Array of relative positions for the reference object

hasRelativePosition

• hasRelativePosition(referenceObjectUID: string): boolean

  Parameters

  • referenceObjectUID: string

  Returns boolean

removeRelativePositions

• removeRelativePositions(referenceObjectUID: string): void

  Parameters

  • referenceObjectUID: string

  Returns void

setParent

• setParent(object: string | DataObject): this

  Set a parent object to the data object

  Parameters

  • object: string | DataObject

    Data object or UID to add as parent

  Returns this

  instance

setPosition

• setPosition(
      position: AbsolutePosition,
      referenceSpace?: TransformationSpace,
  ): this

  Set the current absolute position of the object

  Parameters

  • position: AbsolutePosition

    Position to set

  • OptionalreferenceSpace: TransformationSpace

    Reference space

  Returns this

  Data object instance

setUID

• setUID(uid: string): this

  Set the unique identifier of this object

  Parameters

  • uid: string

    Unique Identifier

  Returns this

  Data object instance