Qt3DRender.QObjectPicker¶

The QObjectPicker class instantiates a component that can be used to interact with a QEntity by a process known as picking. More…

Synopsis¶

Functions¶

def containsMouse ()
def isDragEnabled ()
def isHoverEnabled ()
def isPressed ()

Slots¶

def setDragEnabled (dragEnabled)
def setHoverEnabled (hoverEnabled)

Signals¶

def clicked (pick)
def containsMouseChanged (containsMouse)
def dragEnabledChanged (dragEnabled)
def entered ()
def exited ()
def hoverEnabledChanged (hoverEnabled)
def moved (pick)
def pressed (pick)
def pressedChanged (pressed)
def released (pick)

Detailed Description¶

For every combination of viewport and camera, picking casts a ray through the scene to find entities who’s bounding volume intersects the ray. The bounding volume is computed using the values in the attribute buffer specified by the boundingVolumePositionAttribute of the geometry.

The signals pressed() , released() , clicked() , moved() , entered() , and exited() are emitted when the bounding volume defined by the pickAttribute property intersects with a ray.

Most signals carry a QPickEvent instance. If QPickingSettings::pickMode() is set to TrianglePicking , the actual type of the pick parameter will be QPickTriangleEvent .

Pick queries are performed on mouse press and mouse release. If drag is enabled, queries also happen on each mouse move while any button is pressed. If hover is enabled, queries happen on every mouse move even if no button is pressed.

For generalised ray casting queries, see QRayCaster and QScreenRayCaster .

Note

Instances of this component shouldn’t be shared, not respecting that condition will most likely result in undefined behavior.

See also

QPickingSettings QGeometry QAttribute QPickEvent QPickTriangleEvent

class PySide2.Qt3DRender.Qt3DRender.QObjectPicker([parent=None])¶

Parameters: parent – QNode

PySide2.Qt3DRender.Qt3DRender.QObjectPicker.clicked(pick)¶

Parameters: pick – QPickEvent

PySide2.Qt3DRender.Qt3DRender.QObjectPicker.containsMouse()¶

Return type: bool

Returns true if the object picker currently contains the mouse

PySide2.Qt3DRender.Qt3DRender.QObjectPicker.containsMouseChanged(containsMouse)¶

Parameters: containsMouse – bool

PySide2.Qt3DRender.Qt3DRender.QObjectPicker.dragEnabledChanged(dragEnabled)¶

Parameters: dragEnabled – bool

PySide2.Qt3DRender.Qt3DRender.QObjectPicker.entered()¶

PySide2.Qt3DRender.Qt3DRender.QObjectPicker.exited()¶

PySide2.Qt3DRender.Qt3DRender.QObjectPicker.hoverEnabledChanged(hoverEnabled)¶

Parameters: hoverEnabled – bool

PySide2.Qt3DRender.Qt3DRender.QObjectPicker.isDragEnabled()¶

Return type: bool

Returns true if dragging is enabled

PySide2.Qt3DRender.Qt3DRender.QObjectPicker.isHoverEnabled()¶

Return type: bool

Returns true if hover enabled

PySide2.Qt3DRender.Qt3DRender.QObjectPicker.isPressed()¶

Return type: bool

PySide2.Qt3DRender.Qt3DRender.QObjectPicker.moved(pick)¶

Parameters: pick – QPickEvent

PySide2.Qt3DRender.Qt3DRender.QObjectPicker.pressed(pick)¶

Parameters: pick – QPickEvent

PySide2.Qt3DRender.Qt3DRender.QObjectPicker.pressedChanged(pressed)¶

Parameters: pressed – bool

PySide2.Qt3DRender.Qt3DRender.QObjectPicker.released(pick)¶

Parameters: pick – QPickEvent

PySide2.Qt3DRender.Qt3DRender.QObjectPicker.setDragEnabled(dragEnabled)¶

Parameters: dragEnabled – bool

Sets the dragEnabled Property to dragEnabled

Qt Documentation

Table of Contents