Class CursorHandler

Index

Constructors

Properties

_enabled frame interactorCursor lastMode lockMode lockPosition margin mode options parentTransform target targetTransform

Accessors

Methods

resetCursor setCursor update

Constructors

constructor

new CursorHandler(options: CursorManagerOptions): CursorHandler
Parameters
- options: CursorManagerOptions
Returns CursorHandler

Properties

`Private`_enabled

_enabled: boolean = false

`Private`frame

frame: ContainerFrame = ...

`Private`interactorCursor

interactorCursor: InteractorCursor = null

`Private`lastMode

lastMode: CursorMode = ...

`Private`lockMode

lockMode: boolean = false

`Private`lockPosition

lockPosition: vec3 = ...

`Private`margin

margin: number = ...

mode

mode: CursorMode = CursorMode.Auto

mode is used to select the current active texture updated in ContainerFrame update loop to match the FrameInputController state

`Private`options

options: CursorManagerOptions

`Private`parentTransform

parentTransform: Transform = ...

`Private`target

target: SceneObject = ...

`Private`targetTransform

targetTransform: Transform = ...

Accessors

position

set position(pos: vec3): void
sets current position of cursor ignored if cursor is in lockMode
Parameters
- pos: vec3
Returns void

Methods

resetCursor

resetCursor(): void
Reset the position override & mode of the interactor cursor.

Returns void

setCursor

setCursor(cursor: InteractorCursor): void
Sets the InteractorCursor for the handler to control.
Parameters
- cursor: InteractorCursor
Returns void

update

update(inputState: InputState, frameState: FrameState): void
update
Parameters
- inputState: InputState
- frameState: FrameState
  method called in main loop watches for changed CursorModes to swap textures updates position and triggers animations
Returns void