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

#include <qquick3dinstancing_p.h>

Inheritance diagram for QQuick3DInstanceListEntry:
Collaboration diagram for QQuick3DInstanceListEntry:

Public Slots

void setPosition (QVector3D position)
 \qmlproperty vector3d QtQuick3D::InstanceListEntry::position
void setScale (QVector3D scale)
 \qmlproperty vector3d QtQuick3D::InstanceListEntry::scale
void setEulerRotation (QVector3D eulerRotation)
 \qmlproperty vector3d QtQuick3D::InstanceListEntry::eulerRotation
void setRotation (QQuaternion rotation)
 \qmlproperty quaternion QtQuick3D::InstanceListEntry::rotation
void setColor (QColor color)
 \qmlproperty color QtQuick3D::InstanceListEntry::color
void setCustomData (QVector4D customData)
 \qmlproperty vector4d QtQuick3D::InstanceListEntry::customData
Public Slots inherited from QQuick3DObject
void update ()
void setParentItem (QQuick3DObject *parentItem)
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe

Signals

void positionChanged ()
void scaleChanged ()
void eulerRotationChanged ()
void rotationChanged ()
void colorChanged ()
void customDataChanged ()
void changed ()
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

 QQuick3DInstanceListEntry (QQuick3DObject *parent=nullptr)
 \qmltype InstanceListEntry \inherits Object3D \inqmlmodule QtQuick3D
 ~QQuick3DInstanceListEntry () override
QVector3D position () const
QVector3D scale () const
QVector3D eulerRotation () const
QQuaternion rotation () const
QColor color () const
QVector4D customData () const
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 ()

Protected Member Functions

QSSGRenderGraphObject * updateSpatialNode (QSSGRenderGraphObject *) override
Protected Member Functions inherited from QQuick3DObject
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

QVector3D position
QVector3D scale
QVector3D eulerRotation
QQuaternion rotation
QColor color
QVector4D customData
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 QQuick3DInstanceList

Additional Inherited Members

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
 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 39 of file qquick3dinstancing_p.h.

Constructor & Destructor Documentation

◆ QQuick3DInstanceListEntry()

QQuick3DInstanceListEntry::QQuick3DInstanceListEntry ( QQuick3DObject * parent = nullptr)
explicit

\qmltype InstanceListEntry \inherits Object3D \inqmlmodule QtQuick3D

Since
6.2

Specifies an instance in an InstanceList.

The InstanceListEntry QML type is used to specify one instance in an instance list.

All the properties can have bindings and animation. Changing a property will cause the entire instance table to be recalculated and uploaded to the GPU, so this can be expensive for instance lists with many members.

Definition at line 707 of file qquick3dinstancing.cpp.

◆ ~QQuick3DInstanceListEntry()

QQuick3DInstanceListEntry::~QQuick3DInstanceListEntry ( )
inlineoverride

Definition at line 54 of file qquick3dinstancing_p.h.

Member Function Documentation

◆ changed

void QQuick3DInstanceListEntry::changed ( )
signal

◆ color()

QColor QQuick3DInstanceListEntry::color ( ) const
inline

Definition at line 75 of file qquick3dinstancing_p.h.

◆ colorChanged

void QQuick3DInstanceListEntry::colorChanged ( )
signal

◆ customData()

QVector4D QQuick3DInstanceListEntry::customData ( ) const
inline

Definition at line 80 of file qquick3dinstancing_p.h.

◆ customDataChanged

void QQuick3DInstanceListEntry::customDataChanged ( )
signal

◆ eulerRotation()

QVector3D QQuick3DInstanceListEntry::eulerRotation ( ) const
inline

Definition at line 65 of file qquick3dinstancing_p.h.

◆ eulerRotationChanged

void QQuick3DInstanceListEntry::eulerRotationChanged ( )
signal

◆ position()

QVector3D QQuick3DInstanceListEntry::position ( ) const
inline

Definition at line 56 of file qquick3dinstancing_p.h.

◆ positionChanged

void QQuick3DInstanceListEntry::positionChanged ( )
signal

◆ rotation()

QQuaternion QQuick3DInstanceListEntry::rotation ( ) const
inline

Definition at line 70 of file qquick3dinstancing_p.h.

◆ rotationChanged

void QQuick3DInstanceListEntry::rotationChanged ( )
signal

◆ scale()

QVector3D QQuick3DInstanceListEntry::scale ( ) const
inline

Definition at line 60 of file qquick3dinstancing_p.h.

◆ scaleChanged

void QQuick3DInstanceListEntry::scaleChanged ( )
signal

◆ setColor

void QQuick3DInstanceListEntry::setColor ( QColor color)
slot

\qmlproperty color QtQuick3D::InstanceListEntry::color

This property specifies the color for the instance.

Definition at line 779 of file qquick3dinstancing.cpp.

◆ setCustomData

void QQuick3DInstanceListEntry::setCustomData ( QVector4D customData)
slot

\qmlproperty vector4d QtQuick3D::InstanceListEntry::customData

This property specifies the custom data for the instance. This is not used by default, but is made available to the vertex shader of custom materials as INSTANCE_DATA.

Definition at line 795 of file qquick3dinstancing.cpp.

◆ setEulerRotation

void QQuick3DInstanceListEntry::setEulerRotation ( QVector3D eulerRotation)
slot

\qmlproperty vector3d QtQuick3D::InstanceListEntry::eulerRotation

This property specifies the rotation for the instance as an Euler vector, that is a vector containing the rotation in degrees around the x, y and z axes.

Definition at line 748 of file qquick3dinstancing.cpp.

◆ setPosition

void QQuick3DInstanceListEntry::setPosition ( QVector3D position)
slot

\qmlproperty vector3d QtQuick3D::InstanceListEntry::position

This property specifies the position for the instance.

Definition at line 717 of file qquick3dinstancing.cpp.

◆ setRotation

void QQuick3DInstanceListEntry::setRotation ( QQuaternion rotation)
slot

\qmlproperty quaternion QtQuick3D::InstanceListEntry::rotation

This property specifies the rotation for the instance as a quaternion.

Definition at line 763 of file qquick3dinstancing.cpp.

◆ setScale

void QQuick3DInstanceListEntry::setScale ( QVector3D scale)
slot

\qmlproperty vector3d QtQuick3D::InstanceListEntry::scale

This property specifies the scale for the instance as a vector containing the scale factor along the x, y and z axes.

Definition at line 732 of file qquick3dinstancing.cpp.

◆ updateSpatialNode()

QSSGRenderGraphObject * QQuick3DInstanceListEntry::updateSpatialNode ( QSSGRenderGraphObject * )
inlineoverrideprotectedvirtual

Reimplemented from QQuick3DObject.

Definition at line 103 of file qquick3dinstancing_p.h.

◆ QQuick3DInstanceList

friend class QQuick3DInstanceList
friend

Definition at line 116 of file qquick3dinstancing_p.h.

Property Documentation

◆ color

QColor QQuick3DInstanceListEntry::color
readwrite

Definition at line 48 of file qquick3dinstancing_p.h.

◆ customData

QVector4D QQuick3DInstanceListEntry::customData
readwrite

Definition at line 49 of file qquick3dinstancing_p.h.

◆ eulerRotation

QVector3D QQuick3DInstanceListEntry::eulerRotation
readwrite

Definition at line 46 of file qquick3dinstancing_p.h.

◆ position

QVector3D QQuick3DInstanceListEntry::position
readwrite

Definition at line 44 of file qquick3dinstancing_p.h.

◆ rotation

QQuaternion QQuick3DInstanceListEntry::rotation
readwrite

Definition at line 47 of file qquick3dinstancing_p.h.

◆ scale

QVector3D QQuick3DInstanceListEntry::scale
readwrite

Definition at line 45 of file qquick3dinstancing_p.h.

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