Class FollowCameraPointersInput
Hierarchy
- BaseCameraPointersInput
- FollowCameraPointersInput
Index
Constructors
Properties
Methods
Constructors
constructor
Returns FollowCameraPointersInput
Properties
angular
Defines the pointer angular sensibility along the X axis or how fast is the camera rotating. A negative number will reverse the axis direction.
angular
Defines the pointer angular sensibility along the Y axis or how fast is the camera rotating. A negative number will reverse the axis direction.
axis
Pinch controls height. (Pinch modifies camera.heightOffset value.)
axis
Pinch controls zoom. (Pinch modifies camera.radius value.)
axis
Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
axisXControl
Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
axisXControl
Pointer X axis controls zoom. (X axis modifies camera.radius value.)
axisXControl
Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
axisYControl
Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
axisYControl
Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
axisYControl
Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
buttonsSearch playground for buttons
Defines the buttons associated with the input to handle camera move.
cameraSearch playground for camera
Defines the camera the input is attached to.
pinch
pinchDeltaPercentage will be used instead of pinchPrecision if different from 0. It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
pinch
Defines the pointer pinch precision or how fast is the camera zooming. A negative number will reverse the axis direction.
warning
Log error messages if basic misconfiguration has occurred.
Methods
attach
Attach the input controls to a specific dom element to get the input 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
detach
Detach the current controls from the specified dom element.
Returns void
get
Gets the class name of the current input.
Returns string
the class name
get
Get the friendly name associated with the input class.
Returns string
the input friendly name
on
Called each time a new POINTERDOWN event occurs. Ie, for each button press. Override this method to provide functionality.
Parameters
_evt: IPointerEvent
Defines the event to track
Returns void
on
Called each time a new POINTERUP event occurs. Ie, for each button release. Override this method to provide functionality.
Parameters
_evt: IPointerEvent
Defines the event to track
Returns void
on
Called on JS contextmenu event. Override this method to provide functionality.
Parameters
evt: PointerEvent
Returns void
on
Called on pointer POINTERDOUBLETAP event. Override this method to provide functionality on POINTERDOUBLETAP event.
Parameters
type: string
Returns void
on
Called when window becomes inactive. Override this method to provide functionality.
Returns void
on
Called on pointer POINTERMOVE event if multiple touches are active. Override this method to provide functionality.
Parameters
pointA: Nullable<PointerTouch>
pointB: Nullable<PointerTouch>
previousPinchSquaredDistance: number
pinchSquaredDistance: number
previousMultiTouchPanPosition: Nullable<PointerTouch>
multiTouchPanPosition: Nullable<PointerTouch>
Returns void
on
Called on pointer POINTERMOVE event if only a single touch is active. Override this method to provide functionality.
Parameters
pointA: Nullable<PointerTouch>
offsetX: number
offsetY: number
Returns void
Manage the pointers inputs to control an follow camera.
https://doc.babylonjs.com/features/featuresDeepDive/cameras/customizingCameraInputs