Class Magnetometer

Optional calibrationData

createdTimestamp

displayName

frequency

parentUID

uid

value

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): 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): 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): void

• Parameters

  • relativePostions: RelativePosition<any, Unit>[]

  Returns void

timestamp

• get timestamp(): number

• Get the sensor timestamp

  Returns number

  timestamp

addRelativePosition

• addRelativePosition(relativePosition): this

• Add a relative position to this data object

  Parameters

  • relativePosition: RelativePosition<any, Unit>

    Relative position to add

  Returns this

  Data object instance

bind

• bind(service): 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>(dataType?): T

• Clone the data object

  Type Parameters

  • T extends Magnetometer

  Parameters

  • Optional dataType: Constructor<T>

    Data type to clone to

  Returns T

  Cloned data object

getPosition

• getPosition(referenceSpace?): AbsolutePosition

• Get the current absolute position of the object

  Parameters

  • Optional referenceSpace: TransformationSpace

    Reference space to transform it to

  Returns AbsolutePosition

  Position of the data object

getRelativePosition

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

• Get relative position of a specified object

  Parameters

  • referenceObjectUID: string

    Reference object identifier
  • Optional type: string

    Constructor type of the relative position

  Returns RelativePosition<any, Unit>

  Relative position to reference object

getRelativePositions

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

• Get relative positions for a different target

  Parameters

  • Optional referenceObjectUID: string

    Reference object identifier

  Returns RelativePosition<any, Unit>[]

  Array of relative positions for the reference object

hasRelativePosition

• hasRelativePosition(referenceObjectUID): boolean

• Parameters

  • referenceObjectUID: string

  Returns boolean

removeRelativePositions

• removeRelativePositions(referenceObjectUID): void

• Parameters

  • referenceObjectUID: string

  Returns void

setParent

• setParent(object): 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, referenceSpace?): this

• Set the current absolute position of the object

  Parameters

  • position: AbsolutePosition

    Position to set
  • Optional referenceSpace: TransformationSpace

    Reference space

  Returns this

  Data object instance

setUID

• setUID(uid): this

• Set the unique identifier of this object

  Parameters

  • uid: string

    Unique Identifier

  Returns this

  Data object instance