#include <qquick3ddirectionallight_p.h>

Inheritance diagram for QQuick3DDirectionalLight:

Collaboration diagram for QQuick3DDirectionalLight:

Public Member Functions
	QQuick3DDirectionalLight (QQuick3DNode *parent=nullptr)
	\qmltype DirectionalLight \inherits Light \inqmlmodule QtQuick3D

	~QQuick3DDirectionalLight () override

Public Member Functions inherited from QQuick3DAbstractLight
	~QQuick3DAbstractLight () override

QColor	color () const

QColor	ambientColor () const

float	brightness () const

QQuick3DNode *	scope () const

bool	castsShadow () const

float	shadowBias () const

float	shadowFactor () const

QSSGShadowMapQuality	shadowMapQuality () const

float	shadowMapFar () const

float	shadowFilter () const

QSSGBakeMode	bakeMode () const

Public Member Functions inherited from QQuick3DNode
	QQuick3DNode (QQuick3DNode *parent=nullptr)
	\qmltype Node \inherits Object3D \inqmlmodule QtQuick3D

	~QQuick3DNode () override

float	x () const
	\qmlproperty real QtQuick3D::Node::x

float	y () const
	\qmlproperty real QtQuick3D::Node::y

float	z () const
	\qmlproperty real QtQuick3D::Node::z

QQuaternion	rotation () const
	\qmlproperty quaternion QtQuick3D::Node::rotation

QVector3D	eulerRotation () const
	\qmlproperty vector3d QtQuick3D::Node::eulerRotation

QVector3D	position () const
	\qmlproperty vector3d QtQuick3D::Node::position

QVector3D	scale () const
	\qmlproperty vector3d QtQuick3D::Node::scale

QVector3D	pivot () const
	\qmlproperty vector3d QtQuick3D::Node::pivot

float	localOpacity () const
	\qmlproperty real QtQuick3D::Node::opacity

bool	visible () const
	\qmlproperty bool QtQuick3D::Node::visible

int	staticFlags () const
	\qmlproperty int QtQuick3D::Node::staticFlags

QQuick3DNode *	parentNode () const

QVector3D	forward () const
	\qmlproperty vector3d QtQuick3D::Node::forward \readonly

QVector3D	up () const
	\qmlproperty vector3d QtQuick3D::Node::up \readonly

QVector3D	right () const
	\qmlproperty vector3d QtQuick3D::Node::right \readonly

QVector3D	scenePosition () const
	\qmlproperty vector3d QtQuick3D::Node::scenePosition \readonly

QQuaternion	sceneRotation () const
	\qmlproperty quaternion QtQuick3D::Node::sceneRotation \readonly

QVector3D	sceneScale () const
	\qmlproperty vector3d QtQuick3D::Node::sceneScale \readonly

QMatrix4x4	sceneTransform () const
	\qmlproperty matrix4x4 QtQuick3D::Node::sceneTransform \readonly

Q_INVOKABLE void	rotate (qreal degrees, const QVector3D &axis, QQuick3DNode::TransformSpace space)
	\qmlmethod QtQuick3D::Node::rotate(real degrees, vector3d axis, enumeration space)

Q_INVOKABLE QVector3D	mapPositionToScene (const QVector3D &localPosition) const
	\qmlmethod vector3d QtQuick3D::Node::mapPositionToScene(vector3d localPosition)

Q_INVOKABLE QVector3D	mapPositionFromScene (const QVector3D &scenePosition) const
	\qmlmethod vector3d QtQuick3D::Node::mapPositionFromScene(vector3d scenePosition)

Q_INVOKABLE QVector3D	mapPositionToNode (const QQuick3DNode *node, const QVector3D &localPosition) const
	\qmlmethod vector3d QtQuick3D::Node::mapPositionToNode(QtQuick3D::Node node, vector3d localPosition)

Q_INVOKABLE QVector3D	mapPositionFromNode (const QQuick3DNode *node, const QVector3D &localPosition) const
	\qmlmethod vector3d QtQuick3D::Node::mapPositionFromNode(QtQuick3D::Node node, vector3d localPosition)

Q_INVOKABLE QVector3D	mapDirectionToScene (const QVector3D &localDirection) const
	\qmlmethod vector3d QtQuick3D::Node::mapDirectionToScene(vector3d localDirection)

Q_INVOKABLE QVector3D	mapDirectionFromScene (const QVector3D &sceneDirection) const
	\qmlmethod vector3d QtQuick3D::Node::mapDirectionFromScene(vector3d sceneDirection)

Q_INVOKABLE QVector3D	mapDirectionToNode (const QQuick3DNode *node, const QVector3D &localDirection) const
	\qmlmethod vector3d QtQuick3D::Node::mapDirectionToNode(QtQuick3D::Node node, vector3d localDirection)

Q_INVOKABLE QVector3D	mapDirectionFromNode (const QQuick3DNode *node, const QVector3D &localDirection) const
	\qmlmethod vector3d QtQuick3D::Node::mapDirectionFromNode(QtQuick3D::Node node, vector3d localDirection)

void	markAllDirty () 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< 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 ()

Protected Member Functions
QSSGRenderGraphObject *	updateSpatialNode (QSSGRenderGraphObject *node) override

Protected Member Functions inherited from QQuick3DAbstractLight
	QQuick3DAbstractLight (QQuick3DNodePrivate &dd, QQuick3DNode *parent=nullptr)
	\qmltype Light \inherits Node \inqmlmodule QtQuick3D

void	markAllDirty () override

Protected Member Functions inherited from QQuick3DNode
void	connectNotify (const QMetaMethod &signal) override

void	disconnectNotify (const QMetaMethod &signal) override

void	componentComplete () override
	Invoked after the root component that caused this instantiation has completed construction.

	QQuick3DNode (QQuick3DNodePrivate &dd, QQuick3DNode *parent=nullptr)

QSSGRenderGraphObject *	updateSpatialNode (QSSGRenderGraphObject *node) override

virtual void	itemChange (ItemChange, const ItemChangeData &) override

Protected Member Functions inherited from QQuick3DObject
	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.

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Additional Inherited Members
Public Types inherited from QQuick3DAbstractLight
enum class	QSSGShadowMapQuality { ShadowMapQualityLow , ShadowMapQualityMedium , ShadowMapQualityHigh , ShadowMapQualityVeryHigh }

enum class	QSSGBakeMode { BakeModeDisabled , BakeModeIndirect , BakeModeAll }

Public Types inherited from QQuick3DNode
enum	TransformSpace { LocalSpace , ParentSpace , SceneSpace }

enum	StaticFlags { None }

Public Slots inherited from QQuick3DAbstractLight
void	setColor (const QColor &color)

void	setAmbientColor (const QColor &ambientColor)

void	setBrightness (float brightness)

void	setScope (QQuick3DNode *scope)

void	setCastsShadow (bool castsShadow)

void	setShadowBias (float shadowBias)

void	setShadowFactor (float shadowFactor)

void	setShadowMapQuality (QQuick3DAbstractLight::QSSGShadowMapQuality shadowMapQuality)

void	setShadowMapFar (float shadowMapFar)

void	setShadowFilter (float shadowFilter)

void	setBakeMode (QQuick3DAbstractLight::QSSGBakeMode bakeMode)

Public Slots inherited from QQuick3DNode
void	setX (float x)

void	setY (float y)

void	setZ (float z)

void	setRotation (const QQuaternion &rotation)

void	setEulerRotation (const QVector3D &eulerRotation)

void	setPosition (const QVector3D &position)

void	setScale (const QVector3D &scale)

void	setPivot (const QVector3D &pivot)

void	setLocalOpacity (float opacity)

void	setVisible (bool visible)

void	setStaticFlags (int staticFlags)

Public Slots inherited from QQuick3DObject
void	update ()

void	setParentItem (QQuick3DObject *parentItem)

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals inherited from QQuick3DAbstractLight
void	colorChanged ()

void	ambientColorChanged ()

void	brightnessChanged ()

void	scopeChanged ()

void	castsShadowChanged ()

void	shadowBiasChanged ()

void	shadowFactorChanged ()

void	shadowMapQualityChanged ()

void	shadowMapFarChanged ()

void	shadowFilterChanged ()

void	bakeModeChanged ()

Signals inherited from QQuick3DNode
void	xChanged ()

void	yChanged ()

void	zChanged ()

void	rotationChanged ()

void	eulerRotationChanged ()

void	positionChanged ()

void	scaleChanged ()

void	pivotChanged ()

void	localOpacityChanged ()

void	visibleChanged ()

void	forwardChanged ()

void	upChanged ()

void	rightChanged ()

void	sceneTransformChanged ()

void	scenePositionChanged ()

void	sceneRotationChanged ()

void	sceneScaleChanged ()

void	staticFlagsChanged ()

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.

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 Types inherited from QQuick3DAbstractLight
enum class	DirtyFlag { ShadowDirty = (1 << 0) , ColorDirty = (1 << 1) , BrightnessDirty = (1 << 2) , FadeDirty = (1 << 3) , AreaDirty = (1 << 4) , BakeModeDirty = (1 << 5) }

Protected Attributes inherited from QQuick3DAbstractLight
DirtyFlags	m_dirtyFlags

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties inherited from QQuick3DAbstractLight
QColor	color

QColor	ambientColor

float	brightness

QQuick3DNode *	scope

bool	castsShadow

float	shadowBias

float	shadowFactor

QSSGShadowMapQuality	shadowMapQuality

float	shadowMapFar

float	shadowFilter

QSSGBakeMode	bakeMode

Properties inherited from QQuick3DNode
float	x

float	y

float	z

QQuaternion	rotation

QVector3D	eulerRotation

QVector3D	position

QVector3D	scale

QVector3D	pivot

float	opacity

bool	visible

QVector3D	forward

QVector3D	up

QVector3D	right

QVector3D	scenePosition

QQuaternion	sceneRotation

QVector3D	sceneScale

QMatrix4x4	sceneTransform

int	staticFlags

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

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 24 of file qquick3ddirectionallight_p.h.

Constructor & Destructor Documentation

◆ QQuick3DDirectionalLight()

QT_BEGIN_NAMESPACE QQuick3DDirectionalLight::QQuick3DDirectionalLight ( QQuick3DNode * parent = nullptr )

explicit

\qmltype DirectionalLight \inherits Light \inqmlmodule QtQuick3D

Defines a directional light in the scene.

The directional light emits light in one direction from an unidentifiable source located infinitely far away. This is similar to the way sunlight works in real life. A directional light has infinite range and does not diminish.

If \l {Light::castsShadow}{castsShadow} is enabled, shadows will be parallel to the light direction.

A directional light effectively have no position, so moving it does not have any effect. The light will always be emitted in the direction of the light's Z axis.

Rotating the light along its X or Y axis will change the direction of the light emission.

Scaling a directional light will only have an effect in the following cases: \list

If Z scale is set to a negative number, the light will be emitted in the opposite direction.
If the scale of any axis is set to 0, the light will be emitted along the world's Z axis.
Note
Rotating the light will then have no effect. \endlist
Let's look at a simple example:

\qml import QtQuick import QtQuick3D View3D { anchors.fill: parent

PerspectiveCamera { z: 600 }

DirectionalLight { }

Model { source: "#Sphere" scale: Qt.vector3d(4, 4, 4) materials: PrincipledMaterial { baseColor: "#40c060" roughness: 0.1 // make specular highlight visible } } } \endqml

Here the DirectionalLight uses the default white color, emitting in the direction of the DirectionalLight node's Z axis.

Rotating 60 degrees around the X axis would lead to the following. Instead of emitting straight in the direction of the Z axis, the light is now pointing 60 degrees "down":

\qml DirectionalLight { eulerRotation.x: 60 } \endqml

For further usage examples, see \l{Qt Quick 3D - Lights Example}.