Class RelativeLinearVelocity
Hierarchy-Diagram
Legend
class
Hierarchy
- RelativePosition<LinearVelocity, LinearVelocityUnit>
- RelativeLinearVelocity
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
- new
Relative Linear Velocity(referenceObject?: any, velocity?: LinearVelocity): RelativeLinearVelocity -
Parameters
-
OptionalreferenceObject: any -
Optionalvelocity: LinearVelocity
Returns RelativeLinearVelocity
-
Properties
reference
reference
reference
reference
Reference object UID that this location is relative to
reference
timestamp
timestamp: number = ...
Position recording timestamp
Accessors
accuracy
probability
- get probability(): number
-
Get the position probability
Returns
Probability between 0 and 1
Returns number
- set probability(value: number): void
-
Position probability
Parameters
-
value: number
Returns void
-
velocity
- get velocity(): LinearVelocity
-
Returns LinearVelocity
- set velocity(value: LinearVelocity): void
-
Parameters
-
value: LinearVelocity
Returns void
-
Methods
clone
- clone(): RelativeLinearVelocity
-
Clone the position
Returns
Cloned relative position
Returns RelativeLinearVelocity
equals
- equals(position: RelativeLinearVelocity): boolean
-
Check if this position equals another position
Parameters
-
position: RelativeLinearVelocity
Other position
Returns boolean
-
set
- set
Accuracy(accuracy: number | Accuracy<LinearVelocityUnit, any>, unit?: LinearVelocityUnit): RelativeLinearVelocity -
Set the accuracy of the absolute position
Returns
instance
Parameters
-
accuracy: number | Accuracy<LinearVelocityUnit, any>
Accuracy object or number
-
Optionalunit: LinearVelocityUnitOptional unit
Returns RelativeLinearVelocity
-
Relative linear velocity to another reference object