Class Magnetometer
Hierarchy-Diagram
Legend
class
abstract class
Hierarchy
- SensorObject<Magnetism>
- Magnetometer
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
- new
Magnetometer(uid?: string, value?: Magnetism, frequency?: number, displayName?: string): Magnetometer -
Parameters
-
Optionaluid: string -
Optionalvalue: Magnetism -
Optionalfrequency: number -
OptionaldisplayName: string
Returns Magnetometer
-
Properties
created
Created timestamp
display
Object display name
frequency
Frequency of the sensor
parentUID
uid
Object identifier
Returns
Unique object identifier
value
Value of the sensor
Accessors
position
- get position(): AbsolutePosition
-
Get the current absolute position of the object relative to the global reference space
Returns
Absolute position of data object
Returns AbsolutePosition
- set position(position: AbsolutePosition): void
-
Set the current absolute position of the object relative to the global reference space
Parameters
-
position: AbsolutePosition
Returns void
-
relative
- get relativePositions(): RelativePosition<any, Unit>[]
-
Get relative positions
Returns
Array of relative positions
Returns RelativePosition<any, Unit>[]
- set relativePositions(relativePostions: RelativePosition<any, Unit>[]): void
-
Parameters
-
relativePostions: RelativePosition<any, Unit>[]
Returns void
-
timestamp
- get timestamp(): number
-
Get the sensor timestamp
Returns
timestamp
Returns number
Methods
add
- add
Relative Position(relativePosition: RelativePosition<any, Unit>): Magnetometer -
Add a relative position to this data object
Returns
Data object instance
Parameters
-
relativePosition: RelativePosition<any, Unit>
Relative position to add
Returns Magnetometer
-
bind
- bind(service: DataService<string, Magnetometer>): DataObjectBinding<Magnetometer>
-
Bind the data object to a service
Returns
Data object binding with a service
Parameters
-
service: DataService<string, Magnetometer>
Service to bind it to
Returns DataObjectBinding<Magnetometer>
-
clone
- clone<T>(dataType?: Constructor<T>): T
-
Clone the data object
Returns
Cloned data object
Type Parameters
-
T extends Magnetometer<T>
Parameters
-
OptionaldataType: Constructor<T>Data type to clone to
Returns T
-
get
- get
Position(referenceSpace?: TransformationSpace): AbsolutePosition -
Get the current absolute position of the object
Returns
Position of the data object
Parameters
-
OptionalreferenceSpace: TransformationSpaceReference space to transform it to
Returns AbsolutePosition
-
get
- get
Relative Position(referenceObjectUID: string, type?: string): RelativePosition<any, Unit> -
Get relative position of a specified object
Returns
Relative position to reference object
Parameters
-
referenceObjectUID: string
Reference object identifier
-
Optionaltype: stringConstructor type of the relative position
Returns RelativePosition<any, Unit>
-
get
- get
Relative Positions(referenceObjectUID?: string): RelativePosition<any, Unit>[] -
Get relative positions for a different target
Returns
Array of relative positions for the reference object
Parameters
-
OptionalreferenceObjectUID: stringReference object identifier
Returns RelativePosition<any, Unit>[]
-
has
remove
set
- set
Parent(object: string | DataObject): Magnetometer -
Set a parent object to the data object
Returns
instance
Parameters
-
object: string | DataObject
Data object or UID to add as parent
Returns Magnetometer
-
set
- set
Position(position: AbsolutePosition, referenceSpace?: TransformationSpace): Magnetometer -
Set the current absolute position of the object
Returns
Data object instance
Parameters
-
position: AbsolutePosition
Position to set
-
OptionalreferenceSpace: TransformationSpaceReference space
Returns Magnetometer
-
setUID
- setUID(uid: string): Magnetometer
-
Set the unique identifier of this object
Returns
Data object instance
Parameters
-
uid: string
Unique Identifier
Returns Magnetometer
-
The magnetometer sensor provides information about the magnetic field as detected by the device's primary magnetometer sensor.