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
Public Types | Public Slots | Signals | Public Member Functions | Properties | List of all members
QQuick3DParticleShape Class Reference

#include <qquick3dparticleshape_p.h>

+ Inheritance diagram for QQuick3DParticleShape:
+ Collaboration diagram for QQuick3DParticleShape:

Public Types

enum  ShapeType { Cube = 0 , Sphere , Cylinder }
 

Public Slots

void setFill (bool fill)
 
void setType (QQuick3DParticleShape::ShapeType type)
 
void setExtents (QVector3D extends)
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void fillChanged ()
 
void typeChanged ()
 
void extentsChanged ()
 
- 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

 QQuick3DParticleShape (QObject *parent=nullptr)
 \qmltype ParticleShape3D \inherits ParticleAbtractShape3D \inqmlmodule QtQuick3D.Particles3D
 
bool fill () const
 \qmlproperty bool ParticleShape3D::fill
 
ShapeType type () const
 \qmlproperty ShapeType ParticleShape3D::type
 
QVector3D extents () const
 \qmlproperty vector3d ParticleShape3D::extents
 
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< 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.
 
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 ()
 

Properties

bool fill
 
ShapeType type
 
QVector3D extents
 
- 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.
 
QQuick3DNode * parentNode ()
 
- 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)
 
- Protected Attributes inherited from QQuick3DParticleAbstractShape
QQuick3DNode * m_parentNode = nullptr
 
QQuick3DParticleSystem * m_system = nullptr
 
- 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 26 of file qquick3dparticleshape_p.h.

Member Enumeration Documentation

◆ ShapeType

enum QQuick3DParticleShape::ShapeType
Enumerator
Cube 
Sphere 
Cylinder 

Definition at line 37 of file qquick3dparticleshape_p.h.

Constructor & Destructor Documentation

◆ QQuick3DParticleShape()

QT_BEGIN_NAMESPACE QQuick3DParticleShape::QQuick3DParticleShape ( QObject * parent = nullptr)

\qmltype ParticleShape3D \inherits ParticleAbtractShape3D \inqmlmodule QtQuick3D.Particles3D

Offers 3D shapes for emitters and affectors.

Since
6.2

The ParticleShape3D element supports shapes like Cube, Sphere and Cylinder for particles needs. For example, emitter can use \l {ParticleEmitter3D::shape}{shape} property to emit particles from the shape area.

Shapes don't have position, scale or rotation. Instead, they use parent node for these properties.

Definition at line 31 of file qquick3dparticleshape.cpp.

Member Function Documentation

◆ extents()

QVector3D QQuick3DParticleShape::extents ( ) const

\qmlproperty vector3d ParticleShape3D::extents

This property defines the extents of the shape.

The default value for each axis is 50.

Definition at line 90 of file qquick3dparticleshape.cpp.

◆ extentsChanged

void QQuick3DParticleShape::extentsChanged ( )
signal

Referenced by setExtents().

+ Here is the caller graph for this function:

◆ fill()

bool QQuick3DParticleShape::fill ( ) const

\qmlproperty bool ParticleShape3D::fill

This property defines if the shape should be filled or just use the shape outlines.

The default value is true.

Definition at line 43 of file qquick3dparticleshape.cpp.

◆ fillChanged

void QQuick3DParticleShape::fillChanged ( )
signal

Referenced by setFill().

+ Here is the caller graph for this function:

◆ getPosition()

QVector3D QQuick3DParticleShape::getPosition ( int particleIndex)
overridevirtual

Implements QQuick3DParticleAbstractShape.

Definition at line 113 of file qquick3dparticleshape.cpp.

References Cube, Cylinder, QQuick3DParticleAbstractShape::m_system, QQuick3DParticleAbstractShape::parentNode(), and Sphere.

+ Here is the call graph for this function:

◆ setExtents

void QQuick3DParticleShape::setExtents ( QVector3D extends)
slot

Definition at line 104 of file qquick3dparticleshape.cpp.

References extents, extentsChanged(), and Q_EMIT.

+ Here is the call graph for this function:

◆ setFill

void QQuick3DParticleShape::setFill ( bool fill)
slot

Definition at line 48 of file qquick3dparticleshape.cpp.

References fill, fillChanged(), and Q_EMIT.

+ Here is the call graph for this function:

◆ setType

void QQuick3DParticleShape::setType ( QQuick3DParticleShape::ShapeType type)
slot

Definition at line 95 of file qquick3dparticleshape.cpp.

References Q_EMIT, type, and typeChanged().

+ Here is the call graph for this function:

◆ type()

QQuick3DParticleShape::ShapeType QQuick3DParticleShape::type ( ) const

\qmlproperty ShapeType ParticleShape3D::type

This property defines the type of the shape.

The default value is ParticleShape3D.Cube.

\qmlproperty enumeration ParticleShape3D::ShapeType

Defines the type of the shape.

\value ParticleShape3D.Cube Cube shape. \value ParticleShape3D.Sphere Sphere shape. \value ParticleShape3D.Cylinder Cylinder shape.

Definition at line 78 of file qquick3dparticleshape.cpp.

◆ typeChanged

void QQuick3DParticleShape::typeChanged ( )
signal

Referenced by setType().

+ Here is the caller graph for this function:

Property Documentation

◆ extents

QVector3D QQuick3DParticleShape::extents
readwrite

Definition at line 31 of file qquick3dparticleshape_p.h.

Referenced by setExtents().

◆ fill

bool QQuick3DParticleShape::fill
readwrite

Definition at line 29 of file qquick3dparticleshape_p.h.

Referenced by setFill().

◆ type

ShapeType QQuick3DParticleShape::type
readwrite

Definition at line 30 of file qquick3dparticleshape_p.h.

Referenced by setType().

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