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

#include <qquick3dparticlesceneshape_p.h>

Inheritance diagram for QQuick3DParticleSceneShape:
Collaboration diagram for QQuick3DParticleSceneShape:

Classes

struct  SceneNapkinMesh

Public Slots

void setScene (QQuick3DNode *scene)
void setSceneCenter (const QVector3D &extents)
void setSceneExtents (const QVector3D &extents)
void setShapeResolution (float resolution)
void setExcludedNodes (const QList< QQuick3DNode * > &nodes)
QVector3D getPosition (int particleIndex) override
QVector3D getSurfaceNormal (int particleIndex) override
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe

Signals

void sceneChanged ()
void sceneCenterChanged ()
void sceneExtentsChanged ()
void shapeResolutionChanged ()
void geometryChanged ()
void excludedNodesChanged ()
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

 QQuick3DParticleSceneShape (QObject *parent=nullptr)
 \qmltype ParticleSceneShape3D \inherits ParticleAbstractShape3D \inqmlmodule QtQuick3D.Particles3D
 ~QQuick3DParticleSceneShape () override
QQuick3DNodescene () const
 \qmlproperty Node ParticleSceneShape3D::scene
QVector3D sceneCenter () const
 \qmlproperty Node ParticleSceneShape3D::sceneCenter
QVector3D sceneExtents () const
 \qmlproperty Node ParticleSceneShape3D::sceneExtents
float shapeResolution () const
 \qmlproperty real ParticleSceneShape3D::shapeResolution
QQuick3DGeometrygeometry () const
 \qmlproperty Node ParticleSceneShape3D::geometry
QList< QQuick3DNode * > excludedNodes () const
 \qmlproperty list<Node> ParticleSceneShape3D::excludedNodes
Public Member Functions inherited from QQuick3DParticleAbstractShape
 QQuick3DParticleAbstractShape (QObject *parent=nullptr)
 \qmltype ParticleAbstractShape3D \inherits QtObject \inqmlmodule QtQuick3D.Particles3D
virtual QVector3D getPosition (int particleIndex)=0
 Q_REVISION (6, 10) virtual QVector3D getSurfaceNormal(int particleIndex)=0
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 ()

Properties

QQuick3DNodescene
QVector3D sceneCenter
QVector3D sceneExtents
float shapeResolution
QList< QQuick3DNode * > excludedNodes
QQuick3DGeometrygeometry
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 31 of file qquick3dparticlesceneshape_p.h.

Constructor & Destructor Documentation

◆ QQuick3DParticleSceneShape()

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

\qmltype ParticleSceneShape3D \inherits ParticleAbstractShape3D \inqmlmodule QtQuick3D.Particles3D

Offers particle shape from a scene for emitters and affectors.

Since
6.11

The ParticleSceneShape3D element can be used to get particle shape from a 3D scene. The shape envelopes the scene into single shape based on the models in a scene.

For example,

\qml ParticleEmitter3D { id: emitter particle: particle

...

shape: ParticleSceneShape3D { id: sceneShape scene: sceneRoot sceneCenter: node.scenePosition sceneExtents: Qt.vector3d(1000, 500, 1000) }

... } \endqml

Definition at line 50 of file qquick3dparticlesceneshape.cpp.

◆ ~QQuick3DParticleSceneShape()

QQuick3DParticleSceneShape::~QQuick3DParticleSceneShape ( )
override

Definition at line 56 of file qquick3dparticlesceneshape.cpp.

Member Function Documentation

◆ excludedNodes()

QList< QQuick3DNode * > QQuick3DParticleSceneShape::excludedNodes ( ) const

\qmlproperty list<Node> ParticleSceneShape3D::excludedNodes

This property holds the list of nodes that are excluded when building the shape. Model is excluded from the shape if it is one of the nodes or their child node.

Definition at line 176 of file qquick3dparticlesceneshape.cpp.

◆ excludedNodesChanged

void QQuick3DParticleSceneShape::excludedNodesChanged ( )
signal

◆ geometry()

QQuick3DGeometry * QQuick3DParticleSceneShape::geometry ( ) const

\qmlproperty Node ParticleSceneShape3D::geometry

This property holds the geometry of the generated shape. It can be used to render the shape to visualize it.

Definition at line 164 of file qquick3dparticlesceneshape.cpp.

◆ geometryChanged

void QQuick3DParticleSceneShape::geometryChanged ( )
signal

◆ getPosition

QVector3D QQuick3DParticleSceneShape::getPosition ( int particleIndex)
overrideslot

Definition at line 190 of file qquick3dparticlesceneshape.cpp.

◆ getSurfaceNormal

QVector3D QQuick3DParticleSceneShape::getSurfaceNormal ( int particleIndex)
overrideslot

Definition at line 195 of file qquick3dparticlesceneshape.cpp.

◆ scene()

QQuick3DNode * QQuick3DParticleSceneShape::scene ( ) const

\qmlproperty Node ParticleSceneShape3D::scene

This property holds the root node of the scene. The scene shape is dynamically calculated based on the child models of the scene. If the scene changes, the shape is recalculated. If a model is not visible in the scene, it won't be included in the shape. Only the node visibility is checked by the implementation. If the material is fully transparent or the node gets filtered out, the shape will still contain those nodes unless they are manyally excluded.

Definition at line 72 of file qquick3dparticlesceneshape.cpp.

◆ sceneCenter()

QVector3D QQuick3DParticleSceneShape::sceneCenter ( ) const

\qmlproperty Node ParticleSceneShape3D::sceneCenter

This property holds the center point where the shape is calculated.

The default value is Qt.vector3(0, 0, 0).

Definition at line 94 of file qquick3dparticlesceneshape.cpp.

◆ sceneCenterChanged

void QQuick3DParticleSceneShape::sceneCenterChanged ( )
signal

◆ sceneChanged

void QQuick3DParticleSceneShape::sceneChanged ( )
signal

◆ sceneExtents()

QVector3D QQuick3DParticleSceneShape::sceneExtents ( ) const

\qmlproperty Node ParticleSceneShape3D::sceneExtents

This property holds the extents for which the shape is calculated. The extents are added to the scene center and any polygon outside this volume are left out of the shape. If this value is empty, all polygons are included.

The default value is Qt.vector3(0, 0, 0).

Definition at line 119 of file qquick3dparticlesceneshape.cpp.

◆ sceneExtentsChanged

void QQuick3DParticleSceneShape::sceneExtentsChanged ( )
signal

◆ setExcludedNodes

void QQuick3DParticleSceneShape::setExcludedNodes ( const QList< QQuick3DNode * > & nodes)
slot

Definition at line 181 of file qquick3dparticlesceneshape.cpp.

◆ setScene

void QQuick3DParticleSceneShape::setScene ( QQuick3DNode * scene)
slot

Definition at line 77 of file qquick3dparticlesceneshape.cpp.

◆ setSceneCenter

void QQuick3DParticleSceneShape::setSceneCenter ( const QVector3D & extents)
slot

Definition at line 99 of file qquick3dparticlesceneshape.cpp.

◆ setSceneExtents

void QQuick3DParticleSceneShape::setSceneExtents ( const QVector3D & extents)
slot

Definition at line 124 of file qquick3dparticlesceneshape.cpp.

◆ setShapeResolution

void QQuick3DParticleSceneShape::setShapeResolution ( float resolution)
slot

Definition at line 148 of file qquick3dparticlesceneshape.cpp.

◆ shapeResolution()

float QQuick3DParticleSceneShape::shapeResolution ( ) const

\qmlproperty real ParticleSceneShape3D::shapeResolution

This property holds the resolution of the shape. The higher the value the more accurately the shape resembles individual models.

The minimum value is 1.0, the maximum value is 100.0; \default 10.0;

Definition at line 143 of file qquick3dparticlesceneshape.cpp.

◆ shapeResolutionChanged

void QQuick3DParticleSceneShape::shapeResolutionChanged ( )
signal

Property Documentation

◆ excludedNodes

QList<QQuick3DNode *> QQuick3DParticleSceneShape::excludedNodes
readwrite

Definition at line 38 of file qquick3dparticlesceneshape_p.h.

◆ geometry

QQuick3DGeometry * QQuick3DParticleSceneShape::geometry
read

Definition at line 39 of file qquick3dparticlesceneshape_p.h.

◆ scene

QQuick3DNode * QQuick3DParticleSceneShape::scene
readwrite

Definition at line 34 of file qquick3dparticlesceneshape_p.h.

◆ sceneCenter

QVector3D QQuick3DParticleSceneShape::sceneCenter
readwrite

Definition at line 35 of file qquick3dparticlesceneshape_p.h.

◆ sceneExtents

QVector3D QQuick3DParticleSceneShape::sceneExtents
readwrite

Definition at line 36 of file qquick3dparticlesceneshape_p.h.

◆ shapeResolution

float QQuick3DParticleSceneShape::shapeResolution
readwrite

Definition at line 37 of file qquick3dparticlesceneshape_p.h.


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