PySide6.Qt3DRender.Qt3DRender.QSpotLight

class QSpotLight

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

Synopsis

Properties

• constantAttenuationᅟ

• cutOffAngleᅟ

• linearAttenuationᅟ

• localDirectionᅟ

• quadraticAttenuationᅟ

Methods

• def __init__()

• def constantAttenuation()

• def cutOffAngle()

• def linearAttenuation()

• def localDirection()

• def quadraticAttenuation()

Slots

• def setConstantAttenuation()

• def setCutOffAngle()

• def setLinearAttenuation()

• def setLocalDirection()

• def setQuadraticAttenuation()

Signals

• def constantAttenuationChanged()

• def cutOffAngleChanged()

• def linearAttenuationChanged()

• def localDirectionChanged()

• def quadraticAttenuationChanged()

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.

Note

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

property 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:

• constantAttenuation()

• setConstantAttenuation()

• Signal constantAttenuationChanged()

property 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:

• cutOffAngle()

• setCutOffAngle()

• Signal cutOffAngleChanged()

property 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:

• linearAttenuation()

• setLinearAttenuation()

• Signal linearAttenuationChanged()

property localDirectionᅟ: 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:

• localDirection()

• setLocalDirection()

• Signal localDirectionChanged()

property 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:

• quadraticAttenuation()

• setQuadraticAttenuation()

• Signal quadraticAttenuationChanged()

__init__([parent=None])

Parameters:

parent – QNode

Constructs a new QSpotLight with the specified parent.

constantAttenuation()

Return type:

float

See also

setConstantAttenuation()

Getter of property constantAttenuationᅟ .

constantAttenuationChanged(constantAttenuation)

Parameters:

constantAttenuation – float

Notification signal of property constantAttenuationᅟ .

cutOffAngle()

Return type:

float

See also

setCutOffAngle()

Getter of property cutOffAngleᅟ .

cutOffAngleChanged(cutOffAngle)

Parameters:

cutOffAngle – float

Notification signal of property cutOffAngleᅟ .

linearAttenuation()

Return type:

float

See also

setLinearAttenuation()

Getter of property linearAttenuationᅟ .

linearAttenuationChanged(linearAttenuation)

Parameters:

linearAttenuation – float

Notification signal of property linearAttenuationᅟ .

localDirection()

Return type:

QVector3D

See also

setLocalDirection()

Getter of property localDirectionᅟ .

localDirectionChanged(localDirection)

Parameters:

localDirection – QVector3D

Notification signal of property localDirectionᅟ .

quadraticAttenuation()

Return type:

float

See also

setQuadraticAttenuation()

Getter of property quadraticAttenuationᅟ .

quadraticAttenuationChanged(quadraticAttenuation)

Parameters:

quadraticAttenuation – float

Notification signal of property quadraticAttenuationᅟ .

setConstantAttenuation(value)

Parameters:

value – float

See also

constantAttenuation()

Setter of property constantAttenuationᅟ .

setCutOffAngle(cutOffAngle)

Parameters:

cutOffAngle – float

See also

cutOffAngle()

Setter of property cutOffAngleᅟ .

setLinearAttenuation(value)

Parameters:

value – float

See also

linearAttenuation()

Setter of property linearAttenuationᅟ .

setLocalDirection(localDirection)

Parameters:

localDirection – QVector3D

See also

localDirection()

Setter of property localDirectionᅟ .

setQuadraticAttenuation(value)

Parameters:

value – float

See also

quadraticAttenuation()

Setter of property quadraticAttenuationᅟ .