\qmltype Object3D \inqmlmodule QtQuick3D \nativetype QQuick3DObject \inherits QtObject More...

#include <qquick3dobject.h>

Inheritance diagram for QQuick3DObject:

Collaboration diagram for QQuick3DObject:

Public Slots
void	update ()
void	setParentItem (QQuick3DObject *parentItem)
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
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.

Protected Member Functions
virtual QSSGRenderGraphObject *	updateSpatialNode (QSSGRenderGraphObject *node)
virtual void	markAllDirty ()
virtual void	itemChange (ItemChange, const ItemChangeData &)
	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.
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	disconnectNotify (const QMetaMethod &signal)
	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Properties
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

Private Member Functions
	~QQuick3DObject () override

Additional Inherited Members
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	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).
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 ()
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< QObjectData >	d_ptr
Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

\qmltype Object3D \inqmlmodule QtQuick3D \nativetype QQuick3DObject \inherits QtObject

Abstract base type of all 3D nodes and resources.

Object3D is the base class for all Qt Quick 3D types. This includes:

\list

Spatial types that represent objects in the 3D scene, these will normally have a position and/or a direction. For example, \l Model, \l Camera, or \l Light. Such types inherit from \l Node, which in turn inherits from Object3D.

Resource types that do not themselves represent an object in the 3D world, but rather serve as components to \l Node subclasses, providing data of some kind. This includes, among others, \l Material, \l Geometry, and \l Texture.

\endlist

In addition to the above types, Object3D can also serve as the parent for \l{Item}{Qt Quick items}, as well as arbitrary QObject instances. For more information on adding 2D items to the 3D scene, refer to \l{Qt Quick 3D Scenes with 2D Content}.

See also: Node

\inmodule QtQuick3D

Since: 5.15

Base class of all 3D nodes and resources.

Object3D is the base class for all Qt Quick 3D scene objects. Currently the types available in C++ are:

\list

QQuick3DGeometry
QQuick3DTextureData \endlist

Both of these types are resource objects which directly inherit QQuick3DObject.

It should not be necessary to use QQuick3DObject directly anywhere currently because it is just an interface for supporting spatial items and resources in a 3D scene, as well as exposing similar functionality as QQuickItem for 3D scene content.

Definition at line 21 of file qquick3dobject.h.

Constructor & Destructor Documentation

◆ QQuick3DObject()

QQuick3DObject::QQuick3DObject	(	QQuick3DObjectPrivate &	dd,
		QQuick3DObject *	parent = nullptr )

explicitprotected

Definition at line 226 of file qquick3dobject.cpp.

Member Function Documentation

◆ ~QQuick3DObject()

QQuick3DObject::~QQuick3DObject ( )

overrideprivate

Definition at line 80 of file qquick3dobject.cpp.

◆ childrenChanged

void QQuick3DObject::childrenChanged ( )

signal

◆ classBegin()

void QQuick3DObject::classBegin ( )

overrideprotectedvirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 233 of file qquick3dobject.cpp.

◆ componentComplete()

void QQuick3DObject::componentComplete ( )

overrideprotectedvirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Reimplemented in QQuick3DParticle, QQuick3DParticleAffector, QQuick3DParticleEmitter, QQuick3DParticleModelBlendParticle, QQuick3DParticleModelParticle, QQuick3DParticleSpriteParticle, QQuick3DParticleSystem, QQuick3DRepeater, QQuick3DRuntimeLoader, QQuick3DXrHandModel, and QQuick3DXrItem.

Definition at line 241 of file qquick3dobject.cpp.

◆ isComponentComplete()

bool QQuick3DObject::isComponentComplete ( ) const

protected

Definition at line 254 of file qquick3dobject.cpp.

◆ itemChange()

void QQuick3DObject::itemChange	(	ItemChange	,
		const ItemChangeData &	)

protectedvirtual

Reimplemented in QQuick3DCustomMaterial, QQuick3DDefaultMaterial, QQuick3DMaterial, QQuick3DModel, QQuick3DNode, QQuick3DParticleModelBlendParticle, QQuick3DParticleModelParticle, QQuick3DParticleSpriteParticle, QQuick3DPrincipledMaterial, QQuick3DReflectionProbe, QQuick3DRepeater, QQuick3DResourceLoader, QQuick3DSceneEnvironment, QQuick3DSpecularGlossyMaterial, QQuick3DTexture, and QQuick3DXrCamera.

Definition at line 222 of file qquick3dobject.cpp.

◆ markAllDirty()

void QQuick3DObject::markAllDirty ( )

protectedvirtual

Reimplemented in QQuick3DAbstractLight, QQuick3DCustomMaterial, QQuick3DDefaultMaterial, QQuick3DGeometry, QQuick3DItem2D, QQuick3DJoint, QQuick3DModel, QQuick3DMorphTarget, QQuick3DNode, QQuick3DPrincipledMaterial, QQuick3DReflectionProbe, QQuick3DRenderOutputProvider, QQuick3DResourceLoader, QQuick3DSpecularGlossyMaterial, QQuick3DTexture, and QQuick3DTextureData.

Definition at line 218 of file qquick3dobject.cpp.

◆ parentChanged

void QQuick3DObject::parentChanged ( )

signal

◆ preSync()

void QQuick3DObject::preSync ( )

protectedvirtual

Reimplemented in QQuick3DItem2D.

Definition at line 260 of file qquick3dobject.cpp.

◆ setParentItem

void QQuick3DObject::setParentItem ( QQuick3DObject * parentItem )

slot

Definition at line 135 of file qquick3dobject.cpp.

◆ stateChanged

void QQuick3DObject::stateChanged ( )

signal

◆ update

void QQuick3DObject::update ( )

slot

Definition at line 102 of file qquick3dobject.cpp.

◆ updateSpatialNode()

QSSGRenderGraphObject * QQuick3DObject::updateSpatialNode ( QSSGRenderGraphObject * node )

protectedvirtual

Reimplemented in QQuick3DAbstractLight, QQuick3DAudioListener, QQuick3DCamera, QQuick3DCustomCamera, QQuick3DCustomMaterial, QQuick3DDefaultMaterial, QQuick3DDirectionalLight, QQuick3DEffect, QQuick3DFrustumCamera, QQuick3DGeometry, QQuick3DInstanceListEntry, QQuick3DInstanceRange, QQuick3DInstancing, QQuick3DItem2D, QQuick3DJoint, QQuick3DMaterial, QQuick3DModel, QQuick3DMorphTarget, QQuick3DNode, QQuick3DOrthographicCamera, QQuick3DParticle, QQuick3DParticleModelBlendParticle, QQuick3DParticleSpriteParticle::ParticleUpdateNode, QQuick3DPerspectiveCamera, QQuick3DPointLight, QQuick3DPrincipledMaterial, QQuick3DReflectionProbe, QQuick3DRenderExtension, QQuick3DRenderOutputProvider, QQuick3DResourceLoader, QQuick3DRuntimeLoader, QQuick3DSceneEnvironment, QQuick3DSkeleton, QQuick3DSkin, QQuick3DSpatialSound, QQuick3DSpecularGlossyMaterial, QQuick3DSpotLight, QQuick3DTexture, QQuick3DTextureData, QQuick3DTextureProviderExtension, QQuick3DXrEyeCamera, and SceneEffectEnvironment.

Definition at line 212 of file qquick3dobject.cpp.

Property Documentation

◆ parent

QQuick3DObject * QQuick3DObject::parent

readwrite

\qmlproperty Object3D QtQuick3D::Object3D::parent This property holds the parent of the Object3D in a 3D scene.

Note: An Object3D's parent may not necessarily be the same as its object parent. This is necessary because the object parent may be an item that is not of type Object3D, for example the root object in a scene.

This property holds the parent of the Object3D in a 3D scene.

Note: An Object3D's parent may not necessarily be the same as its object parent. This is necessary because the object parent may be an item that is not of type Object3D, for example the root object in a scene.; Currently for 3D items to be correctly handled by the scene manager when parenting 3D objects from C++ it is necessary to call QQuick3DObject::setParentItem before the QObject::setParent. This requirement is likely to change in a future release though.
QQuick3DObject *newItem = new QQuick3DObject();

newItem->setParentItem(parentItem);

newItem->setParent(parentItem);

QObject::setParent
void setParent(QObject *parent)
Makes the object a child of parent.
Definition qobject.cpp:2261

QQuick3DObject::setParentItem
void setParentItem(QQuick3DObject *parentItem)
Definition qquick3dobject.cpp:135

QQuick3DObject::QQuick3DObject
QQuick3DObject(QQuick3DObjectPrivate &dd, QQuick3DObject *parent=nullptr)
Definition qquick3dobject.cpp:226

Definition at line 28 of file qquick3dobject.h.

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

qtquick3d/src/quick3d/qquick3dobject.h (cbc360e9571535591a95b06b9929cc4a9b39a15f)
qtquick3d/src/quick3d/qquick3dobject.cpp (35d48ad37d2a071959a71b577aef7fd2b2d88b01)

Public Slots

Signals

Protected Member Functions

Properties

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuick3DObject()

Member Function Documentation

◆ ~QQuick3DObject()

◆ childrenChanged

◆ classBegin()

◆ componentComplete()

◆ isComponentComplete()

◆ itemChange()

◆ markAllDirty()

◆ parentChanged

◆ preSync()

◆ setParentItem

◆ stateChanged

◆ update

◆ updateSpatialNode()

Property Documentation

◆ parent