juce_MouseInputSource.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  MouseInputSource  final
{
public:
    enum InputSourceType
    {
        mouse,
        touch,
        pen
    };
 
    //==============================================================================
    MouseInputSource (const MouseInputSource&) noexcept;
    MouseInputSource& operator= (const MouseInputSource&) noexcept;
    ~MouseInputSource() noexcept;
 
    //==============================================================================
    bool operator== (const MouseInputSource& other) const noexcept     { return pimpl == other.pimpl; }
    bool operator!= (const MouseInputSource& other) const noexcept     { return pimpl != other.pimpl; }
 
    //==============================================================================
    MouseInputSource::InputSourceType getType() const noexcept;

    bool isMouse() const noexcept;

    bool isTouch() const noexcept;

    bool isPen() const noexcept;

    bool canHover() const noexcept;

    bool hasMouseWheel() const noexcept;

    int getIndex() const noexcept;

    bool isDragging() const noexcept;

    Point<float> getScreenPosition() const noexcept;

    Point<float> getRawScreenPosition() const noexcept;

    ModifierKeys getCurrentModifiers() const noexcept;

    float getCurrentPressure() const noexcept;

    float getCurrentOrientation() const noexcept;

    float getCurrentRotation() const noexcept;

    float getCurrentTilt (bool tiltX) const noexcept;

    bool isPressureValid() const noexcept;

    bool isOrientationValid() const noexcept;

    bool isRotationValid() const noexcept;

    bool isTiltValid (bool tiltX) const noexcept;

    Component* getComponentUnderMouse() const;

    void triggerFakeMove() const;

    int getNumberOfMultipleClicks() const noexcept;

    Time getLastMouseDownTime() const noexcept;

    Point<float> getLastMouseDownPosition() const noexcept;

    bool isLongPressOrDrag() const noexcept;

    bool hasMovedSignificantlySincePressed() const noexcept;

    bool hasMouseCursor() const noexcept;

    void showMouseCursor (const MouseCursor& cursor);

    void hideCursor();

    void revealCursor();

    void forceMouseCursorUpdate();

    bool canDoUnboundedMovement() const noexcept;

    void enableUnboundedMouseMovement (bool isEnabled, bool keepCursorVisibleUntilOffscreen = false) const;

    bool isUnboundedMouseMovementEnabled() const;

    void setScreenPosition (Point<float> newPosition);

    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;

    [[deprecated ("Use defaultPressure instead.")]]
    static const float invalidPressure;

    [[deprecated ("Use defaultOrientation instead.")]]
    static const float invalidOrientation;

    [[deprecated ("Use defaultRotation instead.")]]
    static const float invalidRotation;

    [[deprecated ("Use defaultTiltX instead.")]]
    static const float invalidTiltX;
    [[deprecated ("Use defaultTiltY instead.")]]
    static const float invalidTiltY;

    static const Point<float> offscreenMousePos;
 
    //==============================================================================
   #ifndef DOXYGEN
    [[deprecated ("This method has been replaced with the isLongPressOrDrag and hasMovedSignificantlySincePressed "
                 "methods. If you want the same behaviour you should use isLongPressOrDrag which accounts for the "
                 "amount of time that the input source has been held down for, but if you only want to know whether "
                 "it has been moved use hasMovedSignificantlySincePressed instead.")]]
    bool hasMouseMovedSignificantlySincePressed() const noexcept;
   #endif
 
private:
    //==============================================================================
    friend class ComponentPeer;
    friend class Desktop;
    friend class MouseInputSourceInternal;
    MouseInputSourceInternal* pimpl;
 
    struct SourceList;
 
    explicit 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 Point<float> getCurrentRawMousePosition();
    static void setRawMousePosition (Point<float>);
 
    JUCE_LEAK_DETECTOR (MouseInputSource)
};
 
} // namespace juce