QObjectPicker¶

PyQt5.Qt3DRender.QObjectPicker: Inherits from QComponent.

Description¶

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

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.

Methods¶

__init__(parent: QNode = None): TODO

containsMouse() → bool: Returns true if the object picker currently contains the mouse

isDragEnabled() → bool: Returns true if dragging is enabled

isHoverEnabled() → bool: Returns true if hover enabled

isPressed() → bool: TODO

priority() → int: TODO

sceneChangeEvent(QSceneChange): TODO

setDragEnabled(bool): Sets the dragEnabled Property to dragEnabled

See also

isDragEnabled().

setHoverEnabled(bool): Sets the hoverEnabled Property to hoverEnabled

See also

isHoverEnabled().

setPriority(int): TODO

Signals¶

clicked(QPickEvent): TODO

containsMouseChanged(bool): TODO

dragEnabledChanged(bool): TODO

entered(): TODO

exited(): TODO

hoverEnabledChanged(bool): TODO

moved(QPickEvent): TODO

pressed(QPickEvent): TODO

pressedChanged(bool): TODO

priorityChanged(int): TODO

released(QPickEvent): TODO