Class XRController

Hierarchy

GameObject<ExtendedEventMap>
- XRController

Index

Constructors

Properties

active componentMask isGameObject isGroup

Accessors

connected gamepad handedness model raySpace

Methods

addComponent clone connect copy destroy disconnect getComponent getComponentTypes hasComponent removeComponent update updateMatrixWorld

Constructors

constructor

new XRController(world: World, handedness: XRHandedness, player: GameObject<Object3DEventMap>): XRController
Parameters
- world: World
- handedness: XRHandedness
- player: GameObject<Object3DEventMap>
Returns XRController
Overrides GameObject.constructor
- Defined in src/xr/XRController.ts:43

Properties

active

active: boolean = true

componentMask

componentMask: number = 0

`Readonly` isGameObject

isGameObject: boolean = true

isGroup

isGroup: boolean = true

Accessors

connected

get connected(): boolean
Returns boolean
- Defined in src/xr/XRController.ts:54

gamepad

get gamepad(): GamepadWrapper
Returns GamepadWrapper
- Defined in src/xr/XRController.ts:62

handedness

get handedness(): XRHandedness
Returns XRHandedness
- Defined in src/xr/XRController.ts:58

model

get model(): Object3D<Object3DEventMap>
Returns Object3D<Object3DEventMap>
- Defined in src/xr/XRController.ts:70

raySpace

get raySpace(): Object3D<Object3DEventMap>
Returns Object3D<Object3DEventMap>
- Defined in src/xr/XRController.ts:66

Methods

addComponent

addComponent<T>(componentClass: T, initialData?: {
[key: string]: any;
}): Component
Type Parameters
- T extends typeof Component
Parameters
- componentClass: T
- initialData: {
  [key: string]: any;
  } = {}
  - [key: string]: any
Returns Component
Inherited from GameObject.addComponent
- Defined in src/ecs/GameObject.ts:46

clone

clone(_recursive?: boolean): XRController
Parameters
- Optional _recursive: boolean
Returns XRController
Inherited from GameObject.clone
- Defined in src/ecs/GameObject.ts:42

connect

connect(inputSource: XRInputSource): void
Parameters
- inputSource: XRInputSource
Returns void
- Defined in src/xr/XRController.ts:122

copy

copy(_source: XRController, _recursive?: boolean): XRController
Parameters
- _source: XRController
- Optional _recursive: boolean
Returns XRController
Inherited from GameObject.copy
- Defined in src/ecs/GameObject.ts:38

destroy

destroy(): void
Returns void
Inherited from GameObject.destroy
- Defined in src/ecs/GameObject.ts:102

disconnect

disconnect(): void
Returns void
- Defined in src/xr/XRController.ts:131

getComponent

getComponent<T>(componentClass: {
    bitmask: number;
    defaults: {
        [key: string]: any;
    };
    new (_cm: ComponentManager, _mi: number): T;
}): T
Type Parameters
- T extends Component<T>
Parameters
- componentClass: {
      bitmask: number;
      defaults: {
          [key: string]: any;
      };
      new (_cm: ComponentManager, _mi: number): T;
  }
  - - new (_cm: ComponentManager, _mi: number): T
    - Parameters
      
      _cm: ComponentManager
      
      _mi: number
      
      Returns T
  - bitmask: number
  - defaults: {
    [key: string]: any;
    }
    - [key: string]: any
Returns T
Inherited from GameObject.getComponent
- Defined in src/ecs/GameObject.ts:86

getComponentTypes

getComponentTypes(): typeof Component[]
Returns typeof Component[]
Inherited from GameObject.getComponentTypes
- Defined in src/ecs/GameObject.ts:97

hasComponent

hasComponent<T>(componentClass: T): boolean
Type Parameters
- T extends typeof Component
Parameters
- componentClass: T
Returns boolean
Inherited from GameObject.hasComponent
- Defined in src/ecs/GameObject.ts:81

removeComponent

removeComponent<T>(componentClass: T): void
Type Parameters
- T extends typeof Component
Parameters
- componentClass: T
Returns void
Inherited from GameObject.removeComponent
- Defined in src/ecs/GameObject.ts:65

update

update(inputSource: XRInputSource, frame: XRFrame, referenceSpace: XRReferenceSpace): void
Parameters
- inputSource: XRInputSource
- frame: XRFrame
- referenceSpace: XRReferenceSpace
Returns void
- Defined in src/xr/XRController.ts:74

updateMatrixWorld

updateMatrixWorld(force?: boolean): void
Parameters
- Optional force: boolean
Returns void
Overrides GameObject.updateMatrixWorld
- Defined in src/xr/XRController.ts:141