Class DeviceOrientationControls

Hierarchy

EventDispatcher
- DeviceOrientationControls

Constructors

constructor

new DeviceOrientationControls(
object: Object3D,
options?: DeviceOrientationControlsOptions,
): DeviceOrientationControls
Create an instance of DeviceOrientationControls.
Parameters
- object: Object3D
  the object to attach the controls to (usually your Three.js camera)
- options: DeviceOrientationControlsOptions = {}
  options for DeviceOrientationControls: currently accepts smoothingFactor (< 1), enablePermissionDialog, orientationChangeThreshold (radians)
Returns DeviceOrientationControls
Overrides EventDispatcher.constructor
- Defined in lib/three/device-orientation-controls.ts:105

Properties

alphaOffset

alphaOffset: number

connect

connect: () => void

createObtainPermissionGestureDialog

createObtainPermissionGestureDialog: () => void

deviceOrientation

deviceOrientation:
    | {
        absolute?: boolean;
        alpha?: number;
        beta?: number;
        gamma?: number;
        webkitCompassHeading?: number;
    }
    | null

disconnect

disconnect: () => void

dispose

dispose: () => void

enabled

enabled: boolean

enableInlineStyling

enableInlineStyling: boolean

enablePermissionDialog

enablePermissionDialog: boolean

eventEmitter

eventEmitter: EventEmitter

getAlpha

getAlpha: () => number

getBeta

getBeta: () => number

getCorrectedHeading

getCorrectedHeading: () => number

getGamma

getGamma: () => number

initialOffset

initialOffset: boolean | null

lastQuaternion

lastQuaternion: Quaternion | null

object

object: Object3D

obtainPermissionGesture

obtainPermissionGesture: () => void

orientationChangeEventName

orientationChangeEventName: "deviceorientation" | "deviceorientationabsolute"

orientationChangeThreshold

orientationChangeThreshold: number

orientationOffset

orientationOffset: number

preferConfirmDialog

preferConfirmDialog: boolean

requestOrientationPermissions

requestOrientationPermissions: () => void

screenOrientation

screenOrientation: number

smoothingFactor

smoothingFactor: number

update

update: () => void

updateAlphaOffset

updateAlphaOffset: () => void

Methods

addEventListener

addEventListener<T extends never>(
type: T,
listener: EventListener<{}[T], T, DeviceOrientationControls>,
): void
Adds a listener to an event type.
Type Parameters
- T extends never
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<{}[T], T, DeviceOrientationControls>
  The function that gets called when the event is fired.
Returns void
Inherited from EventDispatcher.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:52

dispatchEvent

dispatchEvent<T extends never>(event: BaseEvent<T> & {}[T]): void
Fire an event type.
Type Parameters
- T extends never
Parameters
- event: BaseEvent<T> & {}[T]
  The event that gets fired.
Returns void
Inherited from EventDispatcher.dispatchEvent
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:81

hasEventListener

hasEventListener<T extends never>(
type: T,
listener: EventListener<{}[T], T, DeviceOrientationControls>,
): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends never
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<{}[T], T, DeviceOrientationControls>
  The function that gets called when the event is fired.
Returns boolean
Inherited from EventDispatcher.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:62

init

init(): void
Initialise device orientation controls. Should be called after you have created the DeviceOrientationControls object and set up the deviceorientationgranted and deviceorientationerror event handlers.

Returns void
- Defined in lib/three/device-orientation-controls.ts:525

on

on(eventName: string, eventHandler: (event: any) => void): void
Parameters
- eventName: string
- eventHandler: (event: any) => void
Returns void
- Defined in lib/three/device-orientation-controls.ts:514

removeEventListener

removeEventListener<T extends never>(
type: T,
listener: EventListener<{}[T], T, DeviceOrientationControls>,
): void
Removes a listener from an event type.
Type Parameters
- T extends never
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<{}[T], T, DeviceOrientationControls>
  The listener function that gets removed.
Returns void
Inherited from EventDispatcher.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:72

Class DeviceOrientationControls

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DeviceOrientationControls

Properties

alphaOffset

connect

createObtainPermissionGestureDialog

deviceOrientation

disconnect

dispose

enabled

enableInlineStyling

enablePermissionDialog

eventEmitter

getAlpha

getBeta

getCorrectedHeading

getGamma

initialOffset

lastQuaternion

object

obtainPermissionGesture

orientationChangeEventName

orientationChangeThreshold

orientationOffset

preferConfirmDialog

requestOrientationPermissions

screenOrientation

smoothingFactor

update

updateAlphaOffset

Methods

addEventListener

Type Parameters

Parameters

Returns void

dispatchEvent

Type Parameters

Parameters

Returns void

hasEventListener

Type Parameters

Parameters

Returns boolean

init

Returns void

on

Parameters

Returns void

removeEventListener

Type Parameters

Parameters

Returns void

Settings

On This Page