juce_MouseEvent.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  MouseEvent  final
{
public:
    //==============================================================================
    MouseEvent (MouseInputSource source,
                Point<float> position,
                ModifierKeys modifiers,
                float pressure,
                float orientation, float rotation,
                float tiltX, float tiltY,
                Component* eventComponent,
                Component* originator,
                Time eventTime,
                Point<float> mouseDownPos,
                Time mouseDownTime,
                int numberOfClicks,
                bool mouseWasDragged) noexcept;
 
    MouseEvent (const MouseEvent&) = default;
    MouseEvent& operator= (const MouseEvent&) = delete;
 
    MouseEvent (MouseEvent&&) = default;
    MouseEvent& operator= (MouseEvent&&) = delete;
 
    //==============================================================================
    const Point<float> position;

    const int x;

    const int y;

    const ModifierKeys mods;

    const float pressure;

    const float orientation;

    const float rotation;

    const float tiltX;

    const float tiltY;

    const Point<float> mouseDownPosition;

    Component* const eventComponent;

    Component* const originalComponent;

    const Time eventTime;

    const Time mouseDownTime;

    MouseInputSource source;
 
    //==============================================================================
    int getMouseDownX() const noexcept;

    int getMouseDownY() const noexcept;

    Point<int> getMouseDownPosition() const noexcept;

    int getDistanceFromDragStart() const noexcept;

    int getDistanceFromDragStartX() const noexcept;

    int getDistanceFromDragStartY() const noexcept;

    Point<int> getOffsetFromDragStart() const noexcept;

    bool mouseWasDraggedSinceMouseDown() const noexcept;

    bool mouseWasClicked() const noexcept;

    int getNumberOfClicks() const noexcept                              { return numberOfClicks; }

    int getLengthOfMousePress() const noexcept;

    bool isPressureValid() const noexcept;

    bool isOrientationValid() const noexcept;

    bool isRotationValid() const noexcept;

    bool isTiltValid (bool tiltX) const noexcept;
 
    //==============================================================================
    Point<int> getPosition() const noexcept;

    int getScreenX() const;

    int getScreenY() const;

    Point<int> getScreenPosition() const;

    int getMouseDownScreenX() const;

    int getMouseDownScreenY() const;

    Point<int> getMouseDownScreenPosition() const;
 
    //==============================================================================
    MouseEvent getEventRelativeTo (Component* newComponent) const noexcept;

    MouseEvent withNewPosition (Point<float> newPosition) const noexcept;

    MouseEvent withNewPosition (Point<int> newPosition) const noexcept;
 
    //==============================================================================
    static void setDoubleClickTimeout (int timeOutMilliseconds) noexcept;

    static int getDoubleClickTimeout() noexcept;
 
 
private:
    //==============================================================================
    const uint8 numberOfClicks, wasMovedSinceMouseDown;
};
 
 
//==============================================================================
struct MouseWheelDetails  final
{
    //==============================================================================
    float deltaX;

    float deltaY;

    bool isReversed;

    bool isSmooth;

    bool isInertial;
};
 
//==============================================================================
struct PenDetails  final
{
    float rotation;

    float tiltX;

    float tiltY;
};
 
} // namespace juce