Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QRaycaster Class Reference

#include <qraycaster_p.h>

Inheritance diagram for QRaycaster:
Collaboration diagram for QRaycaster:

Signals

void enabledChanged ()
void directionChanged ()
void maxDistanceChanged ()
void excludeParentBodyChanged ()
void includeStaticChanged ()
void includeDynamicChanged ()
void isCollidingChanged ()
void hitChanged ()
void bodyEntered (QAbstractPhysicsNode *body)
void bodyExited (QAbstractPhysicsNode *body)
Signals inherited from QQuick3DNode
void xChanged ()
void yChanged ()
void zChanged ()
void rotationChanged ()
void eulerRotationChanged ()
void positionChanged ()
void scaleChanged ()
void pivotChanged ()
void localOpacityChanged ()
void visibleChanged ()
void forwardChanged ()
void upChanged ()
void rightChanged ()
void sceneTransformChanged ()
void scenePositionChanged ()
void sceneRotationChanged ()
void sceneScaleChanged ()
void staticFlagsChanged ()
void layersChanged ()
Signals inherited from QQuick3DObject
void parentChanged ()
void childrenChanged ()
void stateChanged ()
Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.

Public Member Functions

 QRaycaster (QQuick3DNode *parent=nullptr)
 \qmltype Raycaster \inherits Node \inqmlmodule QtQuick3D.Physics
 ~QRaycaster () override
bool enabled () const
void setEnabled (bool enabled)
QVector3D direction () const
void setDirection (const QVector3D &direction)
float maxDistance () const
void setMaxDistance (float maxDistance)
bool excludeParentBody () const
void setExcludeParentBody (bool excludeParentBody)
QQmlListProperty< QAbstractPhysicsNode > excludedBodies ()
bool includeStatic () const
void setIncludeStatic (bool includeStatic)
bool includeDynamic () const
void setIncludeDynamic (bool includeDynamic)
bool isColliding () const
QQuick3DPhysicsLocationHit hit () const
Public Member Functions inherited from QQuick3DNode
 QQuick3DNode (QQuick3DNode *parent=nullptr)
 \qmltype Node \inherits Object3D \inqmlmodule QtQuick3D
 ~QQuick3DNode () override
float x () const
 \qmlproperty real QtQuick3D::Node::x
float y () const
 \qmlproperty real QtQuick3D::Node::y
float z () const
 \qmlproperty real QtQuick3D::Node::z
QQuaternion rotation () const
 \qmlproperty quaternion QtQuick3D::Node::rotation
QVector3D eulerRotation () const
 \qmlproperty vector3d QtQuick3D::Node::eulerRotation
QVector3D position () const
 \qmlproperty vector3d QtQuick3D::Node::position
QVector3D scale () const
 \qmlproperty vector3d QtQuick3D::Node::scale
QVector3D pivot () const
 \qmlproperty vector3d QtQuick3D::Node::pivot
float localOpacity () const
 \qmlproperty real QtQuick3D::Node::opacity
bool visible () const
 \qmlproperty bool QtQuick3D::Node::visible
int staticFlags () const
 \qmlproperty int QtQuick3D::Node::staticFlags
QQuick3DNode * parentNode () const
QVector3D forward () const
 \qmlproperty vector3d QtQuick3D::Node::forward \readonly
QVector3D up () const
 \qmlproperty vector3d QtQuick3D::Node::up \readonly
QVector3D right () const
 \qmlproperty vector3d QtQuick3D::Node::right \readonly
QVector3D scenePosition () const
 \qmlproperty vector3d QtQuick3D::Node::scenePosition \readonly
QQuaternion sceneRotation () const
 \qmlproperty quaternion QtQuick3D::Node::sceneRotation \readonly
QVector3D sceneScale () const
 \qmlproperty vector3d QtQuick3D::Node::sceneScale \readonly
QMatrix4x4 sceneTransform () const
 \qmlproperty matrix4x4 QtQuick3D::Node::sceneTransform \readonly
Q_INVOKABLE void rotate (qreal degrees, const QVector3D &axis, QQuick3DNode::TransformSpace space)
 \qmlmethod void QtQuick3D::Node::rotate(real degrees, vector3d axis, enumeration space)
Q_INVOKABLE QVector3D mapPositionToScene (const QVector3D &localPosition) const
 \qmlmethod vector3d QtQuick3D::Node::mapPositionToScene(vector3d localPosition)
Q_INVOKABLE QVector3D mapPositionFromScene (const QVector3D &scenePosition) const
 \qmlmethod vector3d QtQuick3D::Node::mapPositionFromScene(vector3d scenePosition)
Q_INVOKABLE QVector3D mapPositionToNode (const QQuick3DNode *node, const QVector3D &localPosition) const
 \qmlmethod vector3d QtQuick3D::Node::mapPositionToNode(QtQuick3D::Node node, vector3d localPosition)
Q_INVOKABLE QVector3D mapPositionFromNode (const QQuick3DNode *node, const QVector3D &localPosition) const
 \qmlmethod vector3d QtQuick3D::Node::mapPositionFromNode(QtQuick3D::Node node, vector3d localPosition)
Q_INVOKABLE QVector3D mapDirectionToScene (const QVector3D &localDirection) const
 \qmlmethod vector3d QtQuick3D::Node::mapDirectionToScene(vector3d localDirection)
Q_INVOKABLE QVector3D mapDirectionFromScene (const QVector3D &sceneDirection) const
 \qmlmethod vector3d QtQuick3D::Node::mapDirectionFromScene(vector3d sceneDirection)
Q_INVOKABLE QVector3D mapDirectionToNode (const QQuick3DNode *node, const QVector3D &localDirection) const
 \qmlmethod vector3d QtQuick3D::Node::mapDirectionToNode(QtQuick3D::Node node, vector3d localDirection)
Q_INVOKABLE QVector3D mapDirectionFromNode (const QQuick3DNode *node, const QVector3D &localDirection) const
 \qmlmethod vector3d QtQuick3D::Node::mapDirectionFromNode(QtQuick3D::Node node, vector3d localDirection)
void markAllDirty () override
int layers () const
 \qmlproperty int QtQuick3D::Node::layers
Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
QString objectName () const
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString > bindableObjectName ()
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
bool isQmlExposed () const noexcept
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread * thread () const
 Returns the thread in which the object lives.
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void killTimer (int id)
 Kills the timer with timer identifier, id.
void killTimer (Qt::TimerId id)
template<typename T>
T findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
T findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList & children () const
 Returns a list of child objects.
void setParent (QObject *parent)
 Makes the object a child of parent.
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
bool disconnect (const QObject *receiver, const char *member=nullptr) const
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
bool setProperty (const char *name, QVariant &&value)
QVariant property (const char *name) const
 Returns the value of the object's name property.
QList< QByteArray > dynamicPropertyNames () const
QBindingStorage * bindingStorage ()
const QBindingStorage * bindingStorage () const
QObject * parent () const
 Returns a pointer to the parent object.
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
virtual ~QQmlParserStatus ()

Properties

bool enabled
QVector3D direction
float maxDistance
bool excludeParentBody
QQmlListProperty< QAbstractPhysicsNode > excludedBodies
bool includeStatic
bool includeDynamic
bool isColliding
QQuick3DPhysicsLocationHit hit
Properties inherited from QQuick3DNode
float x
float y
float z
QQuaternion rotation
QVector3D eulerRotation
QVector3D position
QVector3D scale
QVector3D pivot
float opacity
bool visible
QVector3D forward
QVector3D up
QVector3D right
QVector3D scenePosition
QQuaternion sceneRotation
QVector3D sceneScale
QMatrix4x4 sceneTransform
int staticFlags
int layers
Properties inherited from QQuick3DObject
QQuick3DObject * parent
 \qmlproperty Object3D QtQuick3D::Object3D::parent This property holds the parent of the Object3D in a 3D scene.
Properties inherited from QObject
QString objectName
 the name of this object

Friends

class QPhysicsWorld

Additional Inherited Members

Public Types inherited from QQuick3DNode
enum  TransformSpace { LocalSpace , ParentSpace , SceneSpace }
enum  StaticFlags { None }
Public Slots inherited from QQuick3DNode
void setX (float x)
void setY (float y)
void setZ (float z)
void setRotation (const QQuaternion &rotation)
void setEulerRotation (const QVector3D &eulerRotation)
void setPosition (const QVector3D &position)
void setScale (const QVector3D &scale)
void setPivot (const QVector3D &pivot)
void setLocalOpacity (float opacity)
void setVisible (bool visible)
void setStaticFlags (int staticFlags)
void setLayers (int newLayers)
Public Slots inherited from QQuick3DObject
void update ()
void setParentItem (QQuick3DObject *parentItem)
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
static bool disconnect (const QMetaObject::Connection &)
 Disconnects connection and resets it to \l{QMetaObject::Connection::operator bool()}{invalid}.
static bool disconnect (QMetaObject::Connection &)
static bool disconnect (QMetaObject::Connection &&conn)
 Disconnect a connection.
template<typename Func1, typename Func2>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
template<typename Func1>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
Protected Member Functions inherited from QQuick3DNode
void connectNotify (const QMetaMethod &signal) override
void disconnectNotify (const QMetaMethod &signal) override
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 QQuick3DNode (QQuick3DNodePrivate &dd, QQuick3DNode *parent=nullptr)
QSSGRenderGraphObject * updateSpatialNode (QSSGRenderGraphObject *node) override
virtual void itemChange (ItemChange, const ItemChangeData &) override
Protected Member Functions inherited from QQuick3DObject
 QQuick3DObject (QQuick3DObjectPrivate &dd, QQuick3DObject *parent=nullptr)
void classBegin () override
 Invoked after class creation, but before any properties have been set.
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
bool isComponentComplete () const
virtual void preSync ()
Protected Member Functions inherited from QObject
QObject * sender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int senderSignalIndex () const
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
bool isSignalConnected (const QMetaMethod &signal) const
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 \macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 35 of file qraycaster_p.h.

Constructor & Destructor Documentation

◆ QRaycaster()

QT_BEGIN_NAMESPACE QRaycaster::QRaycaster ( QQuick3DNode * parent = nullptr)
explicit

\qmltype Raycaster \inherits Node \inqmlmodule QtQuick3D.Physics

Since
6.13

Casts a ray into the physics scene on every physics frame.

Raycaster casts a ray from its scene position in \l direction and reports the closest physics body it intersects. The \l hit property is updated once per physics frame, after the bodies have been synchronized with the scene and before \l PhysicsWorld::frameDone, so a frameDone handler reads the result of the frame it is reporting on.

\qml Raycaster { direction: Qt.vector3d(0, -1, 0) maxDistance: 50 includeDynamic: false onBodyEntered: (body) => console.log("Hit", body) } \endqml

The ray is a scene query, so it sees the same bodies as \l {PhysicsWorld::singleRaycastQuery} {PhysicsWorld.singleRaycastQuery} and is bound by the same rules: \l {PhysicsNode::filterGroup} {filterGroup} and \l {PhysicsNode::filterIgnoreGroups} {filterIgnoreGroups} have no effect on it, and a \l TriggerBody never appears in the result. Use \l includeStatic and \l includeDynamic to narrow that by kind, and \l excludeParentBody and \l excludedBodies to leave out particular bodies. Those two matter more here than for a query method, since the ray reports only its closest hit and there is nothing left to filter afterwards.

See also
PhysicsWorld, locationHit, {Qt Quick 3D Physics Scene Queries}, {Qt Quick 3D Physics - Raycaster Example}

\qmlproperty bool Raycaster::enabled

Controls whether the ray is cast on each physics frame. Disabling the ray clears \l hit and sets \l isColliding to false.

The default value is true.

\qmlproperty vector3d Raycaster::direction

The ray direction in local coordinates. It is transformed to scene coordinates and normalized before the ray is cast. A zero vector produces no hit. Non-finite values are ignored.

The default value is {Qt.vector3d(0, 0, -1)}.

\qmlproperty real Raycaster::maxDistance

The maximum distance of the ray in scene units. A value of zero produces no hit. Negative and non-finite values are ignored.

The default value is 100.

\qmlproperty bool Raycaster::excludeParentBody

When true, every \l PhysicsNode ancestor of the ray is excluded from the query, not only the nearest one. A ray mounted on a body starts inside that body's own shapes, and a raycast does report the shape it starts inside, so without this the ray reports the body carrying it at a distance of zero and never sees anything beyond.

The default value is true.

See also
excludedBodies

\qmlproperty list<PhysicsNode> Raycaster::excludedBodies

Bodies the ray never reports, whether or not they are ancestors of it. Use this for a body the ray has to ignore but is not mounted on, such as the character carrying the weapon a ray is fired from, where the two are siblings rather than one inside the other.

Because the ray reports only its closest hit, there is no way to filter its result afterwards the way the \l PhysicsWorld query methods allow, so anything that has to be left out has to be named here or covered by \l excludeParentBody.

The list is empty by default. A body destroyed after it was added stops being excluded and reads back as null, rather than being removed from the list.

See also
excludeParentBody

\qmlproperty bool Raycaster::includeStatic

Whether static physics bodies are included in the query.

The default value is true.

\qmlproperty bool Raycaster::includeDynamic

Whether dynamic physics bodies are included in the query.

The default value is true.

When both \l includeStatic and includeDynamic are false, the ray produces no hit.

\qmlproperty bool Raycaster::isColliding \readonly

Whether the ray currently intersects a physics body.

\qmlproperty locationHit Raycaster::hit \readonly

The closest intersection reported by the ray. The value contains the intersected body and collision shape, along with the scene-space position and normal and the distance from the ray origin. It is a default-constructed \l locationHit when \l isColliding is false.

\qmlsignal Raycaster::bodyEntered(PhysicsNode body)

Emitted when the ray starts intersecting body. When the intersected body changes, \l bodyExited is emitted for the old body before this signal is emitted for the new body.

\qmlsignal Raycaster::bodyExited(PhysicsNode body)

Emitted when the ray stops intersecting body.

Definition at line 151 of file qraycaster.cpp.

◆ ~QRaycaster()

QRaycaster::~QRaycaster ( )
override

Definition at line 156 of file qraycaster.cpp.

Member Function Documentation

◆ bodyEntered

void QRaycaster::bodyEntered ( QAbstractPhysicsNode * body)
signal

◆ bodyExited

void QRaycaster::bodyExited ( QAbstractPhysicsNode * body)
signal

◆ direction()

QVector3D QRaycaster::direction ( ) const

Definition at line 176 of file qraycaster.cpp.

◆ directionChanged

void QRaycaster::directionChanged ( )
signal

◆ enabled()

bool QRaycaster::enabled ( ) const

Definition at line 161 of file qraycaster.cpp.

◆ enabledChanged

void QRaycaster::enabledChanged ( )
signal

◆ excludedBodies()

QQmlListProperty< QAbstractPhysicsNode > QRaycaster::excludedBodies ( )

◆ excludeParentBody()

bool QRaycaster::excludeParentBody ( ) const

Definition at line 214 of file qraycaster.cpp.

◆ excludeParentBodyChanged

void QRaycaster::excludeParentBodyChanged ( )
signal

◆ hit()

QQuick3DPhysicsLocationHit QRaycaster::hit ( ) const

Definition at line 262 of file qraycaster.cpp.

◆ hitChanged

void QRaycaster::hitChanged ( )
signal

◆ includeDynamic()

bool QRaycaster::includeDynamic ( ) const

Definition at line 242 of file qraycaster.cpp.

◆ includeDynamicChanged

void QRaycaster::includeDynamicChanged ( )
signal

◆ includeStatic()

bool QRaycaster::includeStatic ( ) const

Definition at line 227 of file qraycaster.cpp.

◆ includeStaticChanged

void QRaycaster::includeStaticChanged ( )
signal

◆ isColliding()

bool QRaycaster::isColliding ( ) const

Definition at line 257 of file qraycaster.cpp.

◆ isCollidingChanged

void QRaycaster::isCollidingChanged ( )
signal

◆ maxDistance()

float QRaycaster::maxDistance ( ) const

Definition at line 195 of file qraycaster.cpp.

◆ maxDistanceChanged

void QRaycaster::maxDistanceChanged ( )
signal

◆ setDirection()

void QRaycaster::setDirection ( const QVector3D & direction)

Definition at line 181 of file qraycaster.cpp.

◆ setEnabled()

void QRaycaster::setEnabled ( bool enabled)

Definition at line 166 of file qraycaster.cpp.

◆ setExcludeParentBody()

void QRaycaster::setExcludeParentBody ( bool excludeParentBody)

Definition at line 219 of file qraycaster.cpp.

◆ setIncludeDynamic()

void QRaycaster::setIncludeDynamic ( bool includeDynamic)

Definition at line 247 of file qraycaster.cpp.

◆ setIncludeStatic()

void QRaycaster::setIncludeStatic ( bool includeStatic)

Definition at line 232 of file qraycaster.cpp.

◆ setMaxDistance()

void QRaycaster::setMaxDistance ( float maxDistance)

Definition at line 200 of file qraycaster.cpp.

◆ QPhysicsWorld

friend class QPhysicsWorld
friend

Definition at line 115 of file qraycaster_p.h.

Property Documentation

◆ direction

QVector3D QRaycaster::direction
readwrite

Definition at line 39 of file qraycaster_p.h.

◆ enabled

bool QRaycaster::enabled
readwrite

Definition at line 38 of file qraycaster_p.h.

◆ excludedBodies

QQmlListProperty< QAbstractPhysicsNode > QRaycaster::excludedBodies
read

Definition at line 42 of file qraycaster_p.h.

◆ excludeParentBody

bool QRaycaster::excludeParentBody
readwrite

Definition at line 41 of file qraycaster_p.h.

◆ hit

QQuick3DPhysicsLocationHit QRaycaster::hit
read

Definition at line 46 of file qraycaster_p.h.

◆ includeDynamic

bool QRaycaster::includeDynamic
readwrite

Definition at line 44 of file qraycaster_p.h.

◆ includeStatic

bool QRaycaster::includeStatic
readwrite

Definition at line 43 of file qraycaster_p.h.

◆ isColliding

bool QRaycaster::isColliding
read

Definition at line 45 of file qraycaster_p.h.

◆ maxDistance

float QRaycaster::maxDistance
readwrite

Definition at line 40 of file qraycaster_p.h.

The documentation for this class was generated from the following files: