Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QQuick3DParticleCustomShape Class Reference

#include <qquick3dparticlecustomshape_p.h>

+ Inheritance diagram for QQuick3DParticleCustomShape:
+ Collaboration diagram for QQuick3DParticleCustomShape:

Public Slots

void setSource (const QUrl &source)
 
void setRandomizeData (bool random)
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void sourceChanged ()
 
void randomizeDataChanged ()
 
- 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

 QQuick3DParticleCustomShape (QObject *parent=nullptr)
 \qmltype ParticleCustomShape3D \inherits ParticleAbtractShape3D \inqmlmodule QtQuick3D.Particles3D
 
QUrl source () const
 \qmlproperty url ParticleCustomShape3D::source
 
bool randomizeData () const
 \qmlproperty bool ParticleCustomShape3D::randomizeData
 
QVector3D getPosition (int particleIndex) override
 
- Public Member Functions inherited from QQuick3DParticleAbstractShape
 QQuick3DParticleAbstractShape (QObject *parent=nullptr)
 \qmltype ParticleAbstractShape3D \inherits QtObject \inqmlmodule QtQuick3D.Particles3D
 
- 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 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 ()
 

Properties

QUrl source
 
bool randomizeData
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

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 Member Functions inherited from QQuick3DParticleAbstractShape
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 
void classBegin () override
 Invoked after class creation, but before any properties have been set.
 
QQuick3DNodeparentNode ()
 
- 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.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Protected Attributes inherited from QQuick3DParticleAbstractShape
QQuick3DNodem_parentNode = nullptr
 
QQuick3DParticleSystemm_system = nullptr
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 

Detailed Description

Definition at line 22 of file qquick3dparticlecustomshape_p.h.

Constructor & Destructor Documentation

◆ QQuick3DParticleCustomShape()

QT_BEGIN_NAMESPACE QQuick3DParticleCustomShape::QQuick3DParticleCustomShape ( QObject * parent = nullptr)
explicit

\qmltype ParticleCustomShape3D \inherits ParticleAbtractShape3D \inqmlmodule QtQuick3D.Particles3D

Loads custom particle shapes for emitters and affectors.

Since
6.3

The ParticleCustomShape3D element can be used to load custom particle shapes.

For example, to emit particles from positions defined in heart.cbor:

\qml ParticleEmitter3D { shape: ParticleCustomShape3D { source: "heart.cbor" } ... } \endqml

The format of CBOR shape files is following: \badcode [ "QQ3D_SHAPE", // string version, // integer [ posX, // float posY, // float posZ, // float posX, // float ... ] ]

To assist in generating these shape files you can use the shapegen tool.

Definition at line 53 of file qquick3dparticlecustomshape.cpp.

Member Function Documentation

◆ getPosition()

QVector3D QQuick3DParticleCustomShape::getPosition ( int particleIndex)
overridevirtual

Implements QQuick3DParticleAbstractShape.

Definition at line 159 of file qquick3dparticlecustomshape.cpp.

References QList< T >::at(), QList< T >::isEmpty(), QObject::parent(), QQuick3DParticleAbstractShape::parentNode(), and QList< T >::size().

+ Here is the call graph for this function:

◆ randomizeData()

bool QQuick3DParticleCustomShape::randomizeData ( ) const

\qmlproperty bool ParticleCustomShape3D::randomizeData

This property holds whether the particles are used in random order instead of in the order they are specified in the source.

The default value is false.

Definition at line 77 of file qquick3dparticlecustomshape.cpp.

◆ randomizeDataChanged

void QQuick3DParticleCustomShape::randomizeDataChanged ( )
signal

Referenced by setRandomizeData().

+ Here is the caller graph for this function:

◆ setRandomizeData

void QQuick3DParticleCustomShape::setRandomizeData ( bool random)
slot

Definition at line 93 of file qquick3dparticlecustomshape.cpp.

References Q_EMIT, and randomizeDataChanged().

+ Here is the call graph for this function:

◆ setSource

void QQuick3DParticleCustomShape::setSource ( const QUrl & source)
slot

Definition at line 82 of file qquick3dparticlecustomshape.cpp.

References Q_EMIT, source, and sourceChanged().

+ Here is the call graph for this function:

◆ source()

QUrl QQuick3DParticleCustomShape::source ( ) const

\qmlproperty url ParticleCustomShape3D::source

This property holds the location of the shape file.

Definition at line 64 of file qquick3dparticlecustomshape.cpp.

◆ sourceChanged

void QQuick3DParticleCustomShape::sourceChanged ( )
signal

Referenced by setSource().

+ Here is the caller graph for this function:

Property Documentation

◆ randomizeData

bool QQuick3DParticleCustomShape::randomizeData
readwrite

Definition at line 26 of file qquick3dparticlecustomshape_p.h.

◆ source

QUrl QQuick3DParticleCustomShape::source
readwrite

Definition at line 25 of file qquick3dparticlecustomshape_p.h.

Referenced by setSource().


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