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

#include <qquick3drepeater_p.h>

Inheritance diagram for QQuick3DRepeater:
Collaboration diagram for QQuick3DRepeater:

Signals

void modelChanged ()
void delegateChanged ()
void countChanged ()
void objectAdded (int index, QQuick3DObject *object)
void objectRemoved (int index, QQuick3DObject *object)
 Q_REVISION (6, 10) void delegateModelAccessChanged()
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

 QQuick3DRepeater (QQuick3DNode *parent=nullptr)
 \qmltype Repeater3D \inqmlmodule QtQuick3D \inherits Node
 ~QQuick3DRepeater () override
QVariant model () const
 \qmlproperty any QtQuick3D::Repeater3D::model
void setModel (const QVariant &)
QQmlComponentdelegate () const
 \qmlproperty Component QtQuick3D::Repeater3D::delegate \qmldefault
void setDelegate (QQmlComponent *)
int count () const
 \qmlproperty int QtQuick3D::Repeater3D::count \readonly
Q_INVOKABLE QQuick3DObjectobjectAt (int index) const
 \qmlmethod Object3D QtQuick3D::Repeater3D::objectAt(index)
QQmlDelegateModel::DelegateModelAccess delegateModelAccess () const
 \qmlproperty enumeration QtQuick3D::Repeater3D::delegateModelAccess
void setDelegateModelAccess (QQmlDelegateModel::DelegateModelAccess delegateModelAccess)
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

void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
void itemChange (ItemChange change, const ItemChangeData &value) override
virtual void initDelegate (int, QQuick3DNode *)
Protected Member Functions inherited from QQuick3DNode
void connectNotify (const QMetaMethod &signal) override
void disconnectNotify (const QMetaMethod &signal) override
 QQuick3DNode (QQuick3DNodePrivate &dd, QQuick3DNode *parent=nullptr)
QSSGRenderGraphObjectupdateSpatialNode (QSSGRenderGraphObject *node) 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.
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

QVariant model
QQmlComponentdelegate
int count
QQmlDelegateModel::DelegateModelAccess delegateModelAccess
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 }
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 &)
 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 31 of file qquick3drepeater_p.h.

Constructor & Destructor Documentation

◆ QQuick3DRepeater()

QT_BEGIN_NAMESPACE QQuick3DRepeater::QQuick3DRepeater ( QQuick3DNode * parent = nullptr)

\qmltype Repeater3D \inqmlmodule QtQuick3D \inherits Node

Instantiates a number of Node-based components using a provided model.

The Repeater3D type is used to create a large number of similar items. Like other view types, a Repeater3D has a \l model and a \l delegate: for each entry in the model, the delegate is instantiated in a context seeded with data from the model.

A Repeater's \l model can be any of the supported \l {qml-data-models}{data models}. Additionally, like delegates for other views, a Repeater delegate can access its index within the repeater, as well as the model data relevant to the delegate. See the \l delegate property documentation for details.

Note
A Repeater3D item owns all items it instantiates. Removing or dynamically destroying an item created by a Repeater3D results in unpredictable behavior.
Repeater3D is \l {Node}-based, and can only repeat \l {Node}-derived objects.

\qmlsignal QtQuick3D::Repeater3D::objectAdded(int index, Object3D object)

This signal is emitted when an object is added to the repeater. The index parameter holds the index at which object has been inserted within the repeater, and the object parameter holds the \l Object3D that has been added.

The corresponding handler is onObjectAdded.

\qmlsignal QtQuick3D::Repeater3D::objectRemoved(int index, Object3D object)

This signal is emitted when an object is removed from the repeater. The index parameter holds the index at which the item was removed from the repeater, and the object parameter holds the \l Object3D that was removed.

Do not keep a reference to object if it was created by this repeater, as in these cases it will be deleted shortly after the signal is handled.

The corresponding handler is onObjectRemoved.

Definition at line 60 of file qquick3drepeater.cpp.

◆ ~QQuick3DRepeater()

QQuick3DRepeater::~QQuick3DRepeater ( )
override

Definition at line 71 of file qquick3drepeater.cpp.

Member Function Documentation

◆ componentComplete()

void QQuick3DRepeater::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.

Reimplemented from QQuick3DNode.

Definition at line 459 of file qquick3drepeater.cpp.

◆ count()

int QQuick3DRepeater::count ( ) const

\qmlproperty int QtQuick3D::Repeater3D::count \readonly

This property holds the number of items in the model.

Note
The number of items in the model as reported by count may differ from the number of created delegates if the Repeater3D is in the process of instantiating delegates or is incorrectly set up.

Definition at line 326 of file qquick3drepeater.cpp.

◆ countChanged

void QQuick3DRepeater::countChanged ( )
signal

◆ delegate()

QQmlComponent * QQuick3DRepeater::delegate ( ) const

\qmlproperty Component QtQuick3D::Repeater3D::delegate \qmldefault

The delegate provides a template defining each object instantiated by the repeater.

Delegates are exposed to a read-only index property that indicates the index of the delegate within the repeater.

If the \l model is a model object (such as a \l ListModel) the delegate can access all model roles as named properties, in the same way that delegates do for view classes like ListView.

See also
{QML Data Models}

Definition at line 260 of file qquick3drepeater.cpp.

◆ delegateChanged

void QQuick3DRepeater::delegateChanged ( )
signal

◆ delegateModelAccess()

QQmlDelegateModel::DelegateModelAccess QQuick3DRepeater::delegateModelAccess ( ) const

\qmlproperty enumeration QtQuick3D::Repeater3D::delegateModelAccess

Since
6.10

This property determines how delegates can access the model.

\value DelegateModel.ReadOnly Prohibit delegates from writing the model via either context properties, the model object, or required properties.

\value DelegateModel.ReadWrite Allow delegates to write the model via either context properties, the model object, or required properties.

\value DelegateModel.Qt5ReadWrite Allow delegates to write the model via the model object and context properties but not via required properties.

The default is DelegateModel.Qt5ReadWrite.

See also
{Models and Views in Qt Quick#Changing Model Data}

Definition at line 369 of file qquick3drepeater.cpp.

◆ initDelegate()

virtual void QQuick3DRepeater::initDelegate ( int ,
QQuick3DNode *  )
inlineprotectedvirtual

Reimplemented in InstanceRepeater.

Definition at line 79 of file qquick3drepeater_p.h.

◆ itemChange()

void QQuick3DRepeater::itemChange ( ItemChange change,
const ItemChangeData & value )
overrideprotectedvirtual

Reimplemented from QQuick3DNode.

Definition at line 469 of file qquick3drepeater.cpp.

◆ model()

QVariant QQuick3DRepeater::model ( ) const

\qmlproperty any QtQuick3D::Repeater3D::model

The model providing data for the repeater.

This property can be set to any of the supported \l {qml-data-models}{data models}:

\list

  • A number that indicates the number of delegates to be created by the repeater
  • A model (e.g. a ListModel item, or a QAbstractItemModel subclass)
  • A string list
  • An object list \endlist

The type of model affects the properties that are exposed to the \l delegate.

See also
{qml-data-models}{Data Models}

Definition at line 150 of file qquick3drepeater.cpp.

◆ modelChanged

void QQuick3DRepeater::modelChanged ( )
signal

◆ objectAdded

void QQuick3DRepeater::objectAdded ( int index,
QQuick3DObject * object )
signal

◆ objectAt()

QQuick3DObject * QQuick3DRepeater::objectAt ( int index) const

\qmlmethod Object3D QtQuick3D::Repeater3D::objectAt(index)

Returns the \l Object3D that has been created at the given index, or null if no item exists at index.

Definition at line 340 of file qquick3drepeater.cpp.

◆ objectRemoved

void QQuick3DRepeater::objectRemoved ( int index,
QQuick3DObject * object )
signal

◆ Q_REVISION

QQuick3DRepeater::Q_REVISION ( 6 ,
10  )
signal

◆ setDelegate()

void QQuick3DRepeater::setDelegate ( QQmlComponent * delegate)

Definition at line 270 of file qquick3drepeater.cpp.

◆ setDelegateModelAccess()

void QQuick3DRepeater::setDelegateModelAccess ( QQmlDelegateModel::DelegateModelAccess delegateModelAccess)

Definition at line 376 of file qquick3drepeater.cpp.

◆ setModel()

void QQuick3DRepeater::setModel ( const QVariant & m)

Definition at line 180 of file qquick3drepeater.cpp.

Property Documentation

◆ count

int QQuick3DRepeater::count
read

Definition at line 37 of file qquick3drepeater_p.h.

◆ delegate

QQmlComponent * QQuick3DRepeater::delegate
readwrite

Definition at line 36 of file qquick3drepeater_p.h.

◆ delegateModelAccess

QQmlDelegateModel::DelegateModelAccess QQuick3DRepeater::delegateModelAccess
readwrite

Definition at line 38 of file qquick3drepeater_p.h.

◆ model

QVariant QQuick3DRepeater::model
readwrite

Definition at line 35 of file qquick3drepeater_p.h.


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