#include <qquick3dinstancing_p.h>

Inheritance diagram for QQuick3DInstanceList:

Collaboration diagram for QQuick3DInstanceList:

Signals
void	instanceCountChanged ()

Signals inherited from QQuick3DInstancing
void	instanceTableChanged ()

void	instanceNodeDirty ()

void	instanceCountOverrideChanged ()

void	hasTransparencyChanged ()

void	depthSortingEnabledChanged ()

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
	QQuick3DInstanceList (QQuick3DObject *parent=nullptr)
	\qmltype InstanceList \inherits Instancing \inqmlmodule QtQuick3D

	~QQuick3DInstanceList () override

QByteArray	getInstanceBuffer (int *instanceCount) override
	Implement this function to return the contents of the instance table.

QQmlListProperty< QQuick3DInstanceListEntry >	instances ()

int	instanceCount () const
	\qmlproperty int QtQuick3D::InstanceList::instanceCount

Public Member Functions inherited from QQuick3DInstancing
	QQuick3DInstancing (QQuick3DObject *parent=nullptr)

	~QQuick3DInstancing () override

QByteArray	instanceBuffer (int *instanceCount)

int	instanceCountOverride () const

bool	hasTransparency () const

bool	depthSortingEnabled () const

	Q_REVISION (6, 3) Q_INVOKABLE QVector3D instancePosition(int index)

	Q_REVISION (6, 3) Q_INVOKABLE QVector3D instanceScale(int index)

	Q_REVISION (6, 3) Q_INVOKABLE QQuaternion instanceRotation(int index)

	Q_REVISION (6, 3) Q_INVOKABLE QColor instanceColor(int index)

	Q_REVISION (6, 3) Q_INVOKABLE QVector4D instanceCustomData(int index)

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

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.

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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

template<typename T >
T	findChild (const QString &aName=QString(), 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 (const QString &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 >
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 ()

virtual void	classBegin ()=0
	Invoked after class creation, but before any properties have been set.

virtual void	componentComplete ()=0
	Invoked after the root component that caused this instantiation has completed construction.

Properties
QQmlListProperty< QQuick3DInstanceListEntry >	instances

int	instanceCount

Properties inherited from QQuick3DInstancing
int	instanceCountOverride

bool	hasTransparency
	\qmlproperty bool Instancing::hasTransparency

bool	depthSortingEnabled
	\qmlproperty bool Instancing::depthSortingEnabled

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

Additional Inherited Members
Public Slots inherited from QQuick3DInstancing
void	setInstanceCountOverride (int instanceCountOverride)

void	setHasTransparency (bool hasTransparency)

void	setDepthSortingEnabled (bool enabled)

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 &)
	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 QQuick3DInstancing
virtual QByteArray	getInstanceBuffer (int *instanceCount)=0
	Implement this function to return the contents of the instance table.

void	markDirty ()
	Mark that the instance data has changed and must be uploaded again.

QSSGRenderGraphObject *	updateSpatialNode (QSSGRenderGraphObject *node) override

Protected Member Functions inherited from QQuick3DObject
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)

Static Protected Member Functions inherited from QQuick3DInstancing
static InstanceTableEntry	calculateTableEntry (const QVector3D &position, const QVector3D &scale, const QVector3D &eulerRotation, const QColor &color, const QVector4D &customData={})
	Converts the position scale eulerRotation color and customData to the instance table format expected by the standard vertex shaders.

static InstanceTableEntry	calculateTableEntryFromQuaternion (const QVector3D &position, const QVector3D &scale, const QQuaternion &rotation, const QColor &color, const QVector4D &customData={})
	Converts the position scale rotation color and customData to the instance table format expected by the standard vertex shaders.

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

Definition at line 117 of file qquick3dinstancing_p.h.

Constructor & Destructor Documentation

◆ QQuick3DInstanceList()

QQuick3DInstanceList::QQuick3DInstanceList ( QQuick3DObject * parent = nullptr )

explicit

\qmltype InstanceList \inherits Instancing \inqmlmodule QtQuick3D

Allows manually specifying instancing in QML.

The InstanceList type makes it possible to define an instance table manually in QML.

The following example creates an instance table with two items: \qml InstanceList { id: manualInstancing instances: [ InstanceListEntry { position: Qt.vector3d(0, 0, -60) eulerRotation: Qt.vector3d(-10, 0, 30) color: "red" }, InstanceListEntry { position: Qt.vector3d(50, 10, 100) eulerRotation: Qt.vector3d(0, 180, 0) color: "green" } ] } \endqml

Each InstanceListEntry is an object that can have property bindings and animations. This gives great flexibility, but also causes memory overhead. Therefore, it is not recommended to use InstanceList for procedurally generated tables containing thousands (or millions) of instances. Also, any property change to an entry will cause the entire instance table to be recalculated and uploaded to the GPU.

See also: RandomInstancing, QQuick3DInstancing

\qmlproperty List<QtQuick3D::InstanceListEntry> InstanceList::instances

This property contains the list of instance definitions. Modifying this list, or any of its elements, will cause the instance table to be updated.

Definition at line 507 of file qquick3dinstancing.cpp.

◆ ~QQuick3DInstanceList()

QQuick3DInstanceList::~QQuick3DInstanceList ( )

override

Definition at line 509 of file qquick3dinstancing.cpp.

Member Function Documentation

◆ getInstanceBuffer()

QByteArray QQuick3DInstanceList::getInstanceBuffer ( int * instanceCount )

overridevirtual

Implement this function to return the contents of the instance table.

The number of instances should be returned in instanceCount. The subclass is responsible for caching the result if necessary. If the instance table changes, the subclass should call markDirty().

Implements QQuick3DInstancing.

Definition at line 511 of file qquick3dinstancing.cpp.

References instanceCount, and QList< T >::size().

Here is the call graph for this function:

◆ instanceCount()

int QQuick3DInstanceList::instanceCount ( ) const

\qmlproperty int QtQuick3D::InstanceList::instanceCount

Since: 6.3

This read-only property contains the number of instances in the list.

Definition at line 538 of file qquick3dinstancing.cpp.

References QList< T >::size().

Here is the call graph for this function:

◆ instanceCountChanged

void QQuick3DInstanceList::instanceCountChanged ( )

signal

◆ instances()

QQmlListProperty< QQuick3DInstanceListEntry > QQuick3DInstanceList::instances ( )

Property Documentation

◆ instanceCount

int QQuick3DInstanceList::instanceCount

read

Definition at line 114 of file qquick3dinstancing_p.h.

Referenced by getInstanceBuffer().

◆ instances

QQmlListProperty< QQuick3DInstanceListEntry > QQuick3DInstanceList::instances