Class PoseEnabledController

Defines the PoseEnabledController object that contains state of a vr capable controller

Hierarchy

Gamepad
- PoseEnabledController
  - WebVRController

Implements

PoseControlled

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new PoseEnabledController(browserGamepad: any): PoseEnabledController

Overrides Gamepad.constructor
- Defined in .temp/docdirectory/doc.d.ts:26613
Creates a new PoseEnabledController from a gamepad

Parameters
- browserGamepad: any
  
  the gamepad that the PoseEnabledController should be created from
Returns PoseEnabledController

Properties

browserGamepadSearch playground for browserGamepad

browserGamepad: any

The browser gamepad

controllerTypeSearch playground for controllerType

controllerType: PoseEnabledControllerType

The type of controller (Eg. Windows mixed reality)

devicePositionSearch playground for devicePosition

devicePosition: Vector3

The device position in babylon space

deviceRotationQuaternionSearch playground for deviceRotationQuaternion

deviceRotationQuaternion: Quaternion

The device rotation in babylon space

deviceScaleFactorSearch playground for deviceScaleFactor

deviceScaleFactor: number

The scale factor of the device in babylon space

idSearch playground for id

id: string

The id of the gamepad

indexSearch playground for index

index: number

The index of the gamepad

isXRSearch playground for isXR

isXR: boolean

If the controller is used in a webXR session

positionSearch playground for position

position: Vector3

(Likely devicePosition should be used instead) The device position in its room space

rawPoseSearch playground for rawPose

rawPose: DevicePose

The raw pose from the device

rotationQuaternionSearch playground for rotationQuaternion

rotationQuaternion: Quaternion

(Likely deviceRotationQuaternion should be used instead) The device rotation in its room space

typeSearch playground for type

type: number

Specifies what type of gamepad this represents

Static DUALSHOCKSearch playground for DUALSHOCK

DUALSHOCK: number

Represents an Dual Shock controller

Static GAMEPADSearch playground for GAMEPAD

GAMEPAD: number

Represents a gamepad controller

Static GENERICSearch playground for GENERIC

GENERIC: number

Represents a generic controller

Static Readonly POINTING_POSESearch playground for POINTING_POSE

POINTING_POSE: "POINTING_POSE" = "POINTING_POSE"

Name of the child mesh that can be used to cast a ray from the controller

Static POSE_ENABLEDSearch playground for POSE_ENABLED

POSE_ENABLED: number

Represents a pose-enabled controller

Static XBOXSearch playground for XBOX

XBOX: number

Represents an XBox controller

Accessors

isConnected

get isConnected(): boolean

Inherited from DaydreamController.isConnected
- Defined in .temp/docdirectory/doc.d.ts:27359
Specifies if the gamepad has been connected

Returns boolean

leftStick

get leftStick(): StickValues
set leftStick(newValues: StickValues): any

Inherited from DaydreamController.leftStick
- Defined in .temp/docdirectory/doc.d.ts:27396
Gets the left joystick

Returns StickValues
Inherited from DaydreamController.leftStick
- Defined in .temp/docdirectory/doc.d.ts:27400
Sets the left joystick values

Parameters
- newValues: StickValues
Returns any

mesh

get mesh(): Nullable<AbstractMesh>

- Defined in .temp/docdirectory/doc.d.ts:26654
The mesh that is attached to the controller

Returns Nullable<AbstractMesh>

rightStick

get rightStick(): StickValues
set rightStick(newValues: StickValues): any

Inherited from DaydreamController.rightStick
- Defined in .temp/docdirectory/doc.d.ts:27404
Gets the right joystick

Returns StickValues
Inherited from DaydreamController.rightStick
- Defined in .temp/docdirectory/doc.d.ts:27408
Sets the right joystick value

Parameters
- newValues: StickValues
Returns any

Methods

attachToMeshSearch playground for attachToMesh

attachToMesh(mesh: AbstractMesh): void

- Defined in .temp/docdirectory/doc.d.ts:26641
Attaches a mesh to the controller

Parameters
- mesh: AbstractMesh
  
  the mesh to be attached
Returns void

attachToPoseControlledCameraSearch playground for attachToPoseControlledCamera

attachToPoseControlledCamera(camera: TargetCamera): void

- Defined in .temp/docdirectory/doc.d.ts:26646
Attaches the controllers mesh to a camera

Parameters
- camera: TargetCamera
  
  the camera the mesh should be attached to
Returns void

disposeSearch playground for dispose

dispose(): void

Overrides Gamepad.dispose
- Defined in .temp/docdirectory/doc.d.ts:26650
Disposes of the controller

Returns void

getForwardRaySearch playground for getForwardRay

getForwardRay(length?: number): Ray

- Defined in .temp/docdirectory/doc.d.ts:26660
Gets the ray of the controller in the direction the controller is pointing

Parameters
- Optional length: number
  
  the length the resulting ray should be
Returns Ray

a ray in the direction the controller is pointing

onleftstickchangedSearch playground for onleftstickchanged

onleftstickchanged(callback: (values: StickValues) => void): void

Inherited from DaydreamController.onleftstickchanged
- Defined in .temp/docdirectory/doc.d.ts:27387
Callback triggered when the left joystick has changed

Parameters
- callback: (values: StickValues) => void
  - - (values: StickValues): void
    - Parameters
      - values: StickValues
      Returns void
Returns void

onrightstickchangedSearch playground for onrightstickchanged

onrightstickchanged(callback: (values: StickValues) => void): void

Inherited from DaydreamController.onrightstickchanged
- Defined in .temp/docdirectory/doc.d.ts:27392
Callback triggered when the right joystick has changed

Parameters
- callback: (values: StickValues) => void
  - - (values: StickValues): void
    - Parameters
      - values: StickValues
      Returns void
Returns void

updateSearch playground for update

update(): void

Overrides Gamepad.update
- Defined in .temp/docdirectory/doc.d.ts:26623
Updates the state of the pose enabled controller and mesh based on the current position and rotation of the controller

Returns void

updateFromDeviceSearch playground for updateFromDevice

updateFromDevice(poseData: DevicePose): void

Implementation of PoseControlled.updateFromDevice
- Defined in .temp/docdirectory/doc.d.ts:26632
Updates the state of the pose enbaled controller based on the raw pose data from the device

Parameters
- poseData: DevicePose
  
  raw pose fromthe device
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

browserGamepad: any

Returns PoseEnabledController

Properties

browserGamepadSearch playground for browserGamepad

controllerTypeSearch playground for controllerType

devicePositionSearch playground for devicePosition

deviceRotationQuaternionSearch playground for deviceRotationQuaternion

deviceScaleFactorSearch playground for deviceScaleFactor

idSearch playground for id

indexSearch playground for index

isXRSearch playground for isXR

positionSearch playground for position

rawPoseSearch playground for rawPose

rotationQuaternionSearch playground for rotationQuaternion

typeSearch playground for type

Static DUALSHOCKSearch playground for DUALSHOCK

Static GAMEPADSearch playground for GAMEPAD

Static GENERICSearch playground for GENERIC

Static Readonly POINTING_POSESearch playground for POINTING_POSE

Static POSE_ENABLEDSearch playground for POSE_ENABLED

Static XBOXSearch playground for XBOX

Accessors

isConnected

Returns boolean

leftStick

Returns StickValues

Parameters

newValues: StickValues

Returns any

mesh

Returns Nullable<AbstractMesh>

rightStick

Returns StickValues

Parameters

newValues: StickValues

Returns any

Methods

attachToMeshSearch playground for attachToMesh

Parameters

mesh: AbstractMesh

Returns void

attachToPoseControlledCameraSearch playground for attachToPoseControlledCamera

Parameters

camera: TargetCamera

Returns void

disposeSearch playground for dispose

Returns void

getForwardRaySearch playground for getForwardRay

Parameters

Optional length: number

Returns Ray

onleftstickchangedSearch playground for onleftstickchanged

Parameters

callback: (values: StickValues) => void

Parameters

values: StickValues

Returns void

Returns void

onrightstickchangedSearch playground for onrightstickchanged

Parameters

callback: (values: StickValues) => void

Parameters

values: StickValues

Returns void

Returns void

updateSearch playground for update

Returns void

updateFromDeviceSearch playground for updateFromDevice

Parameters

poseData: DevicePose