Inherits AZ::Render::LightDelegateBase< SimpleSpotLightFeatureProcessorInterface >.

Public Member Functions
	SimpleSpotLightDelegate (EntityId entityId, bool isVisible)

float	CalculateAttenuationRadius (float lightThreshold) const override
	Calculates the attenuation radius for this light type based on a threshold value.

void	DrawDebugDisplay (const Transform &transform, const Color &color, AzFramework::DebugDisplayRequests &debugDisplay, bool isSelected) const override
	Handle any additional debug display drawing for beyond what the shape already provides.

float	GetSurfaceArea () const override
	Gets the surface area of the shape.

float	GetEffectiveSolidAngle () const override
	Returns the number of steradians covered by this light type.

void	SetShutterAngles (float innerAngleDegrees, float outerAngleDegrees) override

void	SetAffectsGI (bool affectsGI) override
	Sets if the light should affect diffuse global illumination.

void	SetAffectsGIFactor (float affectsGIFactor) override
	Sets the multiplier on the contribution to diffuse global illumination.

Aabb	GetLocalVisualizationBounds () const override
	Returns the Aabb for the debug visualization of the light.

void	SetEnableShadow (bool enabled) override
	Sets if shadows should be enabled.

void	SetShadowBias (float bias) override
	Sets the shadow bias.

void	SetShadowmapMaxSize (ShadowmapSize size) override
	Sets the maximum resolution of the shadow map.

void	SetShadowFilterMethod (ShadowFilterMethod method) override
	Sets the filter method for the shadow.

void	SetFilteringSampleCount (uint32_t count) override
	Sets the sample count for filtering of the shadow boundary, max 64.

void	SetEsmExponent (float exponent) override
	Sets the Esm exponent to use. Higher values produce a steeper falloff between light and shadow.

void	SetNormalShadowBias (float bias) override
	Sets the normal bias. Reduces acne by biasing the shadowmap lookup along the geometric normal.

void	SetShadowCachingMode (AreaLightComponentConfig::ShadowCachingMode cachingMode) override

void	SetGoboTexture (AZ::Data::Instance< AZ::RPI::Image > goboTexture) override

Public Member Functions inherited from AZ::Render::LightDelegateBase< SimpleSpotLightFeatureProcessorInterface >
	LightDelegateBase (EntityId entityId, bool isVisible)

void	SetConfig (const AreaLightComponentConfig *config) override
	Sets the area light component config so delegates don't have to cache the same data locally.

void	SetChroma (const Color &chroma) override
	Sets the color of the light independent of light intensity. The color is a mask on the total light intensity.

void	SetIntensity (float intensity) override
	Sets the light intensity.

float	SetPhotometricUnit (PhotometricUnit unit) override
	Sets the light unit, and returns the converted light intensity.

void	SetAttenuationRadius (float radius) override
	Sets the maximum distance from any part of the surface of the area light at which this light will have an effect.

const PhotometricValue &	GetPhotometricValue () const override
	Gets the light intensity.

void	SetLightEmitsBothDirections (bool lightEmitsBothDirections) override
	Sets if this shape is double-sided (only applicable for 2d shapes).

void	SetUseFastApproximation (bool useFastApproximation) override

void	SetVisibility (bool visibility) override
	Turns the visibility of this light on/off.

void	SetEnableShutters (bool enabled) override

void	SetLightingChannelMask (uint32_t lightingChannelMask) override
	Set the lighting channel mask.

Public Member Functions inherited from AZ::Render::LightDelegateInterface

Additional Inherited Members
Protected Member Functions inherited from AZ::Render::LightDelegateBase< SimpleSpotLightFeatureProcessorInterface >
void	InitBase (EntityId entityId)

SimpleSpotLightFeatureProcessorInterface *	GetFeatureProcessor () const

const AreaLightComponentConfig *	GetConfig () const

SimpleSpotLightFeatureProcessorInterface::LightHandle	GetLightHandle () const

const Transform &	GetTransform () const

bool	GetShuttersEnabled ()

bool	GetShadowsEnabled ()

void	OnShapeChanged (ShapeChangeReasons changeReason) override

void	OnTransformChanged (const Transform &local, const Transform &world) override

Protected Attributes inherited from AZ::Render::LightDelegateBase< SimpleSpotLightFeatureProcessorInterface >
LmbrCentral::ShapeComponentRequests *	m_shapeBus

Member Function Documentation

◆ CalculateAttenuationRadius()

float AZ::Render::SimpleSpotLightDelegate::CalculateAttenuationRadius ( float lightThreshold ) const

overridevirtual

Calculates the attenuation radius for this light type based on a threshold value.

Implements AZ::Render::LightDelegateInterface.

◆ DrawDebugDisplay()

void AZ::Render::SimpleSpotLightDelegate::DrawDebugDisplay	(	const Transform &	transform,
		const Color &	color,
		AzFramework::DebugDisplayRequests &	debugDisplay,
		bool	isSelected ) const

overridevirtual

Handle any additional debug display drawing for beyond what the shape already provides.

Implements AZ::Render::LightDelegateInterface.

◆ GetEffectiveSolidAngle()

float AZ::Render::SimpleSpotLightDelegate::GetEffectiveSolidAngle ( ) const

inlineoverridevirtual

Returns the number of steradians covered by this light type.

Implements AZ::Render::LightDelegateInterface.

◆ GetLocalVisualizationBounds()

Aabb AZ::Render::SimpleSpotLightDelegate::GetLocalVisualizationBounds ( ) const

overridevirtual

Returns the Aabb for the debug visualization of the light.

Implements AZ::Render::LightDelegateInterface.

◆ GetSurfaceArea()

float AZ::Render::SimpleSpotLightDelegate::GetSurfaceArea ( ) const

overridevirtual

Gets the surface area of the shape.

Implements AZ::Render::LightDelegateInterface.

◆ SetAffectsGI()

void AZ::Render::SimpleSpotLightDelegate::SetAffectsGI ( bool affectsGI )

overridevirtual

Sets if the light should affect diffuse global illumination.

Reimplemented from AZ::Render::LightDelegateBase< SimpleSpotLightFeatureProcessorInterface >.

◆ SetAffectsGIFactor()

void AZ::Render::SimpleSpotLightDelegate::SetAffectsGIFactor ( float affectsGIFactor )

overridevirtual

Sets the multiplier on the contribution to diffuse global illumination.

Reimplemented from AZ::Render::LightDelegateBase< SimpleSpotLightFeatureProcessorInterface >.

◆ SetEnableShadow()

void AZ::Render::SimpleSpotLightDelegate::SetEnableShadow ( bool enabled )

overridevirtual

Sets if shadows should be enabled.

Reimplemented from AZ::Render::LightDelegateBase< SimpleSpotLightFeatureProcessorInterface >.

◆ SetEsmExponent()

void AZ::Render::SimpleSpotLightDelegate::SetEsmExponent ( float esmExponent )

overridevirtual

Sets the Esm exponent to use. Higher values produce a steeper falloff between light and shadow.

Reimplemented from AZ::Render::LightDelegateBase< SimpleSpotLightFeatureProcessorInterface >.

◆ SetFilteringSampleCount()

void AZ::Render::SimpleSpotLightDelegate::SetFilteringSampleCount ( uint32_t count )

overridevirtual

Sets the sample count for filtering of the shadow boundary, max 64.

Reimplemented from AZ::Render::LightDelegateBase< SimpleSpotLightFeatureProcessorInterface >.

◆ SetGoboTexture()

void AZ::Render::SimpleSpotLightDelegate::SetGoboTexture ( AZ::Data::Instance< AZ::RPI::Image > goboTexture )

overridevirtual

Reimplemented from AZ::Render::LightDelegateBase< SimpleSpotLightFeatureProcessorInterface >.

◆ SetNormalShadowBias()

void AZ::Render::SimpleSpotLightDelegate::SetNormalShadowBias ( float bias )

overridevirtual

Sets the normal bias. Reduces acne by biasing the shadowmap lookup along the geometric normal.

Reimplemented from AZ::Render::LightDelegateBase< SimpleSpotLightFeatureProcessorInterface >.

◆ SetShadowBias()

void AZ::Render::SimpleSpotLightDelegate::SetShadowBias ( float bias )

overridevirtual

Sets the shadow bias.

Reimplemented from AZ::Render::LightDelegateBase< SimpleSpotLightFeatureProcessorInterface >.

◆ SetShadowCachingMode()

void AZ::Render::SimpleSpotLightDelegate::SetShadowCachingMode ( AreaLightComponentConfig::ShadowCachingMode cachingMode )

overridevirtual

Sets the current shadow caching mode. Cached shadows use persistent textures and only update when they detect a change. Regular shadows use transient textures but re-render every frame.

Reimplemented from AZ::Render::LightDelegateBase< SimpleSpotLightFeatureProcessorInterface >.

◆ SetShadowFilterMethod()

void AZ::Render::SimpleSpotLightDelegate::SetShadowFilterMethod ( ShadowFilterMethod method )

overridevirtual

Sets the filter method for the shadow.

Reimplemented from AZ::Render::LightDelegateBase< SimpleSpotLightFeatureProcessorInterface >.

◆ SetShadowmapMaxSize()

void AZ::Render::SimpleSpotLightDelegate::SetShadowmapMaxSize ( ShadowmapSize size )

overridevirtual

Sets the maximum resolution of the shadow map.

Reimplemented from AZ::Render::LightDelegateBase< SimpleSpotLightFeatureProcessorInterface >.

◆ SetShutterAngles()

void AZ::Render::SimpleSpotLightDelegate::SetShutterAngles	(	float	innerAngleDegrees,
		float	outerAngleDegrees )

overridevirtual

Reimplemented from AZ::Render::LightDelegateBase< SimpleSpotLightFeatureProcessorInterface >.

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

Gems/AtomLyIntegration/CommonFeatures/Code/Source/CoreLights/SimpleSpotLightDelegate.h

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ CalculateAttenuationRadius()

◆ DrawDebugDisplay()

◆ GetEffectiveSolidAngle()

◆ GetLocalVisualizationBounds()

◆ GetSurfaceArea()

◆ SetAffectsGI()

◆ SetAffectsGIFactor()

◆ SetEnableShadow()

◆ SetEsmExponent()

◆ SetFilteringSampleCount()

◆ SetGoboTexture()

◆ SetNormalShadowBias()

◆ SetShadowBias()

◆ SetShadowCachingMode()

◆ SetShadowFilterMethod()

◆ SetShadowmapMaxSize()

◆ SetShutterAngles()