QQuick3DMaterial Class Reference

#include <qquick3dmaterial_p.h>

Inheritance diagram for QQuick3DMaterial:

Collaboration diagram for QQuick3DMaterial:

Public Types
enum	CullMode { BackFaceCulling = 1 , FrontFaceCulling = 2 , NoCulling = 3 }
enum	TextureChannelMapping { R = 0 , G , B , A }
enum	DepthDrawMode { OpaqueOnlyDepthDraw = 0 , AlwaysDepthDraw , NeverDepthDraw , OpaquePrePassDepthDraw }

Public Slots
void	setLightProbe (QQuick3DTexture *lightProbe)
void	setCullMode (QQuick3DMaterial::CullMode cullMode)
void	setDepthDrawMode (QQuick3DMaterial::DepthDrawMode depthDrawMode)
Public Slots inherited from QQuick3DObject
void	update ()
void	setParentItem (QQuick3DObject *parentItem)
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	lightProbeChanged (QQuick3DTexture *lightProbe)
void	cullModeChanged (QQuick3DMaterial::CullMode cullMode)
void	depthDrawModeChanged (QQuick3DMaterial::DepthDrawMode depthDrawMode)
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
	~QQuick3DMaterial () override
QQuick3DTexture *	lightProbe () const
CullMode	cullMode () const
DepthDrawMode	depthDrawMode () 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	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.
void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.
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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int id)
	Kills the timer with timer identifier, id.
template<typename T >
T	findChild (const QString &aName=QString(), 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 (const QString &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 >
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 ()
virtual void	classBegin ()=0
	Invoked after class creation, but before any properties have been set.
virtual void	componentComplete ()=0
	Invoked after the root component that caused this instantiation has completed construction.

Protected Member Functions
	QQuick3DMaterial (QQuick3DObjectPrivate &dd, QQuick3DObject *parent=nullptr)
	\qmltype Material \inherits Object3D \inqmlmodule QtQuick3D
QSSGRenderGraphObject *	updateSpatialNode (QSSGRenderGraphObject *node) override
void	itemChange (ItemChange, const ItemChangeData &) override
Protected Member Functions inherited from QQuick3DObject
virtual QSSGRenderGraphObject *	updateSpatialNode (QSSGRenderGraphObject *node)
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
QQuick3DTexture *	lightProbe
CullMode	cullMode
DepthDrawMode	depthDrawMode
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

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
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 26 of file qquick3dmaterial_p.h.

Member Enumeration Documentation

CullMode

enum QQuick3DMaterial::CullMode

Enumerator
BackFaceCulling
FrontFaceCulling
NoCulling

Definition at line 37 of file qquick3dmaterial_p.h.

DepthDrawMode

enum QQuick3DMaterial::DepthDrawMode

Enumerator
OpaqueOnlyDepthDraw
AlwaysDepthDraw
NeverDepthDraw
OpaquePrePassDepthDraw

Definition at line 52 of file qquick3dmaterial_p.h.

TextureChannelMapping

enum QQuick3DMaterial::TextureChannelMapping

Enumerator
R
G
B
A

Definition at line 44 of file qquick3dmaterial_p.h.

Constructor & Destructor Documentation

~QQuick3DMaterial()

QQuick3DMaterial::~QQuick3DMaterial ( )

override

Definition at line 85 of file qquick3dmaterial.cpp.

QQuick3DMaterial()

QT_BEGIN_NAMESPACE QQuick3DMaterial::QQuick3DMaterial ( QQuick3DObjectPrivate &  dd, QQuick3DObject *  parent = nullptr  )

explicitprotected

\qmltype Material \inherits Object3D \inqmlmodule QtQuick3D

Abstract base type providing functionality common to materials.

\qmlproperty Texture Material::lightProbe

This property defines a Texture for overriding or setting an image based lighting Texture for use with this material only.

Note

Setting a light probe on the material will override the \l {SceneEnvironment::lightProbe} {scene's light probe} for models using this material.

This property is ignored when Reflection Probe is used to show reflections on the Model using this material because Reflection Probe uses the \l {SceneEnvironment::lightProbe} {scene's light probe}.

See also

SceneEnvironment::lightProbe

\qmlproperty enumeration Material::cullMode

This property defines whether primitive culling is enabled, and, when enabled, which primitives are discarded.

The default value is Material.BackFaceCulling.

A triangle is considered front-facing if it has a counter-clockwise winding, meaning its vertices in framebuffer coordinates are in counter-clockwise order.

\value Material.BackFaceCulling Back-facing triangles are discarded. \value Material.FrontFaceCulling Front-facing triangles are discarded. \value Material.NoCulling No triangles are discarded.

\qmlproperty enumeration Material::depthDrawMode

This property determines if and when depth rendering takes place for this material. The default behavior when \l {SceneEnvironment::depthTestEnabled} is set to true is that during the main render pass only opaque materials will write to the depth buffer. This property makes it possible to change this behavior to fine tune the rendering of a material.

The default value is Material.OqaqueOnlyDepthDraw

\value Material.OpaqueOnlyDepthDraw Depth rendering is only performed if the material is opaque. \value Material.AlwaysDepthDraw Depth rendering is always performed regardless of the material type. \value Material.NeverDepthDraw Depth rendering is never performed. \value Material.OpaquePrePassDepthDraw Depth rendering is performed in a separate depth pass, but only opaque values are written. This mode also enables transparent materials to be used in combination with shadows.

Note

If \l {SceneEnvironment::depthPrePassEnabled} is set to true then all depth writes will take place as a result of the depth prepass, but it is still necessary to explicitly set Material.OpaquePrePassDepthDraw to only write the opaque fragments in the depth and shadow passes.

Definition at line 82 of file qquick3dmaterial.cpp.

Member Function Documentation

cullMode()

QQuick3DMaterial::CullMode QQuick3DMaterial::cullMode

(

)

const

Definition at line 94 of file qquick3dmaterial.cpp.

cullModeChanged

void QQuick3DMaterial::cullModeChanged ( QQuick3DMaterial::CullMode  cullMode )

signal

Referenced by setCullMode().

Here is the caller graph for this function:

depthDrawMode()

QQuick3DMaterial::DepthDrawMode QQuick3DMaterial::depthDrawMode

(

)

const

Definition at line 99 of file qquick3dmaterial.cpp.

depthDrawModeChanged

void QQuick3DMaterial::depthDrawModeChanged ( QQuick3DMaterial::DepthDrawMode  depthDrawMode )

signal

Referenced by setDepthDrawMode().

Here is the caller graph for this function:

itemChange()

void QQuick3DMaterial::itemChange ( ItemChange  , const ItemChangeData &    )

overrideprotectedvirtual

Reimplemented from QQuick3DObject.

Reimplemented in QQuick3DPrincipledMaterial, and QQuick3DSpecularGlossyMaterial.

Definition at line 179 of file qquick3dmaterial.cpp.

Referenced by QQuick3DCustomMaterial::itemChange().

Here is the caller graph for this function:

lightProbe()

QQuick3DTexture * QQuick3DMaterial::lightProbe

(

)

const

Definition at line 89 of file qquick3dmaterial.cpp.

lightProbeChanged

void QQuick3DMaterial::lightProbeChanged ( QQuick3DTexture *  lightProbe )

signal

Referenced by setLightProbe().

Here is the caller graph for this function:

setCullMode

void QQuick3DMaterial::setCullMode ( QQuick3DMaterial::CullMode  cullMode )

slot

Definition at line 116 of file qquick3dmaterial.cpp.

References cullMode, cullModeChanged(), emit, and QQuick3DObject::update().

Referenced by setMaterialProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

setDepthDrawMode

void QQuick3DMaterial::setDepthDrawMode ( QQuick3DMaterial::DepthDrawMode  depthDrawMode )

slot

Definition at line 126 of file qquick3dmaterial.cpp.

References depthDrawMode, depthDrawModeChanged(), emit, and QQuick3DObject::update().

Here is the call graph for this function:

setLightProbe

void QQuick3DMaterial::setLightProbe ( QQuick3DTexture *  lightProbe )

slot

Definition at line 104 of file qquick3dmaterial.cpp.

References QQuick3DObjectPrivate::attachWatcher(), emit, lightProbeChanged(), setLightProbe(), and QQuick3DObject::update().

Referenced by setLightProbe().

Here is the call graph for this function:

Here is the caller graph for this function:

updateSpatialNode()

QSSGRenderGraphObject * QQuick3DMaterial::updateSpatialNode ( QSSGRenderGraphObject *  node )

overrideprotectedvirtual

Reimplemented from QQuick3DObject.

Reimplemented in QQuick3DPrincipledMaterial, and QQuick3DSpecularGlossyMaterial.

Definition at line 136 of file qquick3dmaterial.cpp.

References DebugViewHelpers::ensureDebugObjectName(), QQuick3DTexture::getRenderImage(), QSSGRenderDefaultMaterial::iblProbe, QSSGRenderCustomMaterial::m_iblProbe, QSSGRenderGraphObject::type, and QQuick3DObject::updateSpatialNode().

Referenced by QQuick3DDefaultMaterial::updateSpatialNode(), QQuick3DPrincipledMaterial::updateSpatialNode(), and QQuick3DSpecularGlossyMaterial::updateSpatialNode().

Here is the call graph for this function:

Here is the caller graph for this function:

Property Documentation

cullMode

CullMode QQuick3DMaterial::cullMode

readwrite

Definition at line 91 of file qquick3dmaterial_p.h.

Referenced by setCullMode().

depthDrawMode

DepthDrawMode QQuick3DMaterial::depthDrawMode

readwrite

Definition at line 91 of file qquick3dmaterial_p.h.

Referenced by setDepthDrawMode().

lightProbe

QQuick3DTexture * QQuick3DMaterial::lightProbe

readwrite

Definition at line 91 of file qquick3dmaterial_p.h.

---

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

• qtquick3d/src/quick3d/qquick3dmaterial_p.h
• qtquick3d/src/quick3d/qquick3dmaterial.cpp