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
QQuick3DCamera Class Reference

#include <qquick3dcamera_p.h>

Inheritance diagram for QQuick3DCamera:
Collaboration diagram for QQuick3DCamera:

Public Slots

void setFrustumCullingEnabled (bool frustumCullingEnabled)
void setLookAtNode (QQuick3DNode *node)
 Q_REVISION (6, 5) void setLevelOfDetailBias(float new LevelOFDetailBias)
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

Signals

void frustumCullingEnabledChanged ()
 Q_REVISION (6, 4) void lookAtNodeChanged()
 Q_REVISION (6, 5) void levelOfDetailBiasChanged()
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

Q_INVOKABLE QVector3D mapToViewport (const QVector3D &scenePos) const
 \qmlmethod vector3d Camera::mapToViewport(vector3d scenePos)
Q_INVOKABLE QVector3D mapFromViewport (const QVector3D &viewportPos) const
 \qmlmethod vector3d Camera::mapFromViewport(vector3d viewportPos)
QVector3D mapToViewport (const QVector3D &scenePos, qreal width, qreal height)
QVector3D mapFromViewport (const QVector3D &viewportPos, qreal width, qreal height)
Q_INVOKABLE void lookAt (const QVector3D &scenePos)
 \qmlmethod vector3d Camera::lookAt(vector3d scenePos)
Q_INVOKABLE void lookAt (QQuick3DNode *node)
 \qmlmethod vector3d Camera::lookAt(QtQuick3D::Node node)
void updateGlobalVariables (const QRectF &inViewport)
bool frustumCullingEnabled () const
 \qmlproperty bool Camera::frustumCullingEnabled
QQuick3DNodelookAtNode () const
 \qmlproperty Node Camera::lookAtNode
 Q_REVISION (6, 5) float levelOfDetailBias() 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
QQuick3DNodeparentNode () 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 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< QStringbindableObjectName ()
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 isQmlObjectType () const
 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).
QThreadthread () 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>
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>
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
QBindingStoragebindingStorage ()
const QBindingStoragebindingStorage () const
QObjectparent () 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 ()

Protected Member Functions

 QQuick3DCamera (QQuick3DNodePrivate &dd, QQuick3DNode *parent=nullptr)
 \qmltype Camera \inherits Node \inqmlmodule QtQuick3D
QSSGRenderGraphObjectupdateSpatialNode (QSSGRenderGraphObject *node) override
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)
QSSGRenderGraphObjectupdateSpatialNode (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
QObjectsender () 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)

Properties

bool frustumCullingEnabled
QQuick3DNodelookAtNode
float levelOfDetailBias
 \qmlproperty real Camera::levelOfDetailBias
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
QQuick3DObjectparent
 \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

Additional Inherited Members

Public Types inherited from QQuick3DNode
enum  TransformSpace { LocalSpace , ParentSpace , SceneSpace }
enum  StaticFlags { None }
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 &)
 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 Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr

Detailed Description

Definition at line 23 of file qquick3dcamera_p.h.

Constructor & Destructor Documentation

◆ QQuick3DCamera()

QT_BEGIN_NAMESPACE QQuick3DCamera::QQuick3DCamera ( QQuick3DNodePrivate & dd,
QQuick3DNode * parent = nullptr )
explicitprotected

\qmltype Camera \inherits Node \inqmlmodule QtQuick3D

Defines an abstract base for Cameras.

A Camera defines how the content of the 3D scene is projected onto a 2D surface, such as a View3D. A scene needs at least one Camera in order to visualize its contents.

It is possible to position and rotate the Camera like any other spatial \l{QtQuick3D::Node}{Node} in the scene. The \l{QtQuick3D::Node}{Node}'s location and orientation determines where the Camera is in the scene, and what direction it is facing. The default orientation of the camera has its forward vector pointing along the negative Z axis and its up vector along the positive Y axis.

Together with the position and orientation, the frustum defines which parts of a scene are visible to the Camera and how they are projected onto the 2D surface. The different Camera subtypes provide multiple options to determine the shape of the Camera's frustum.

\list

  • PerspectiveCamera provides a camera with a pyramid-shaped frustum, where objects are projected so that those further away from the camera appear to be smaller. This is the most commonly used camera type, and corresponds to how most real world cameras work.
  • OrthographicCamera provides a camera where the lines of the frustum are parallel, making the perceived scale of an object unaffected by its distance to the camera. Typical use cases for this type of camera are CAD (Computer-Assisted Design) applications and cartography.
  • FrustumCamera is a perspective camera type where the frustum can be freely customized by the coordinates of its intersection with the near plane. It can be useful if an asymmetrical camera frustum is needed.
  • CustomCamera is a camera type where the projection matrix can be freely customized, and can be useful for advanced users who wish to calculate their own projection matrix. \endlist

To illustrate the difference, these screenshots show the same scene as projected by a PerspectiveCamera and an OrthographicCamera. Notice how the red box is smaller than the green box in the image rendered using the perspective projection. \table \header

  • Perspective camera
  • Orthographic camera \row
  • \endtable
See also
{Qt Quick 3D - View3D Example}

Definition at line 72 of file qquick3dcamera.cpp.

Member Function Documentation

◆ frustumCullingEnabled()

bool QQuick3DCamera::frustumCullingEnabled ( ) const

\qmlproperty bool Camera::frustumCullingEnabled

When this property is true, objects outside the camera frustum will be culled, meaning they will not be passed to the renderer. By default this property is set to false. For scenes where all or most objects are inside the camera frustum, frustum culling is an unnecessary performance overhead. But for complex scenes where large parts are located outside the camera's view, enabling frustum culling may improve performance.

Definition at line 84 of file qquick3dcamera.cpp.

◆ frustumCullingEnabledChanged

void QQuick3DCamera::frustumCullingEnabledChanged ( )
signal

◆ lookAt() [1/2]

void QQuick3DCamera::lookAt ( const QVector3D & scenePos)

\qmlmethod vector3d Camera::lookAt(vector3d scenePos)

Since
5.15

Sets the rotation value of the Camera so that it is pointing at scenePos.

Definition at line 297 of file qquick3dcamera.cpp.

◆ lookAt() [2/2]

void QQuick3DCamera::lookAt ( QQuick3DNode * node)

\qmlmethod vector3d Camera::lookAt(QtQuick3D::Node node)

Since
5.15

Sets the rotation value of the Camera so that it is pointing at node.

Definition at line 323 of file qquick3dcamera.cpp.

◆ lookAtNode()

QQuick3DNode * QQuick3DCamera::lookAtNode ( ) const

\qmlproperty Node Camera::lookAtNode

If this property is set to a non-null value, the rotation of this camera is automatically updated so that this camera keeps looking at the specified node whenever the scene position of this camera or the specified node changes. By default this property is set to {null}.

See also
lookAt

Definition at line 109 of file qquick3dcamera.cpp.

◆ mapFromViewport() [1/2]

QVector3D QQuick3DCamera::mapFromViewport ( const QVector3D & viewportPos) const

\qmlmethod vector3d Camera::mapFromViewport(vector3d viewportPos)

Transforms viewportPos from viewport space (2D) into global scene space (3D).

The x- and y-values of viewportPos must be normalized, with the top-left of the viewport at [0, 0] and the bottom-right at [1, 1]. The z-value is interpreted as the distance from the near clip plane of the frustum (clipNear).

If viewportPos cannot successfully be mapped to a position in the scene, a position of [0, 0, 0] is returned.

See also
mapToViewport, {View3D::mapTo3DScene()}{View3D.mapTo3DScene()}

Definition at line 213 of file qquick3dcamera.cpp.

◆ mapFromViewport() [2/2]

QVector3D QQuick3DCamera::mapFromViewport ( const QVector3D & viewportPos,
qreal width,
qreal height )

Definition at line 276 of file qquick3dcamera.cpp.

◆ mapToViewport() [1/2]

QVector3D QQuick3DCamera::mapToViewport ( const QVector3D & scenePos) const

\qmlmethod vector3d Camera::mapToViewport(vector3d scenePos)

Transforms scenePos from global scene space (3D) into viewport space (2D).

The returned position is normalized, with the top-left of the viewport at [0, 0] and the bottom-right at [1, 1]. The returned z-value will contain the distance from the near clip plane of the frustum (clipNear) to scenePos in scene coordinates. If the distance is negative, the point is behind camera.

If scenePos cannot successfully be mapped to a position in the viewport, a position of [0, 0, 0] is returned.

See also
mapFromViewport(), {View3D::mapFrom3DScene()}{View3D.mapFrom3DScene()}

Definition at line 150 of file qquick3dcamera.cpp.

◆ mapToViewport() [2/2]

QVector3D QQuick3DCamera::mapToViewport ( const QVector3D & scenePos,
qreal width,
qreal height )

Definition at line 259 of file qquick3dcamera.cpp.

◆ Q_REVISION [1/4]

QQuick3DCamera::Q_REVISION ( 6 ,
4  )
signal

◆ Q_REVISION() [2/4]

QQuick3DCamera::Q_REVISION ( 6 ,
5  ) const

◆ Q_REVISION [3/4]

QQuick3DCamera::Q_REVISION ( 6 ,
5  )
signal

◆ Q_REVISION [4/4]

QQuick3DCamera::Q_REVISION ( 6 ,
5  )
newslot

◆ setFrustumCullingEnabled

void QQuick3DCamera::setFrustumCullingEnabled ( bool frustumCullingEnabled)
slot

Definition at line 89 of file qquick3dcamera.cpp.

◆ setLookAtNode

void QQuick3DCamera::setLookAtNode ( QQuick3DNode * node)
slot

Definition at line 114 of file qquick3dcamera.cpp.

◆ updateGlobalVariables()

void QQuick3DCamera::updateGlobalVariables ( const QRectF & inViewport)

Definition at line 330 of file qquick3dcamera.cpp.

◆ updateSpatialNode()

QSSGRenderGraphObject * QQuick3DCamera::updateSpatialNode ( QSSGRenderGraphObject * node)
overrideprotectedvirtual

Property Documentation

◆ frustumCullingEnabled

bool QQuick3DCamera::frustumCullingEnabled
readwrite

Definition at line 26 of file qquick3dcamera_p.h.

◆ levelOfDetailBias

float QQuick3DCamera::levelOfDetailBias
readwrite

\qmlproperty real Camera::levelOfDetailBias

Since
6.5

This property changes the size a model needs to be when rendered before the automatic level of detail meshes are used. Each generated level of detail mesh contains an ideal size value that each level should be shown, which is a ratio of how much of the rendered scene will be that mesh. A model that represents only a few pixels on screen will not require the full geometry to look correct, so a lower level of detail mesh will be used instead in this case. This value is a bias to the ideal value such that a value smaller than 1.0 will require an even smaller rendered size before switching to a lesser level of detail. Values above 1.0 will lead to lower levels of detail being used sooner. A value of 0.0 will disable the usage of levels of detail completely.

The default value is 1.0

Note
This property will only have an effect on Models with geomtry containing levels of detail.
See also
Model::levelOfDetailBias

Definition at line 28 of file qquick3dcamera_p.h.

◆ lookAtNode

QQuick3DNode * QQuick3DCamera::lookAtNode
readwrite

Definition at line 27 of file qquick3dcamera_p.h.


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