QQuick3DAbstractLight Class Reference

#include <qquick3dabstractlight_p.h>

Inheritance diagram for QQuick3DAbstractLight:

Collaboration diagram for QQuick3DAbstractLight:

Public Types
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
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
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.

Public Member Functions
	~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.
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 Types
enum class	DirtyFlag {   ShadowDirty = (1 << 0) , ColorDirty = (1 << 1) , BrightnessDirty = (1 << 2) , FadeDirty = (1 << 3) ,   AreaDirty = (1 << 4) , BakeModeDirty = (1 << 5) }

Protected Member Functions
	QQuick3DAbstractLight (QQuick3DNodePrivate &dd, QQuick3DNode *parent=nullptr)
	\qmltype Light \inherits Node \inqmlmodule QtQuick3D
QSSGRenderGraphObject *	updateSpatialNode (QSSGRenderGraphObject *node) override
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
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)

Protected Attributes
DirtyFlags	m_dirtyFlags
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties
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

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)
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 qquick3dabstractlight_p.h.

Member Enumeration Documentation

DirtyFlag

enum class QQuick3DAbstractLight::DirtyFlag

strongprotected

Enumerator
ShadowDirty
ColorDirty
BrightnessDirty
FadeDirty
AreaDirty
BakeModeDirty

Definition at line 103 of file qquick3dabstractlight_p.h.

QSSGBakeMode

enum class QQuick3DAbstractLight::QSSGBakeMode

strong

Enumerator
BakeModeDisabled
BakeModeIndirect
BakeModeAll

Definition at line 52 of file qquick3dabstractlight_p.h.

QSSGShadowMapQuality

enum class QQuick3DAbstractLight::QSSGShadowMapQuality

strong

Enumerator
ShadowMapQualityLow
ShadowMapQualityMedium
ShadowMapQualityHigh
ShadowMapQualityVeryHigh

Definition at line 44 of file qquick3dabstractlight_p.h.

Constructor & Destructor Documentation

~QQuick3DAbstractLight()

QQuick3DAbstractLight::~QQuick3DAbstractLight ( )

override

Definition at line 160 of file qquick3dabstractlight.cpp.

QQuick3DAbstractLight()

QT_BEGIN_NAMESPACE QQuick3DAbstractLight::QQuick3DAbstractLight ( QQuick3DNodePrivate &  dd, QQuick3DNode *  parent = nullptr  )

explicitprotected

\qmltype Light \inherits Node \inqmlmodule QtQuick3D

An uncreatable abstract base type for all lights.

Light itself is an uncreatable base for all of its subtypes. The subtypes provide multiple options to determine the style of the light.

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

See also

DirectionalLight, PointLight

\qmlproperty color Light::color This property defines the color applied to models illuminated by this light. The default value is white, rgb(255, 255, 255).

\qmlproperty color Light::ambientColor The property defines the ambient color applied to materials before being lit by this light. The default value is black, rgb(0, 0, 0).

\qmlproperty real Light::brightness This property defines an overall multiplier for this light’s effects. The default value is 1.

\qmlproperty Node Light::scope

The property allows the selection of a Node in the scene. Only that node and its children are affected by this light. By default the value is null, which indicates no scope selected.

Note

Scoped lights cannot cast real-time shadows, meaning a Light with a scope set should not set \l castsShadow to true. They can however generate baked shadows when \l bakeMode is set to Light.BakeModeAll.

\qmlproperty bool Light::castsShadow

When this property is enabled, the light will cast (real-time) shadows. The default value is false.

Note

When \l bakeMode is set to Light.BakeModeAll, this property has no effect. A fully baked light always has baked shadows, but it will never participate in real-time shadow mapping.

\qmlproperty real Light::shadowBias This property is used to tweak the shadowing effect when objects are casting shadows on themselves. The value range is [-1.0, 1.0]. Generally, a value inside [-0.1, 0.1] is sufficient. The default value is 0.

\qmlproperty real Light::shadowFactor This property determines how dark the cast shadows should be. The value range is [0, 100], where 0 means no shadows and 100 means the light is fully shadowed. The default value is 5.

\qmlproperty enumeration Light::shadowMapQuality The property sets the quality of the shadow map created for shadow rendering. Lower quality uses less resources, but produces lower quality shadows while higher quality uses more resources, but produces better quality shadows.

Supported quality values are: \value Light.ShadowMapQualityLow Render shadowmap using 256x256 texture. \value Light.ShadowMapQualityMedium Render shadowmap using 512x512 texture. \value Light.ShadowMapQualityHigh Render shadowmap using 1024x1024 texture. \value Light.ShadowMapQualityVeryHigh Render shadowmap using 2048x2048 texture.

The default value is Light.ShadowMapQualityLow

\qmlproperty real Light::shadowMapFar The property determines the maximum distance for the shadow map. Smaller values improve the precision and effects of the map. The default value is 5000. Unit is points in local coordinate space.

\qmlproperty real Light::shadowFilter This property sets how much blur is applied to the shadows. The default value is 5.

\qmlproperty enumeration Light::bakeMode The property controls if the light is active in baked lighting, such as when generating lightmaps.

\value Light.BakeModeDisabled The light is not used in baked lighting.

\value Light.BakeModeIndirect Indirect lighting contribution (for global illumination) is baked for this light. Direct lighting (diffuse, specular, real-time shadow mapping) is calculated normally for the light at run time. At run time, when not in baking mode, the renderer will attempt to sample the lightmap to get the indirect lighting data and combine that with the results of the real-time calculations.

\value Light.BakeModeAll Both direct (diffuse, shadow) and indirect lighting is baked for this light. The light will not have a specular contribution and will not generate realtime shadow maps, but it will always have baked shadows. At run time, when not in baking mode, the renderer will attempt to sample the lightmap in place of the standard, real-time calculations for diffuse lighting and shadow mapping.

The default value is Light.BakeModeDisabled

Note

Just as with \l Model::usedInBakedLighting, designers and developers must always evaluate on a per-light basis if the light is suitable to take part in baked lighting.

Warning

Lights with dynamically changing properties, for example, animated position, rotation, or other properties, are not suitable for participating in baked lighting.

This property is relevant both when baking and when using lightmaps. A consistent state between the baking run and the subsequent runs that use the generated data is essential. Changing to a different value will not change the previously generated and persistently stored data in the lightmaps, the engine's rendering behavior will however follow the property's current value.

For more information on how to bake lightmaps, see the \l {Lightmaps and Global Illumination}.

See also

Model::usedInBakedLighting, Model::bakedLightmap, Lightmapper, {Lightmaps and Global Illumination}

Definition at line 155 of file qquick3dabstractlight.cpp.

Member Function Documentation

ambientColor()

QColor QQuick3DAbstractLight::ambientColor

(

)

const

Definition at line 167 of file qquick3dabstractlight.cpp.

ambientColorChanged

void QQuick3DAbstractLight::ambientColorChanged ( )

signal

Referenced by setAmbientColor().

Here is the caller graph for this function:

bakeMode()

QQuick3DAbstractLight::QSSGBakeMode QQuick3DAbstractLight::bakeMode

(

)

const

Definition at line 212 of file qquick3dabstractlight.cpp.

bakeModeChanged

void QQuick3DAbstractLight::bakeModeChanged ( )

signal

Referenced by setBakeMode().

Here is the caller graph for this function:

brightness()

float QQuick3DAbstractLight::brightness

(

)

const

Definition at line 172 of file qquick3dabstractlight.cpp.

brightnessChanged

void QQuick3DAbstractLight::brightnessChanged ( )

signal

Referenced by setBrightness().

Here is the caller graph for this function:

castsShadow()

bool QQuick3DAbstractLight::castsShadow

(

)

const

Definition at line 182 of file qquick3dabstractlight.cpp.

castsShadowChanged

void QQuick3DAbstractLight::castsShadowChanged ( )

signal

Referenced by setCastsShadow().

Here is the caller graph for this function:

color()

QColor QQuick3DAbstractLight::color

(

)

const

Definition at line 162 of file qquick3dabstractlight.cpp.

colorChanged

void QQuick3DAbstractLight::colorChanged ( )

signal

Referenced by setColor().

Here is the caller graph for this function:

markAllDirty()

void QQuick3DAbstractLight::markAllDirty ( )

overrideprotectedvirtual

Reimplemented from QQuick3DObject.

Definition at line 217 of file qquick3dabstractlight.cpp.

References AreaDirty, BakeModeDirty, BrightnessDirty, ColorDirty, FadeDirty, m_dirtyFlags, QQuick3DNode::markAllDirty(), and ShadowDirty.

Referenced by QQuick3DDirectionalLight::updateSpatialNode(), QQuick3DPointLight::updateSpatialNode(), and QQuick3DSpotLight::updateSpatialNode().

Here is the call graph for this function:

Here is the caller graph for this function:

scope()

QQuick3DNode * QQuick3DAbstractLight::scope

(

)

const

Definition at line 177 of file qquick3dabstractlight.cpp.

scopeChanged

void QQuick3DAbstractLight::scopeChanged ( )

signal

Referenced by setScope().

Here is the caller graph for this function:

setAmbientColor

void QQuick3DAbstractLight::setAmbientColor ( const QColor &  ambientColor )

slot

Definition at line 239 of file qquick3dabstractlight.cpp.

References ambientColor, ambientColorChanged(), ColorDirty, emit, m_dirtyFlags, and QQuick3DObject::update().

Referenced by setLightProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

setBakeMode

void QQuick3DAbstractLight::setBakeMode ( QQuick3DAbstractLight::QSSGBakeMode  bakeMode )

slot

Definition at line 318 of file qquick3dabstractlight.cpp.

References bakeMode, bakeModeChanged(), BakeModeDirty, emit, m_dirtyFlags, and QQuick3DObject::update().

Here is the call graph for this function:

setBrightness

void QQuick3DAbstractLight::setBrightness ( float  brightness )

slot

Definition at line 250 of file qquick3dabstractlight.cpp.

References brightness, brightnessChanged(), BrightnessDirty, emit, m_dirtyFlags, qFuzzyCompare(), and QQuick3DObject::update().

Referenced by setLightProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

setCastsShadow

void QQuick3DAbstractLight::setCastsShadow ( bool  castsShadow )

slot

Definition at line 271 of file qquick3dabstractlight.cpp.

References castsShadow, castsShadowChanged(), emit, m_dirtyFlags, ShadowDirty, and QQuick3DObject::update().

Here is the call graph for this function:

setColor

void QQuick3DAbstractLight::setColor ( const QColor &  color )

slot

Definition at line 228 of file qquick3dabstractlight.cpp.

References color, colorChanged(), ColorDirty, emit, m_dirtyFlags, and QQuick3DObject::update().

Referenced by setLightProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

setScope

void QQuick3DAbstractLight::setScope ( QQuick3DNode *  scope )

slot

Definition at line 261 of file qquick3dabstractlight.cpp.

References emit, scope, scopeChanged(), and QQuick3DObject::update().

Here is the call graph for this function:

setShadowBias

void QQuick3DAbstractLight::setShadowBias ( float  shadowBias )

slot

Definition at line 282 of file qquick3dabstractlight.cpp.

References emit, m_dirtyFlags, qBound(), qFuzzyCompare(), shadowBias, shadowBiasChanged(), ShadowDirty, and QQuick3DObject::update().

Here is the call graph for this function:

setShadowFactor

void QQuick3DAbstractLight::setShadowFactor ( float  shadowFactor )

slot

Definition at line 294 of file qquick3dabstractlight.cpp.

References emit, m_dirtyFlags, qBound(), qFuzzyCompare(), ShadowDirty, shadowFactor, shadowFactorChanged(), and QQuick3DObject::update().

Here is the call graph for this function:

setShadowFilter

void QQuick3DAbstractLight::setShadowFilter ( float  shadowFilter )

slot

Definition at line 340 of file qquick3dabstractlight.cpp.

References emit, m_dirtyFlags, qFuzzyCompare(), ShadowDirty, shadowFilter, shadowFilterChanged(), and QQuick3DObject::update().

Here is the call graph for this function:

setShadowMapFar

void QQuick3DAbstractLight::setShadowMapFar ( float  shadowMapFar )

slot

Definition at line 329 of file qquick3dabstractlight.cpp.

References emit, m_dirtyFlags, qFuzzyCompare(), ShadowDirty, shadowMapFar, shadowMapFarChanged(), and QQuick3DObject::update().

Here is the call graph for this function:

setShadowMapQuality

void QQuick3DAbstractLight::setShadowMapQuality ( QQuick3DAbstractLight::QSSGShadowMapQuality  shadowMapQuality )

slot

Definition at line 306 of file qquick3dabstractlight.cpp.

References emit, m_dirtyFlags, ShadowDirty, shadowMapQuality, shadowMapQualityChanged(), and QQuick3DObject::update().

Here is the call graph for this function:

shadowBias()

float QQuick3DAbstractLight::shadowBias

(

)

const

Definition at line 187 of file qquick3dabstractlight.cpp.

shadowBiasChanged

void QQuick3DAbstractLight::shadowBiasChanged ( )

signal

Referenced by setShadowBias().

Here is the caller graph for this function:

shadowFactor()

float QQuick3DAbstractLight::shadowFactor

(

)

const

Definition at line 192 of file qquick3dabstractlight.cpp.

shadowFactorChanged

void QQuick3DAbstractLight::shadowFactorChanged ( )

signal

Referenced by setShadowFactor().

Here is the caller graph for this function:

shadowFilter()

float QQuick3DAbstractLight::shadowFilter

(

)

const

Definition at line 207 of file qquick3dabstractlight.cpp.

shadowFilterChanged

void QQuick3DAbstractLight::shadowFilterChanged ( )

signal

Referenced by setShadowFilter().

Here is the caller graph for this function:

shadowMapFar()

float QQuick3DAbstractLight::shadowMapFar

(

)

const

Definition at line 202 of file qquick3dabstractlight.cpp.

shadowMapFarChanged

void QQuick3DAbstractLight::shadowMapFarChanged ( )

signal

Referenced by setShadowMapFar().

Here is the caller graph for this function:

shadowMapQuality()

QQuick3DAbstractLight::QSSGShadowMapQuality QQuick3DAbstractLight::shadowMapQuality

(

)

const

Definition at line 197 of file qquick3dabstractlight.cpp.

shadowMapQualityChanged

void QQuick3DAbstractLight::shadowMapQualityChanged ( )

signal

Referenced by setShadowMapQuality().

Here is the caller graph for this function:

updateSpatialNode()

QSSGRenderGraphObject * QQuick3DAbstractLight::updateSpatialNode ( QSSGRenderGraphObject *  node )

overrideprotectedvirtual

Reimplemented from QQuick3DObject.

Reimplemented in QQuick3DDirectionalLight, QQuick3DPointLight, and QQuick3DSpotLight.

Definition at line 366 of file qquick3dabstractlight.cpp.

References BakeModeAll, BakeModeDirty, BakeModeDisabled, BrightnessDirty, ColorDirty, QQuick3DObjectPrivate::get(), QSSGRenderLight::LightDirty, QSSGRenderLight::m_ambientColor, QSSGRenderLight::m_bakingEnabled, QSSGRenderLight::m_brightness, QSSGRenderLight::m_castShadow, QSSGRenderLight::m_diffuseColor, m_dirtyFlags, QSSGRenderLight::m_fullyBaked, QSSGRenderLight::m_scope, QSSGRenderLight::m_shadowBias, QSSGRenderLight::m_shadowFactor, QSSGRenderLight::m_shadowFilter, QSSGRenderLight::m_shadowMapFar, QSSGRenderLight::m_shadowMapRes, QSSGRenderLight::m_specularColor, QSSGRenderLight::markDirty(), Q_ASSERT_X, ShadowDirty, QQuick3DObjectPrivate::spatialNode, QVector4D::toVector3D(), and QQuick3DNode::updateSpatialNode().

Referenced by QQuick3DDirectionalLight::updateSpatialNode(), QQuick3DPointLight::updateSpatialNode(), and QQuick3DSpotLight::updateSpatialNode().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_dirtyFlags

DirtyFlags QQuick3DAbstractLight::m_dirtyFlags

protected

Initial value:

= DirtyFlags(DirtyFlag::ShadowDirty)
                              | DirtyFlags(DirtyFlag::ColorDirty)
                              | DirtyFlags(DirtyFlag::BrightnessDirty)
                              | DirtyFlags(DirtyFlag::FadeDirty)
                              | DirtyFlags(DirtyFlag::AreaDirty)

Definition at line 113 of file qquick3dabstractlight_p.h.

Referenced by markAllDirty(), setAmbientColor(), setBakeMode(), setBrightness(), setCastsShadow(), setColor(), QQuick3DSpotLight::setConeAngle(), QQuick3DPointLight::setConstantFade(), QQuick3DSpotLight::setConstantFade(), QQuick3DSpotLight::setInnerConeAngle(), QQuick3DPointLight::setLinearFade(), QQuick3DSpotLight::setLinearFade(), QQuick3DPointLight::setQuadraticFade(), QQuick3DSpotLight::setQuadraticFade(), setShadowBias(), setShadowFactor(), setShadowFilter(), setShadowMapFar(), setShadowMapQuality(), updateSpatialNode(), QQuick3DPointLight::updateSpatialNode(), and QQuick3DSpotLight::updateSpatialNode().

Property Documentation

ambientColor

QColor QQuick3DAbstractLight::ambientColor

readwrite

Definition at line 134 of file qquick3dabstractlight_p.h.

Referenced by setAmbientColor().

bakeMode

QSSGBakeMode QQuick3DAbstractLight::bakeMode

readwrite

Definition at line 134 of file qquick3dabstractlight_p.h.

Referenced by setBakeMode().

brightness

float QQuick3DAbstractLight::brightness

readwrite

Definition at line 134 of file qquick3dabstractlight_p.h.

Referenced by setBrightness().

castsShadow

bool QQuick3DAbstractLight::castsShadow

readwrite

Definition at line 134 of file qquick3dabstractlight_p.h.

Referenced by setCastsShadow().

color

QColor QQuick3DAbstractLight::color

readwrite

Definition at line 134 of file qquick3dabstractlight_p.h.

Referenced by setColor().

scope

QQuick3DNode * QQuick3DAbstractLight::scope

readwrite

Definition at line 134 of file qquick3dabstractlight_p.h.

Referenced by setScope().

shadowBias

float QQuick3DAbstractLight::shadowBias

readwrite

Definition at line 134 of file qquick3dabstractlight_p.h.

Referenced by setShadowBias().

shadowFactor

float QQuick3DAbstractLight::shadowFactor

readwrite

Definition at line 134 of file qquick3dabstractlight_p.h.

Referenced by setShadowFactor().

shadowFilter

float QQuick3DAbstractLight::shadowFilter

readwrite

Definition at line 134 of file qquick3dabstractlight_p.h.

Referenced by setShadowFilter().

shadowMapFar

float QQuick3DAbstractLight::shadowMapFar

readwrite

Definition at line 134 of file qquick3dabstractlight_p.h.

Referenced by setShadowMapFar().

shadowMapQuality

QSSGShadowMapQuality QQuick3DAbstractLight::shadowMapQuality

readwrite

Definition at line 134 of file qquick3dabstractlight_p.h.

Referenced by setShadowMapQuality().

---

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

• qtquick3d/src/quick3d/qquick3dabstractlight_p.h
• qtquick3d/src/quick3d/qquick3dabstractlight.cpp