![]() |
Qt 6.x
The Qt SDK
|
#include <qquick3dspotlight_p.h>
Public Member Functions | |
QQuick3DSpotLight (QQuick3DNode *parent=nullptr) | |
\qmltype SpotLight \inherits Light \inqmlmodule QtQuick3D | |
~QQuick3DSpotLight () override | |
float | constantFade () const |
float | linearFade () const |
float | quadraticFade () const |
float | coneAngle () const |
float | innerConeAngle () const |
![]() | |
~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 |
![]() | |
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 |
![]() | |
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 . | |
![]() | |
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 | |
QSSGRenderGraphObject * | updateSpatialNode (QSSGRenderGraphObject *node) override |
![]() | |
QQuick3DAbstractLight (QQuick3DNodePrivate &dd, QQuick3DNode *parent=nullptr) | |
\qmltype Light \inherits Node \inqmlmodule QtQuick3D | |
QSSGRenderGraphObject * | updateSpatialNode (QSSGRenderGraphObject *node) override |
void | markAllDirty () override |
![]() | |
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 |
![]() | |
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 () |
![]() | |
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 | |
float | constantFade |
float | linearFade |
float | quadraticFade |
float | coneAngle |
float | innerConeAngle |
![]() | |
QColor | color |
QColor | ambientColor |
float | brightness |
QQuick3DNode * | scope |
bool | castsShadow |
float | shadowBias |
float | shadowFactor |
QSSGShadowMapQuality | shadowMapQuality |
float | shadowMapFar |
float | shadowFilter |
QSSGBakeMode | bakeMode |
![]() | |
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 |
![]() | |
QQuick3DObject * | parent |
\qmlproperty Object3D QtQuick3D::Object3D::parent This property holds the parent of the Object3D in a 3D scene. | |
![]() | |
QString | objectName |
the name of this object | |
Additional Inherited Members | |
![]() | |
enum class | QSSGShadowMapQuality { ShadowMapQualityLow , ShadowMapQualityMedium , ShadowMapQualityHigh , ShadowMapQualityVeryHigh } |
enum class | QSSGBakeMode { BakeModeDisabled , BakeModeIndirect , BakeModeAll } |
![]() | |
enum | TransformSpace { LocalSpace , ParentSpace , SceneSpace } |
enum | StaticFlags { None } |
![]() | |
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) |
![]() | |
enum class | DirtyFlag { ShadowDirty = (1 << 0) , ColorDirty = (1 << 1) , BrightnessDirty = (1 << 2) , FadeDirty = (1 << 3) , AreaDirty = (1 << 4) , BakeModeDirty = (1 << 5) } |
![]() | |
DirtyFlags | m_dirtyFlags |
![]() | |
QScopedPointer< QObjectData > | d_ptr |
![]() | |
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) | |
Definition at line 22 of file qquick3dspotlight_p.h.
|
explicit |
\qmltype SpotLight \inherits Light \inqmlmodule QtQuick3D
Defines a spot light in the scene.
The spot light emits light towards one direction in a cone shape, which is defined by the \l {coneAngle} property. The light intensity diminishes when approaching the \l {coneAngle}. The angle at which the light intensity starts to diminish is defined by \l {innerConeAngle}. Both angles are defined in degrees.
Inside the \l {innerConeAngle}, the spot light behaves similarly to the point light. There the light intensity diminishes according to inverse-square-law. However, the fade-off (and range) can be controlled with the \l {constantFade}, \l {linearFade}, and \l quadraticFade properties. Light attenuation is calculated using the formula: \l {constantFade} + distance
* (\l {linearFade} * 0.01) + distance
* (\l {quadraticFade} * 0.0001)^2
Let's look at a simple example. Here a SpotLight is placed at 300 on the Z axis, so halfway between the camera and the scene center. By default the light is emitting in the direction of the Z axis. The \l {Light::}{brightness} is increased to 10 to make it look more like a typical spot light.
\qml import QtQuick import QtQuick3D View3D { anchors.fill: parent
PerspectiveCamera { z: 600 }
SpotLight { z: 300 brightness: 10 ambientColor: Qt.rgba(0.1, 0.1, 0.1, 1.0) }
Model { source: "#Rectangle" scale: Qt.vector3d(10, 10, 10) z: -100 materials: PrincipledMaterial { } }
Model { source: "#Sphere" scale: Qt.vector3d(2, 2, 2) materials: PrincipledMaterial { baseColor: "#40c060" roughness: 0.1 } } } \endqml
Rotations happens similarly to \l DirectionalLight. Here we want to light to emit more to the right, so we rotate around the Y axis by -20 degrees. The cone is reduced by setting coneAngle to 30 instead of the default 40. We also make the intensity start diminish earlier, by changing innerConeAngle to 10.
\qml SpotLight { z: 300 brightness: 10 ambientColor: Qt.rgba(0.1, 0.1, 0.1, 1.0) eulerRotation.y: -20 coneAngle: 30 innerConeAngle: 10 } \endqml
For further usage examples, see \l{Qt Quick 3D - Lights Example}.
\qmlproperty real SpotLight::constantFade
This property is constant factor of the attenuation term of the light. The default value is 1.0.
\qmlproperty real SpotLight::linearFade
This property increases the rate at which the lighting effect dims the light in proportion to the distance to the light. The default value is 0.0
, which means the light doesn't have linear fade. The value used here is multiplied by 0.01
before being used to calculate light attenuation.
\qmlproperty real SpotLight::quadraticFade
This property increases the rate at which the lighting effect dims the light in proportion to the inverse square law. The default value is 1.0, which means the spot light fade exactly follows the inverse square law, i.e. when distance to an object doubles the light intensity decreases to 1/4th. The value used here is multiplied by 0.0001
before being used to calculate light attenuation.
\qmlproperty real SpotLight::coneAngle
This property defines the cut-off angle (from edge to edge) beyond which the light doesn't affect the scene. Defined in degrees between 0 and 180. The default value is 40.
\qmlproperty real SpotLight::innerConeAngle
This property defines the angle (from edge to edge) at which the light intensity starts to gradually diminish as it approaches \l {coneAngle}. Defined in degrees between 0 and 180. If the value is set larger than \l {coneAngle}, it'll behave as if it had the same value as \l {coneAngle}. The default value is 30.
Definition at line 136 of file qquick3dspotlight.cpp.
|
inlineoverride |
Definition at line 35 of file qquick3dspotlight_p.h.
float QQuick3DSpotLight::coneAngle | ( | ) | const |
Definition at line 154 of file qquick3dspotlight.cpp.
|
signal |
float QQuick3DSpotLight::constantFade | ( | ) | const |
Definition at line 139 of file qquick3dspotlight.cpp.
|
signal |
float QQuick3DSpotLight::innerConeAngle | ( | ) | const |
Definition at line 159 of file qquick3dspotlight.cpp.
|
signal |
float QQuick3DSpotLight::linearFade | ( | ) | const |
Definition at line 144 of file qquick3dspotlight.cpp.
|
signal |
float QQuick3DSpotLight::quadraticFade | ( | ) | const |
Definition at line 149 of file qquick3dspotlight.cpp.
|
signal |
|
slot |
Definition at line 197 of file qquick3dspotlight.cpp.
References QQuick3DAbstractLight::AreaDirty, coneAngle, coneAngleChanged(), emit, QQuick3DAbstractLight::m_dirtyFlags, qFuzzyCompare(), and QQuick3DObject::update().
Referenced by setLightProperties().
|
slot |
Definition at line 164 of file qquick3dspotlight.cpp.
References constantFade, constantFadeChanged(), emit, QQuick3DAbstractLight::FadeDirty, QQuick3DAbstractLight::m_dirtyFlags, qFuzzyCompare(), and QQuick3DObject::update().
Referenced by setLightProperties().
|
slot |
Definition at line 213 of file qquick3dspotlight.cpp.
References QQuick3DAbstractLight::AreaDirty, emit, innerConeAngle, innerConeAngleChanged(), QQuick3DAbstractLight::m_dirtyFlags, qFuzzyCompare(), and QQuick3DObject::update().
Referenced by setLightProperties().
|
slot |
Definition at line 175 of file qquick3dspotlight.cpp.
References emit, QQuick3DAbstractLight::FadeDirty, linearFade, linearFadeChanged(), QQuick3DAbstractLight::m_dirtyFlags, qFuzzyCompare(), and QQuick3DObject::update().
Referenced by setLightProperties().
|
slot |
Definition at line 186 of file qquick3dspotlight.cpp.
References emit, QQuick3DAbstractLight::FadeDirty, QQuick3DAbstractLight::m_dirtyFlags, qFuzzyCompare(), quadraticFade, quadraticFadeChanged(), and QQuick3DObject::update().
Referenced by setLightProperties().
|
overrideprotectedvirtual |
Reimplemented from QQuick3DAbstractLight.
Definition at line 229 of file qquick3dspotlight.cpp.
References QQuick3DAbstractLight::AreaDirty, QQuick3DAbstractLight::FadeDirty, QSSGRenderLight::m_coneAngle, QSSGRenderLight::m_constantFade, QQuick3DAbstractLight::m_dirtyFlags, QSSGRenderLight::m_innerConeAngle, QSSGRenderLight::m_linearFade, QSSGRenderLight::m_quadraticFade, QQuick3DAbstractLight::markAllDirty(), qBound(), and QQuick3DAbstractLight::updateSpatialNode().
|
readwrite |
Definition at line 68 of file qquick3dspotlight_p.h.
Referenced by setConeAngle().
|
readwrite |
Definition at line 68 of file qquick3dspotlight_p.h.
Referenced by setConstantFade().
|
readwrite |
Definition at line 68 of file qquick3dspotlight_p.h.
Referenced by setInnerConeAngle().
|
readwrite |
Definition at line 68 of file qquick3dspotlight_p.h.
Referenced by setLinearFade().
|
readwrite |
Definition at line 68 of file qquick3dspotlight_p.h.
Referenced by setQuadraticFade().