Class CameraInputsManager<TCamera>
Type Parameters
TCamera extends Camera
Hierarchy
Index
Constructors
constructor
Instantiate a new Camera Input Manager.
Type Parameters
TCamera extends Camera<TCamera>
Parameters
camera: TCamera
Defines the camera the input manager belongs to
Returns CameraInputsManager<TCamera>
Properties
attachedSearch playground for attached
Defines the list of inputs attached to the camera.
attached To ElementSearch playground for attachedToElement
Defines the dom element the camera is collecting inputs from. This is null if the controls have not been attached.
cameraSearch playground for camera
Defined the camera the input manager belongs to.
check InputsSearch playground for checkInputs
Type declaration
Update the current camera state depending on the inputs that have been used this frame. This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
Returns void
no Prevent DefaultSearch playground for noPreventDefault
Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
Methods
addSearch playground for add
Add an input method to a camera
Parameters
input: ICameraInput<TCamera>
camera input method
Returns void
attach ElementSearch playground for attachElement
Attach the current manager inputs controls to a specific dom element to listen the events from.
Parameters
Optional noPreventDefault: boolean
Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
Returns void
attach InputSearch playground for attachInput
Attach the input controls to the currently attached dom element to listen the events from.
Parameters
input: ICameraInput<TCamera>
Defines the input to attach
Returns void
clearSearch playground for clear
Remove all attached input methods from a camera
Returns void
detach ElementSearch playground for detachElement
Detach the current manager inputs controls from a specific dom element.
Parameters
Optional disconnect: boolean
Defines whether the input should be removed from the current list of attached inputs
Returns void
parseSearch playground for parse
Parses an input manager serialized JSON to restore the previous list of inputs and states associated to a camera.
Parameters
parsedCamera: any
Defines the JSON to parse
Returns void
rebuild Input CheckSearch playground for rebuildInputCheck
Rebuild the dynamic inputCheck function from the current list of defined inputs in the manager.
Returns void
removeSearch playground for remove
Remove a specific input method from a camera example: camera.inputs.remove(camera.inputs.attached.mouse);
Parameters
inputToRemove: ICameraInput<TCamera>
camera input method
Returns void
remove By TypeSearch playground for removeByType
Remove a specific input type from a camera example: camera.inputs.remove("ArcRotateCameraGamepadInput");
Parameters
inputType: string
the type of the input to remove
Returns void
serializeSearch playground for serialize
Serialize the current input manager attached to a camera. This ensures than once parsed, the input associated to the camera will be identical to the current ones
Parameters
serializedCamera: any
Defines the camera serialization JSON the input serialization should write to
Returns void
This represents the input manager used within a camera. It helps dealing with all the different kind of input attached to a camera.
https://doc.babylonjs.com/how_to/customizing_camera_inputs