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

#include <qquick3dobject.h>

Inheritance diagram for QQuick3DContentLayer:
Collaboration diagram for QQuick3DContentLayer:

Public Types

enum  LayerFlag : quint32 {
  LayerNone = 0x0 , Layer0 = 0x1 , Layer1 = 0x2 , Layer2 = 0x4 ,
  Layer3 = 0x8 , Layer4 = 0x10 , Layer5 = 0x20 , Layer6 = 0x40 ,
  Layer7 = 0x80 , Layer8 = 0x100 , Layer9 = 0x200 , Layer10 = 0x400 ,
  Layer11 = 0x800 , Layer12 = 0x1000 , Layer13 = 0x2000 , Layer14 = 0x4000 ,
  Layer15 = 0x8000 , Layer16 = 0x10000 , Layer17 = 0x20000 , Layer18 = 0x40000 ,
  Layer19 = 0x80000 , Layer20 = 0x100000 , Layer21 = 0x200000 , Layer22 = 0x400000 ,
  Layer23 = 0x800000 , LayerAll = 0xFFFFFF , Layer24 = 0x1000000 , Layer25 = 0x2000000 ,
  Layer26 = 0x4000000 , Layer27 = 0x8000000 , Layer28 = 0x10000000 , Layer29 = 0x20000000 ,
  Layer30 = 0x40000000 , Layer31 = 0x80000000 , ReservedLayerMask = 0xFF000000
}

Public Member Functions

 QQuick3DContentLayer (QObject *parent=nullptr)
 \qmltype ContentLayer \inqmlmodule QtQuick3D
 ~QQuick3DContentLayer () override
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.

Additional Inherited Members

Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
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.
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 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 QObject
QScopedPointer< QObjectDatad_ptr
Properties inherited from QObject
QString objectName
 the name of this object

Detailed Description

Definition at line 111 of file qquick3dobject.h.

Member Enumeration Documentation

◆ LayerFlag

Enumerator
LayerNone 
Layer0 
Layer1 
Layer2 
Layer3 
Layer4 
Layer5 
Layer6 
Layer7 
Layer8 
Layer9 
Layer10 
Layer11 
Layer12 
Layer13 
Layer14 
Layer15 
Layer16 
Layer17 
Layer18 
Layer19 
Layer20 
Layer21 
Layer22 
Layer23 
LayerAll 
Layer24 
Layer25 
Layer26 
Layer27 
Layer28 
Layer29 
Layer30 
Layer31 
ReservedLayerMask 

Definition at line 121 of file qquick3dobject.h.

Constructor & Destructor Documentation

◆ QQuick3DContentLayer()

QQuick3DContentLayer::QQuick3DContentLayer ( QObject * parent = nullptr)
explicit

\qmltype ContentLayer \inqmlmodule QtQuick3D

Since
6.11

Provides enumeration of content layers available in a QtQuick3D.

This class is used to represent a layer of content in a 3D scene. It can be used to manage different layers of content, such as background, foreground, or UI elements.

The \l ContentLayer enumeration defines the available layer flags that can be used, for example, to group scene nodes together or filter which nodes are rendered by the camera.

The predefined layer names are not necessarily descriptive enough for specific use cases, in which case you can define your own layers by aliasing the \l ContentLayer enumeration values. Consider a city scene where you have different layers for buildings, streets, and vehicles. You can assign each of these layers a specific flag, such as layerBuildings, layerStreets, and layerVehicles by aliasing the \l ContentLayer enumeration values. Once the layers are defined, you can assign these flags to the nodes in the scene and have the camera filter which layers to render by setting the same \l {Node::layer}{layer} property on the \l Camera.

\qml readonly property int layerBuildings: ContentLayer.Layer1 readonly property int layerStreets: ContentLayer.Layer2 readonly property int layerVehicles: ContentLayer.Layer3 | ContentLayer.Layer4 \endqml

See also
{Qt Quick 3D - Layers Example}{Layers Example}
Note
Some of the layers have special meanings:

\table \header

  • Layer
  • Description \row
  • LayerNone
  • No layer assigned, used to indicate that a node does not belong to any layer and should not be rendered. \row
  • Layer0
  • The main layer, used for the primary content in the scene. Nodes are assigned to this layer by default. \row
  • Layer1-23
  • Freely assignable layers, used for grouping nodes together based on their purpose or functionality. \row
  • Layer24 and up
  • Reserved layers, used for special purposes or future extensions. \row
  • LayerAll
  • Indicates that a node belongs to all layers, used for nodes that should be rendered in every layer. \endtable
Note
The layers are defined as flags, which means that you can combine multiple layers
This class is not intended to be instantiated directly. Instead, it is used as a singleton in QML to access the layer flags.

Definition at line 323 of file qquick3dobject.cpp.

◆ ~QQuick3DContentLayer()

QQuick3DContentLayer::~QQuick3DContentLayer ( )
override

Definition at line 329 of file qquick3dobject.cpp.


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