QMouseHandler#

Provides a means of being notified about mouse events when attached to a QMouseDevice instance. More…

Synopsis#

Functions#

def containsMouse ()
def setContainsMouse (contains)
def sourceDevice ()

Slots#

def setSourceDevice (mouseDevice)

Signals#

def clicked (mouse)
def containsMouseChanged (containsMouse)
def doubleClicked (mouse)
def entered ()
def exited ()
def positionChanged (mouse)
def pressAndHold (mouse)
def pressed (mouse)
def released (mouse)
def sourceDeviceChanged (mouseDevice)
def wheel (wheel)

Detailed Description#

Note

QMouseHandler components shouldn’t be shared, not respecting that condition will most likely result in undefined behaviors.

See also

QMouseDevice QMouseEvent

class PySide6.Qt3DInput.Qt3DInput.QMouseHandler([parent=None])#

Parameters: parent – PySide6.Qt3DCore.Qt3DCore.QNode

Constructs a new QMouseHandler instance with parent parent.

PySide6.Qt3DInput.Qt3DInput.QMouseHandler.clicked(mouse)#

Parameters: mouse – PySide6.Qt3DInput.Qt3DInput.QMouseEvent

This signal is emitted when a mouse button is clicked with the event details being contained within mouse.

PySide6.Qt3DInput.Qt3DInput.QMouseHandler.containsMouse()#

Return type: bool

Holds true if the QMouseHandler currently contains the mouse.

Note

In this context, contains mean that the ray originating from the mouse is intersecting with the QEntity that aggregates the current QMouseHandler instance component.

PySide6.Qt3DInput.Qt3DInput.QMouseHandler.containsMouseChanged(containsMouse)#

Parameters: containsMouse – bool

PySide6.Qt3DInput.Qt3DInput.QMouseHandler.doubleClicked(mouse)#

Parameters: mouse – PySide6.Qt3DInput.Qt3DInput.QMouseEvent

This signal is emitted when a mouse button is double clicked with the event details being contained within mouse.

PySide6.Qt3DInput.Qt3DInput.QMouseHandler.entered()#

PySide6.Qt3DInput.Qt3DInput.QMouseHandler.exited()#

PySide6.Qt3DInput.Qt3DInput.QMouseHandler.positionChanged(mouse)#

Parameters: mouse – PySide6.Qt3DInput.Qt3DInput.QMouseEvent

This signal is emitted when the mouse position changes with the event details being contained within mouse

PySide6.Qt3DInput.Qt3DInput.QMouseHandler.pressAndHold(mouse)#

Parameters: mouse – PySide6.Qt3DInput.Qt3DInput.QMouseEvent

This signal is emitted when a mouse button is pressed and held down with the event details being contained within mouse

PySide6.Qt3DInput.Qt3DInput.QMouseHandler.pressed(mouse)#

Parameters: mouse – PySide6.Qt3DInput.Qt3DInput.QMouseEvent

This signal is emitted when a mouse button is pressed with the event details being contained within mouse

PySide6.Qt3DInput.Qt3DInput.QMouseHandler.released(mouse)#

Parameters: mouse – PySide6.Qt3DInput.Qt3DInput.QMouseEvent

This signal is emitted when a mouse button is released with the event details being contained within mouse

PySide6.Qt3DInput.Qt3DInput.QMouseHandler.setContainsMouse(contains)#

Parameters: contains – bool

PySide6.Qt3DInput.Qt3DInput.QMouseHandler.setSourceDevice(mouseDevice)#

Parameters: mouseDevice – PySide6.Qt3DInput.Qt3DInput.QMouseDevice

Holds the current mouse source device of the QMouseHandler instance.

PySide6.Qt3DInput.Qt3DInput.QMouseHandler.sourceDevice()#

Return type: PySide6.Qt3DInput.Qt3DInput.QMouseDevice

Holds the current mouse source device of the QMouseHandler instance.

PySide6.Qt3DInput.Qt3DInput.QMouseHandler.sourceDeviceChanged(mouseDevice)#

Parameters: mouseDevice – PySide6.Qt3DInput.Qt3DInput.QMouseDevice

PySide6.Qt3DInput.Qt3DInput.QMouseHandler.wheel(wheel)#

Parameters: wheel – PySide6.Qt3DInput.Qt3DInput.QWheelEvent

This signal is emitted when the mouse wheel is used with the event details being contained within wheel