Skip to content

editor › Globals › AccelerometerAddOn

Class: AccelerometerAddOn

Hierarchy

↳ AccelerometerAddOn

Index

Constructors

Properties

Methods

Constructors

constructor

+ new AccelerometerAddOn(modelSubnode: Object3D, renderContext: RenderContext): AccelerometerAddOn

Overrides PhysicsAddOn.constructor

Defined in src/physics/addOns/AccelerometerAddOn.ts:31

Parameters:

Name Type
modelSubnode Object3D
renderContext RenderContext

Returns: AccelerometerAddOn

Properties

Private acceleration

• acceleration: Vector3‹› = new Vector3()

Defined in src/physics/addOns/AccelerometerAddOn.ts:25

Private accelerationIncludingGravity

• accelerationIncludingGravity: Vector3‹› = new Vector3()

Defined in src/physics/addOns/AccelerometerAddOn.ts:26

Protected compositeModel

• compositeModel: CompositeModel

Inherited from PhysicsAddOn.compositeModel

Defined in src/physics/addOns/PhysicsAddOn.ts:15

Private defaultGravityVector

• defaultGravityVector: Vector3‹› = new Vector3()

Defined in src/physics/addOns/AccelerometerAddOn.ts:24

Private deviceFactor

• deviceFactor: Vector3‹› = new Vector3()

Defined in src/physics/addOns/AccelerometerAddOn.ts:27

Private deviceOrientation

• deviceOrientation: any = null

Defined in src/physics/addOns/AccelerometerAddOn.ts:28

Private landscapeQuery

• landscapeQuery: any = null

Defined in src/physics/addOns/AccelerometerAddOn.ts:30

Private mode

• mode: any

Defined in src/physics/addOns/AccelerometerAddOn.ts:31

Protected modelSubnode

• modelSubnode: Object3D

Inherited from PhysicsAddOn.modelSubnode

Defined in src/physics/addOns/PhysicsAddOn.ts:11

Private mostRecentEvent

• mostRecentEvent: any = null

Defined in src/physics/addOns/AccelerometerAddOn.ts:23

Private orientationQuery

• orientationQuery: any = null

Defined in src/physics/addOns/AccelerometerAddOn.ts:29

Protected physicsContext

• physicsContext: PhysicsContext

Inherited from PhysicsAddOn.physicsContext

Defined in src/physics/addOns/PhysicsAddOn.ts:14

Protected renderContext

• renderContext: RenderContext

Inherited from PhysicsAddOn.renderContext

Defined in src/physics/addOns/PhysicsAddOn.ts:12

Protected threeNode

• threeNode: Object3D = null

Inherited from PhysicsAddOn.threeNode

Defined in src/physics/addOns/PhysicsAddOn.ts:13

Private world

• world: any = null

Defined in src/physics/addOns/AccelerometerAddOn.ts:22

Methods

Private _addArrow

▸ _addArrow(vector: Vector3, color: any): void

Defined in src/physics/addOns/AccelerometerAddOn.ts:67

Parameters:

Name Type
vector Vector3
color any

Returns: void

Private _applyAccelerationMode

▸ _applyAccelerationMode(): void

Defined in src/physics/addOns/AccelerometerAddOn.ts:116

Returns: void

Private _applyDeviceFactor

▸ _applyDeviceFactor(acceleration: Vector3): Vector3‹›

Defined in src/physics/addOns/AccelerometerAddOn.ts:149

Applies the device factor @see _initDeviceFactor

Parameters:

Name Type
acceleration Vector3

Returns: Vector3‹›

Private _applyDeviceOrientation

▸ _applyDeviceOrientation(acceleration: Vector3, accelerationIncludingGravity: Vector3): void

Defined in src/physics/addOns/AccelerometerAddOn.ts:157

This method converts the acceleration vector (in device coordinates) to world coordinates by taking into account the orientation of the device.

Parameters:

Name Type
acceleration Vector3
accelerationIncludingGravity Vector3

Returns: void

Private _applyGravityMode

▸ _applyGravityMode(): void

Defined in src/physics/addOns/AccelerometerAddOn.ts:128

Returns: void

Private _getDeviceOrientationAngle

▸ _getDeviceOrientationAngle(acceleration: Vector3, accelerationIncludingGravity: Vector3): any

Defined in src/physics/addOns/AccelerometerAddOn.ts:183

Parameters:

Name Type
acceleration Vector3
accelerationIncludingGravity Vector3

Returns: any

Private _getDeviceOrientationAngleFromSreenAPI

▸ _getDeviceOrientationAngleFromSreenAPI(): any

Defined in src/physics/addOns/AccelerometerAddOn.ts:192

Returns: any

Private _getOrientationAngleFromMediaQueryAPI

▸ _getOrientationAngleFromMediaQueryAPI(acceleration: Vector3, accelerationIncludingGravity: Vector3): 0 | 90 | 270

Defined in src/physics/addOns/AccelerometerAddOn.ts:203

Parameters:

Name Type
acceleration Vector3
accelerationIncludingGravity Vector3

Returns: 0 | 90 | 270

Private _handleDeviceMotionChange

▸ _handleDeviceMotionChange(event: any): void

Defined in src/physics/addOns/AccelerometerAddOn.ts:85

Parameters:

Name Type
event any

Returns: void

Private _handleOrientationChange

▸ _handleOrientationChange(mediaQueryList: any): void

Defined in src/physics/addOns/AccelerometerAddOn.ts:249

Parameters:

Name Type
mediaQueryList any

Returns: void

Private _initDeviceFactor

▸ _initDeviceFactor(): void

Defined in src/physics/addOns/AccelerometerAddOn.ts:238

This method determines the factor necessary to convert the device acceleration vector to the specification https://w3c.github.io/deviceorientation/spec-source-orientation.html.

Returns: void

Private _initListener

▸ _initListener(): void

Defined in src/physics/addOns/AccelerometerAddOn.ts:230

Returns: void

Private _initOrientationMediaQueries

▸ _initOrientationMediaQueries(): void

Defined in src/physics/addOns/AccelerometerAddOn.ts:253

Returns: void

Private _mapDeviceCoordinatesToSceneCoordinates

▸ _mapDeviceCoordinatesToSceneCoordinates(acceleration: Vector3): void

Defined in src/physics/addOns/AccelerometerAddOn.ts:176

Parameters:

Name Type
acceleration Vector3

Returns: void

Private _renderDebug

▸ _renderDebug(): void

Defined in src/physics/addOns/AccelerometerAddOn.ts:77

Returns: void

Private _shouldApplyAcceleration

▸ _shouldApplyAcceleration(acceleration: Vector3): boolean

Defined in src/physics/addOns/AccelerometerAddOn.ts:137

Parameters:

Name Type
acceleration Vector3

Returns: boolean

Private _shouldApplyGravity

▸ _shouldApplyGravity(gravityVector: Vector3, defaultGravityVector: Vector3): boolean

Defined in src/physics/addOns/AccelerometerAddOn.ts:141

Parameters:

Name Type
gravityVector Vector3
defaultGravityVector Vector3

Returns: boolean

destroy

▸ destroy(): void

Overrides PhysicsAddOn.destroy

Defined in src/physics/addOns/AccelerometerAddOn.ts:58

Returns: void

getName

▸ getName(): string

Overrides PhysicsAddOn.getName

Defined in src/physics/addOns/AccelerometerAddOn.ts:63

Returns: string

getPriority

▸ getPriority(): number

Inherited from PhysicsAddOn.getPriority

Defined in src/physics/addOns/PhysicsAddOn.ts:32

enforce a certain rendering and physics-step order. AddOns with higher priority will be rendered & executed before AddOns with a lower priority

Returns: number

getThreeNode

▸ getThreeNode(): Object3D

Inherited from PhysicsAddOn.getThreeNode

Defined in src/physics/addOns/PhysicsAddOn.ts:68

Returns: Object3D

initializeCompositeModel

▸ initializeCompositeModel(compositeModel: CompositeModel): void

Inherited from PhysicsAddOn.initializeCompositeModel

Defined in src/physics/addOns/PhysicsAddOn.ts:86

You should override this method to be notified when the compositeModel is set. This may be called multiple times during the lifecycle of an AddOn with different parameters.

Parameters:

Name Type Description
compositeModel CompositeModel the compositeModel, guaranteed to not be null or undefined

Returns: void

initializeThreeNode

▸ initializeThreeNode(threeNode: Object3D): void

Inherited from PhysicsAddOn.initializeThreeNode

Defined in src/physics/addOns/PhysicsAddOn.ts:77

You should override this method to set up the scene. Create all the objects you need and add() them to threeNode.

Parameters:

Name Type Description
threeNode Object3D the parent node

Returns: void

render

▸ render(): void

Overrides PhysicsAddOn.render

Defined in src/physics/addOns/AccelerometerAddOn.ts:54

Returns: void

requiresContinuousRendering

▸ requiresContinuousRendering(): boolean

Inherited from PhysicsAddOn.requiresContinuousRendering

Defined in src/physics/addOns/PhysicsAddOn.ts:104

Returns: boolean

setCompositeModel

▸ setCompositeModel(compositeModel: CompositeModel): void

Inherited from PhysicsAddOn.setCompositeModel

Defined in src/physics/addOns/PhysicsAddOn.ts:63

Parameters:

Name Type
compositeModel CompositeModel

Returns: void

setPhysicsContext

▸ setPhysicsContext(physicsContext: PhysicsContext): void

Overrides PhysicsAddOn.setPhysicsContext

Defined in src/physics/addOns/AccelerometerAddOn.ts:47

Parameters:

Name Type
physicsContext PhysicsContext

Returns: void

setThreeNode

▸ setThreeNode(threeNode: Object3D): void

Inherited from PhysicsAddOn.setThreeNode

Defined in src/physics/addOns/PhysicsAddOn.ts:54

Parameters:

Name Type
threeNode Object3D

Returns: void

step

▸ step(elapsedTime: number): void

Inherited from PhysicsAddOn.step

Defined in src/physics/addOns/PhysicsAddOn.ts:43

Advance the simulation by elapsedTime. Hint: Do not update the view in this method, because this might be called multiple times per rendered frame.

Parameters:

Name Type Description
elapsedTime number the time delta in seconds

Returns: void

updateSiblings

▸ updateSiblings(addOns: PhysicsAddOn[]): void

Inherited from PhysicsAddOn.updateSiblings

Defined in src/physics/addOns/PhysicsAddOn.ts:100

This is called when the physics addOns change to allow interaction between addOns.

Parameters:

Name Type
addOns PhysicsAddOn[]

Returns: void

Static isSupported

▸ isSupported(): boolean

Defined in src/physics/addOns/AccelerometerAddOn.ts:13

Returns: boolean