#include <juce_MouseInputSource.h>
Classes | |
| struct | SourceList |
Public Types | |
| enum | InputSourceType { mouse , touch , pen } |
Static Public Attributes | |
| static constexpr float | defaultPressure = 0.0f |
| static constexpr float | defaultOrientation = 0.0f |
| static constexpr float | defaultRotation = 0.0f |
| static constexpr float | defaultTiltX = 0.0f |
| static constexpr float | defaultTiltY = 0.0f |
| static const float | invalidPressure = 0.0f |
| static const float | invalidOrientation = 0.0f |
| static const float | invalidRotation = 0.0f |
| static const float | invalidTiltX = 0.0f |
| static const float | invalidTiltY = 0.0f |
| static const Point< float > | offscreenMousePos { -10.0f, -10.0f } |
Private Member Functions | |
| MouseInputSource (MouseInputSourceInternal *) noexcept | |
| void | handleEvent (ComponentPeer &, Point< float >, int64 time, ModifierKeys, float, float, const PenDetails &) |
| void | handleWheel (ComponentPeer &, Point< float >, int64 time, const MouseWheelDetails &) |
| void | handleMagnifyGesture (ComponentPeer &, Point< float >, int64 time, float scaleFactor) |
Static Private Member Functions | |
| static Point< float > | getCurrentRawMousePosition () |
| static void | setRawMousePosition (Point< float >) |
Private Attributes | |
| MouseInputSourceInternal * | pimpl |
Friends | |
| class | ComponentPeer |
| class | Desktop |
| class | MouseInputSourceInternal |
Detailed Description
Represents a linear source of mouse events from a mouse device or individual finger in a multi-touch environment.
Each MouseEvent object contains a reference to the MouseInputSource that generated it. In an environment with a single mouse for input, all events will come from the same source, but in a multi-touch system, there may be multiple MouseInputSource objects active, each representing a stream of events coming from a particular finger.
Events coming from a single MouseInputSource are always sent in a fixed and predictable order: a mouseMove will never be called without a mouseEnter having been sent beforehand, the only events that can happen between a mouseDown and its corresponding mouseUp are mouseDrags, etc. When there are multiple touches arriving from multiple MouseInputSources, their event streams may arrive in an interleaved order, so you should use the getIndex() method to find out which finger each event came from.
- See also
- MouseEvent
@tags{GUI}
Member Enumeration Documentation
◆ InputSourceType
| enum juce::MouseInputSource::InputSourceType |
Constructor & Destructor Documentation
◆ MouseInputSource() [1/2]
|
noexcept |
◆ ~MouseInputSource()
|
noexcept |
◆ MouseInputSource() [2/2]
|
explicitprivatenoexcept |
Member Function Documentation
◆ canDoUnboundedMovement()
|
noexcept |
Returns true if this mouse can be moved indefinitely in any direction without running out of space.
◆ canHover()
|
noexcept |
Returns true if this source has an on-screen pointer that can hover over items without clicking them.
◆ enableUnboundedMouseMovement()
| void juce::MouseInputSource::enableUnboundedMouseMovement | ( | bool | isEnabled, |
| bool | keepCursorVisibleUntilOffscreen = false ) const |
Allows the mouse to move beyond the edges of the screen.
Calling this method when the mouse button is currently pressed will remove the cursor from the screen and allow the mouse to (seem to) move beyond the edges of the screen.
This means that the coordinates returned to mouseDrag() will be unbounded, and this can be used for things like custom slider controls or dragging objects around, where movement would be otherwise be limited by the mouse hitting the edges of the screen.
The unbounded mode is automatically turned off when the mouse button is released, or it can be turned off explicitly by calling this method again.
- Parameters
-
isEnabled whether to turn this mode on or off keepCursorVisibleUntilOffscreen if set to false, the cursor will immediately be hidden; if true, it will only be hidden when it is moved beyond the edge of the screen
◆ forceMouseCursorUpdate()
| void juce::MouseInputSource::forceMouseCursorUpdate | ( | ) |
Forces an update of the mouse cursor for whatever component it's currently over.
◆ getComponentUnderMouse()
| Component * juce::MouseInputSource::getComponentUnderMouse | ( | ) | const |
Returns the component that was last known to be under this pointer.
◆ getCurrentModifiers()
|
noexcept |
Returns a set of modifiers that indicate which buttons are currently held down on this device.
◆ getCurrentOrientation()
|
noexcept |
Returns the device's current orientation in radians. 0 indicates a touch pointer aligned with the x-axis and pointing from left to right; increasing values indicate rotation in the clockwise direction. Only reported by a touch pointer.
◆ getCurrentPressure()
|
noexcept |
Returns the device's current touch or pen pressure. The range is 0 (soft) to 1 (hard). If the input device doesn't provide any pressure data, it may return a negative value here, or 0.0 or 1.0, depending on the platform.
◆ getCurrentRawMousePosition()
|
staticprivate |
◆ getCurrentRotation()
|
noexcept |
Returns the device's current rotation. Indicates the clockwise rotation, or twist, of the pointer in radians. The default is 0. Only reported by a pen pointer.
◆ getCurrentTilt()
|
noexcept |
Returns the angle of tilt of the pointer in a range of -1.0 to 1.0 either in the x- or y-axis. The default is 0. If x-axis, a positive value indicates a tilt to the right and if y-axis, a positive value indicates a tilt toward the user. Only reported by a pen pointer.
◆ getIndex()
|
noexcept |
Returns this source's index in the global list of possible sources. If the system only has a single mouse, there will only be a single MouseInputSource with an index of 0.
If the system supports multi-touch input, then the index will represent a finger number, starting from 0. When the first touch event begins, it will have finger number 0, and then if a second touch happens while the first is still down, it will have index 1, etc.
◆ getLastMouseDownPosition()
|
noexcept |
Returns the screen position at which the last mouse-down occurred.
◆ getLastMouseDownTime()
|
noexcept |
Returns the time at which the last mouse-down occurred.
◆ getNumberOfMultipleClicks()
|
noexcept |
Returns the number of clicks that should be counted as belonging to the current mouse event. So the mouse is currently down and it's the second click of a double-click, this will return 2.
◆ getRawScreenPosition()
|
noexcept |
Returns the last-known screen position of this source without any scaling applied.
◆ getScreenPosition()
|
noexcept |
Returns the last-known screen position of this source.
◆ getType()
|
noexcept |
Returns the type of input source that this object represents.
◆ handleEvent()
|
private |
◆ handleMagnifyGesture()
|
private |
◆ handleWheel()
|
private |
◆ hasMouseCursor()
|
noexcept |
Returns true if this input source uses a visible mouse cursor.
◆ hasMouseMovedSignificantlySincePressed()
|
noexcept |
◆ hasMouseWheel()
|
noexcept |
Returns true if this source may have a scroll wheel.
◆ hasMovedSignificantlySincePressed()
|
noexcept |
Returns true if this input source has been dragged more than a couple of pixels from the place it was pressed.
◆ hideCursor()
| void juce::MouseInputSource::hideCursor | ( | ) |
Hides the mouse cursor (if there is one).
◆ isDragging()
|
noexcept |
Returns true if this device is currently being pressed.
◆ isLongPressOrDrag()
|
noexcept |
Returns true if this input source represents a long-press or drag interaction i.e. it has been held down for a significant amount of time or it has been dragged more than a couple of pixels from the place it was pressed.
◆ isMouse()
|
noexcept |
Returns true if this object represents a normal desk-based mouse device.
◆ isOrientationValid()
|
noexcept |
Returns true if the current orientation value is meaningful.
◆ isPen()
|
noexcept |
Returns true if this object represents a pen device.
◆ isPressureValid()
|
noexcept |
Returns true if the current pressure value is meaningful.
◆ isRotationValid()
|
noexcept |
Returns true if the current rotation value is meaningful.
◆ isTiltValid()
|
noexcept |
Returns true if the current tilt value (either x- or y-axis) is meaningful.
◆ isTouch()
|
noexcept |
Returns true if this object represents a source of touch events.
◆ isUnboundedMouseMovementEnabled()
| bool juce::MouseInputSource::isUnboundedMouseMovementEnabled | ( | ) | const |
Returns true if this source is currently in "unbounded" mode.
◆ operator!=()
|
inlinenoexcept |
◆ operator=()
|
noexcept |
◆ operator==()
|
inlinenoexcept |
◆ revealCursor()
| void juce::MouseInputSource::revealCursor | ( | ) |
Un-hides the mouse cursor if it was hidden by hideCursor().
◆ setRawMousePosition()
◆ setScreenPosition()
Attempts to set this mouse pointer's screen position.
◆ showMouseCursor()
| void juce::MouseInputSource::showMouseCursor | ( | const MouseCursor & | cursor | ) |
Changes the mouse cursor, (if there is one).
◆ triggerFakeMove()
| void juce::MouseInputSource::triggerFakeMove | ( | ) | const |
Tells the device to dispatch a mouse-move or mouse-drag event. This is asynchronous - the event will occur on the message thread.
Friends And Related Symbol Documentation
◆ ComponentPeer
|
friend |
◆ Desktop
|
friend |
◆ MouseInputSourceInternal
|
friend |
Member Data Documentation
◆ defaultOrientation
|
staticconstexpr |
A default value for orientation, which is used when a device doesn't support it
◆ defaultPressure
|
staticconstexpr |
A default value for pressure, which is used when a device doesn't support it, or for mouse-moves, mouse-ups, etc.
◆ defaultRotation
|
staticconstexpr |
A default value for rotation, which is used when a device doesn't support it
◆ defaultTiltX
|
staticconstexpr |
Default values for tilt, which are used when a device doesn't support it
◆ defaultTiltY
|
staticconstexpr |
◆ invalidOrientation
|
static |
A default value for orientation, which is used when a device doesn't support it.
This is a valid value, returning true when calling isOrientationValid() hence the deprecation. Use defaultOrientation instead.
◆ invalidPressure
|
static |
A default value for pressure, which is used when a device doesn't support it.
This is a valid value, returning true when calling isPressureValid() hence the deprecation. Use defaultPressure instead.
◆ invalidRotation
|
static |
A default value for rotation, which is used when a device doesn't support it.
This is a valid value, returning true when calling isRotationValid() hence the deprecation. Use defaultRotation instead.
◆ invalidTiltX
|
static |
Default values for tilt, which are used when a device doesn't support it
These are valid values, returning true when calling isTiltValid() hence the deprecation. Use defaultTiltX and defaultTiltY instead.
◆ invalidTiltY
|
static |
◆ offscreenMousePos
An offscreen mouse position used when triggering mouse exits where we don't want to move the cursor over an existing component.
◆ pimpl
|
private |
The documentation for this class was generated from the following files:
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/mouse/juce_MouseInputSource.h
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/mouse/juce_MouseInputSource.cpp
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/native/juce_linux_Windowing.cpp
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/native/juce_win32_Windowing.cpp
Generated on for LMMS by
1.16.1