QSpotLight#

Encapsulate a Spot Light object in a Qt 3D scene. More

Inheritance diagram of PySide6.Qt3DRender.Qt3DRender.QSpotLight

Synopsis#

Properties#

Functions#

Slots#

Signals#

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

A spotlight is a light source that emits a cone of light in a particular direction.

A spotlight uses three attenuation factors to describe how the intensity of the light decreases over distance. These factors are designed to be used together in calcuating total attenuation. For the materials in Qt3D Extras the following formula is used, where distance is the distance from the light to the surface being rendered:

totalAttenuation = 1.0 / (constantAttenuation + (linearAttenuation * distance) + (quadraticAttenuation * distance * distance));

Custom materials may choose to interpret these factors differently.

class PySide6.Qt3DRender.Qt3DRender.QSpotLight([parent=None])#
Parameters:

parentPySide6.Qt3DCore.Qt3DCore.QNode

Constructs a new QSpotLight with the specified parent.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property PᅟySide6.Qt3DRender.Qt3DRender.QSpotLight.constantAttenuation: float#

Specifies the constant attenuation of the spot light.

Note

The exact meaning and use of this property is up to the material implementation.

Access functions:
property PᅟySide6.Qt3DRender.Qt3DRender.QSpotLight.cutOffAngle: float#

Specifies the cut off angle of the spot light.

Note

The exact meaning and use of this property is up to the material implementation.

Access functions:
property PᅟySide6.Qt3DRender.Qt3DRender.QSpotLight.linearAttenuation: float#

Specifies the linear attenuation of the spot light.

Note

The exact meaning and use of this property is up to the material implementation.

Access functions:
property PᅟySide6.Qt3DRender.Qt3DRender.QSpotLight.localDirection: PySide6.QtGui.QVector3D#

Specifies the local direction of the spot light.

Note

The exact meaning and use of this property is up to the material implementation.

Access functions:
property PᅟySide6.Qt3DRender.Qt3DRender.QSpotLight.quadraticAttenuation: float#

Specifies the quadratic attenuation of the spot light.

Note

The exact meaning and use of this property is up to the material implementation.

Access functions:
PySide6.Qt3DRender.Qt3DRender.QSpotLight.constantAttenuation()#
Return type:

float

Getter of property constantAttenuation .

PySide6.Qt3DRender.Qt3DRender.QSpotLight.constantAttenuationChanged(constantAttenuation)#
Parameters:

constantAttenuation – float

Notification signal of property constantAttenuation .

PySide6.Qt3DRender.Qt3DRender.QSpotLight.cutOffAngle()#
Return type:

float

See also

setCutOffAngle()

Getter of property cutOffAngle .

PySide6.Qt3DRender.Qt3DRender.QSpotLight.cutOffAngleChanged(cutOffAngle)#
Parameters:

cutOffAngle – float

Notification signal of property cutOffAngle .

PySide6.Qt3DRender.Qt3DRender.QSpotLight.linearAttenuation()#
Return type:

float

Getter of property linearAttenuation .

PySide6.Qt3DRender.Qt3DRender.QSpotLight.linearAttenuationChanged(linearAttenuation)#
Parameters:

linearAttenuation – float

Notification signal of property linearAttenuation .

PySide6.Qt3DRender.Qt3DRender.QSpotLight.localDirection()#
Return type:

PySide6.QtGui.QVector3D

Getter of property localDirection .

PySide6.Qt3DRender.Qt3DRender.QSpotLight.localDirectionChanged(localDirection)#
Parameters:

localDirectionPySide6.QtGui.QVector3D

Notification signal of property localDirection .

PySide6.Qt3DRender.Qt3DRender.QSpotLight.quadraticAttenuation()#
Return type:

float

Getter of property quadraticAttenuation .

PySide6.Qt3DRender.Qt3DRender.QSpotLight.quadraticAttenuationChanged(quadraticAttenuation)#
Parameters:

quadraticAttenuation – float

Notification signal of property quadraticAttenuation .

PySide6.Qt3DRender.Qt3DRender.QSpotLight.setConstantAttenuation(value)#
Parameters:

value – float

Setter of property constantAttenuation .

PySide6.Qt3DRender.Qt3DRender.QSpotLight.setCutOffAngle(cutOffAngle)#
Parameters:

cutOffAngle – float

See also

cutOffAngle()

Setter of property cutOffAngle .

PySide6.Qt3DRender.Qt3DRender.QSpotLight.setLinearAttenuation(value)#
Parameters:

value – float

Setter of property linearAttenuation .

PySide6.Qt3DRender.Qt3DRender.QSpotLight.setLocalDirection(localDirection)#
Parameters:

localDirectionPySide6.QtGui.QVector3D

See also

localDirection()

Setter of property localDirection .

PySide6.Qt3DRender.Qt3DRender.QSpotLight.setQuadraticAttenuation(value)#
Parameters:

value – float

Setter of property quadraticAttenuation .