AZ::Render::SkyAtmosphereRequests Class Reference

The EBus for requests to modify sky atmosphere components. More...

#include <SkyAtmosphereBus.h>

Inherits AZ::ComponentBus.

Public Member Functions
	AZ_RTTI (AZ::Render::SkyAtmosphereRequests, "{7F8704EE-196D-4371-B185-F209FE58F2D1}")
virtual void	SetEnabled (bool enabled)=0
virtual bool	GetEnabled ()=0
virtual void	SetPlanetOriginMode (SkyAtmosphereComponentConfig::AtmosphereOrigin mode)=0
virtual SkyAtmosphereComponentConfig::AtmosphereOrigin	GetPlanetOriginMode ()=0
virtual void	SetAtmosphereHeight (float atmosphereHeightKm)=0
virtual float	GetAtmosphereHeight ()=0
virtual void	SetPlanetRadius (float planetRadiusKm)=0
virtual float	GetPlanetRadius ()=0
virtual void	SetGroundAlbedo (const AZ::Vector3 &groundAlbedo)=0
virtual AZ::Vector3	GetGroundAlbedo ()=0
virtual void	SetLuminanceFactor (const AZ::Vector3 &luminanceFactor)=0
virtual AZ::Vector3	GetLuminanceFactor ()=0
virtual void	SetMieAbsorption (const AZ::Vector3 &mieAbsorption)=0
virtual AZ::Vector3	GetMieAbsorption ()=0
virtual void	SetMieExpDistribution (float mieExpDistribution)=0
virtual float	GetMieExpDistribution ()=0
virtual void	SetMieScattering (const AZ::Vector3 &mieScattering)=0
virtual AZ::Vector3	GetMieScattering ()=0
virtual void	SetRayleighExpDistribution (float rayleighExpDistribution)=0
virtual float	GetRayleighExpDistribution ()=0
virtual void	SetRayleighScattering (const AZ::Vector3 &rayleighScattering)=0
virtual AZ::Vector3	GetRayleighScattering ()=0
virtual void	SetMaxSamples (uint8_t maxSamples)=0
virtual uint8_t	GetMaxSamples ()=0
virtual void	SetMinSamples (uint8_t minSamples)=0
virtual uint8_t	GetMinSamples ()=0
virtual void	SetSunEnabled (bool enabled)=0
virtual bool	GetSunEnabled ()=0
virtual void	SetSunEntityId (AZ::EntityId entityId)=0
virtual AZ::EntityId	GetSunEntityId ()=0
virtual void	SetSunColor (const AZ::Color sunColor)=0
virtual AZ::Color	GetSunColor ()=0
virtual void	SetSunLuminanceFactor (float factor)=0
virtual float	GetSunLuminanceFactor ()=0
virtual void	SetSunLimbColor (const AZ::Color sunLimbColor)=0
virtual AZ::Color	GetSunLimbColor ()=0
virtual void	SetSunFalloffFactor (float factor)=0
virtual float	GetSunFalloffFactor ()=0
virtual void	SetSunRadiusFactor (float factor)=0
virtual float	GetSunRadiusFactor ()=0
virtual void	SetSunDirection (const AZ::Vector3 &sunDirection)=0
virtual AZ::Vector3	GetSunDirection ()=0
virtual void	SetFastSkyEnabled (bool enabled)=0
virtual bool	GetFastSkyEnabled ()=0
virtual void	SetFastAerialPerspectiveEnabled (bool enabled)=0
virtual bool	GetFastAerialPerspectiveEnabled ()=0
virtual void	SetAerialPerspectiveEnabled (bool enabled)=0
virtual bool	GetAerialPerspectiveEnabled ()=0
virtual void	SetNearClip (float nearClip)=0
virtual float	GetNearClip ()=0
virtual void	SetNearFadeDistance (float nearFadeDistance)=0
virtual float	GetNearFadeDistance ()=0
virtual void	SetAerialDepthFactor (float aerialDepthFactor)=0
virtual float	GetAerialDepthFactor ()=0
virtual void	SetShadowsEnabled (bool enabled)=0
virtual bool	GetShadowsEnabled ()=0

Static Public Attributes
static const EBusHandlerPolicy	HandlerPolicy = EBusHandlerPolicy::Single
	Overrides the default AZ::EBusTraits handler policy to allow one listener only.

Detailed Description

The EBus for requests to modify sky atmosphere components.

Member Function Documentation

GetAerialDepthFactor()

virtual float AZ::Render::SkyAtmosphereRequests::GetAerialDepthFactor ( )

pure virtual

Returns

the factor applied to the depth of all pixels that obstruct the sky,

GetAerialPerspectiveEnabled()

virtual bool AZ::Render::SkyAtmosphereRequests::GetAerialPerspectiveEnabled ( )

pure virtual

Returns

whether aerial perspective is enabled or not

GetAtmosphereHeight()

virtual float AZ::Render::SkyAtmosphereRequests::GetAtmosphereHeight ( )

pure virtual

Returns

the atmosphere height in kilometers

GetEnabled()

virtual bool AZ::Render::SkyAtmosphereRequests::GetEnabled ( )

pure virtual

Returns

true if the current atmosphere is enabled

GetFastAerialPerspectiveEnabled()

virtual bool AZ::Render::SkyAtmosphereRequests::GetFastAerialPerspectiveEnabled ( )

pure virtual

Returns

whether fast aerial perspective is enabled

GetFastSkyEnabled()

virtual bool AZ::Render::SkyAtmosphereRequests::GetFastSkyEnabled ( )

pure virtual

Returns

whether fast sky is enabled

GetGroundAlbedo()

virtual AZ::Vector3 AZ::Render::SkyAtmosphereRequests::GetGroundAlbedo ( )

pure virtual

Returns

the ground albedo

GetLuminanceFactor()

virtual AZ::Vector3 AZ::Render::SkyAtmosphereRequests::GetLuminanceFactor ( )

pure virtual

Returns

the luminance factor of the atmosphere

GetMaxSamples()

virtual uint8_t AZ::Render::SkyAtmosphereRequests::GetMaxSamples ( )

pure virtual

Returns

the maximum number of samples to use for each ray cast

GetMieAbsorption()

virtual AZ::Vector3 AZ::Render::SkyAtmosphereRequests::GetMieAbsorption ( )

pure virtual

Returns

the mie absorption amount

GetMieExpDistribution()

virtual float AZ::Render::SkyAtmosphereRequests::GetMieExpDistribution ( )

pure virtual

Returns

the mie distribution amount

GetMieScattering()

virtual AZ::Vector3 AZ::Render::SkyAtmosphereRequests::GetMieScattering ( )

pure virtual

Returns

the mie scattering color

GetMinSamples()

virtual uint8_t AZ::Render::SkyAtmosphereRequests::GetMinSamples ( )

pure virtual

Returns

the minimum number of samples to use for each ray cast

GetNearClip()

virtual float AZ::Render::SkyAtmosphereRequests::GetNearClip ( )

pure virtual

Returns

the near clip distance at which aerial perspective starts drawing

GetNearFadeDistance()

virtual float AZ::Render::SkyAtmosphereRequests::GetNearFadeDistance ( )

pure virtual

Returns

the distance over which to fade in aerial perspective starting from the near clip distance

GetPlanetOriginMode()

virtual SkyAtmosphereComponentConfig::AtmosphereOrigin AZ::Render::SkyAtmosphereRequests::GetPlanetOriginMode ( )

pure virtual

Returns

the planet origin mode

GetPlanetRadius()

virtual float AZ::Render::SkyAtmosphereRequests::GetPlanetRadius ( )

pure virtual

Returns

the planet radius in kilometers

GetRayleighExpDistribution()

virtual float AZ::Render::SkyAtmosphereRequests::GetRayleighExpDistribution ( )

pure virtual

Returns

the rayleigh exp distribution amount

GetRayleighScattering()

virtual AZ::Vector3 AZ::Render::SkyAtmosphereRequests::GetRayleighScattering ( )

pure virtual

Returns

the rayleigh scattering color

GetShadowsEnabled()

virtual bool AZ::Render::SkyAtmosphereRequests::GetShadowsEnabled ( )

pure virtual

Returns

whether shadows affect the atmosphere

GetSunColor()

virtual AZ::Color AZ::Render::SkyAtmosphereRequests::GetSunColor ( )

pure virtual

Returns

the sun color

GetSunDirection()

virtual AZ::Vector3 AZ::Render::SkyAtmosphereRequests::GetSunDirection ( )

pure virtual

Returns

the sun direction

GetSunEnabled()

virtual bool AZ::Render::SkyAtmosphereRequests::GetSunEnabled ( )

pure virtual

Returns

whether drawing the sun is enabled

GetSunEntityId()

virtual AZ::EntityId AZ::Render::SkyAtmosphereRequests::GetSunEntityId ( )

pure virtual

Returns

the sun entity to use for the orientation of the sun

GetSunFalloffFactor()

virtual float AZ::Render::SkyAtmosphereRequests::GetSunFalloffFactor ( )

pure virtual

Returns

the sun falloff factor

GetSunLimbColor()

virtual AZ::Color AZ::Render::SkyAtmosphereRequests::GetSunLimbColor ( )

pure virtual

Returns

the sun limb (outer edge) color

GetSunLuminanceFactor()

virtual float AZ::Render::SkyAtmosphereRequests::GetSunLuminanceFactor ( )

pure virtual

Returns

the sun luminance factor

GetSunRadiusFactor()

virtual float AZ::Render::SkyAtmosphereRequests::GetSunRadiusFactor ( )

pure virtual

Returns

the sun radius factor

SetAerialDepthFactor()

virtual void AZ::Render::SkyAtmosphereRequests::SetAerialDepthFactor ( float  aerialDepthFactor )

pure virtual

Set the factor to apply to the depth of all pixels that obstruct the sky, causing objects to appear further away in the atmosphere

Parameters

aerialDepthFactor

The factor to multiply to all obstructed pixels depth

SetAerialPerspectiveEnabled()

virtual void AZ::Render::SkyAtmosphereRequests::SetAerialPerspectiveEnabled ( bool  enabled )

pure virtual

Enable or disable drawing aerial perspective on top of the scene. This can be used to speed up indoor scenes

Parameters

enabled

Whether to enable or aerial perspective

SetAtmosphereHeight()

virtual void AZ::Render::SkyAtmosphereRequests::SetAtmosphereHeight ( float  atmosphereHeightKm )

pure virtual

Set the atmosphere height in kilometers

Parameters

atmosphereHeightKm

height in km

SetEnabled()

virtual void AZ::Render::SkyAtmosphereRequests::SetEnabled ( bool  enabled )

pure virtual

Enable/disable atmosphere without having to deactivate the entity

Parameters

enabled

Set whether the atmosphere is enabled or not

SetFastAerialPerspectiveEnabled()

virtual void AZ::Render::SkyAtmosphereRequests::SetFastAerialPerspectiveEnabled ( bool  enabled )

pure virtual

Enable using a look up table for all sky pixels that are obstructed

Parameters

enabled

Whether to enable or disable fast aerial perspective

SetFastSkyEnabled()

virtual void AZ::Render::SkyAtmosphereRequests::SetFastSkyEnabled ( bool  enabled )

pure virtual

Enable using a look up table for all sky pixels that are not obstructed

Parameters

enabled

Whether to enable or disable fast sky

SetGroundAlbedo()

virtual void AZ::Render::SkyAtmosphereRequests::SetGroundAlbedo ( const AZ::Vector3 &  groundAlbedo )

pure virtual

Set the ground albedo

Parameters

groundAlbedo

The ground albedo color

SetLuminanceFactor()

virtual void AZ::Render::SkyAtmosphereRequests::SetLuminanceFactor ( const AZ::Vector3 &  luminanceFactor )

pure virtual

Set the luminance factor of the atmosphere

Parameters

luminanceFactor

The luminance factor

SetMaxSamples()

virtual void AZ::Render::SkyAtmosphereRequests::SetMaxSamples ( uint8_t  maxSamples )

pure virtual

Set the maximum number of samples to use for each ray cast from the camera into the atmosphere

Parameters

maxSamples

The maximum number of samples

SetMieAbsorption()

virtual void AZ::Render::SkyAtmosphereRequests::SetMieAbsorption ( const AZ::Vector3 &  mieAbsorption )

pure virtual

Set the mie absorption amount

Parameters

mieAbsorption

The mie absorption amount

SetMieExpDistribution()

virtual void AZ::Render::SkyAtmosphereRequests::SetMieExpDistribution ( float  mieExpDistribution )

pure virtual

Set the mie distribution amount

Parameters

mieExpDistribution

The mie distribution amount

SetMieScattering()

virtual void AZ::Render::SkyAtmosphereRequests::SetMieScattering ( const AZ::Vector3 &  mieScattering )

pure virtual

Set the mie scattering color

Parameters

mieScattering

The mie scattering color

SetMinSamples()

virtual void AZ::Render::SkyAtmosphereRequests::SetMinSamples ( uint8_t  minSamples )

pure virtual

Set the minimum number of samples to use for each ray cast from the camera into the atmosphere

Parameters

minSamples

The minimum number of samples

SetNearClip()

virtual void AZ::Render::SkyAtmosphereRequests::SetNearClip ( float  nearClip )

pure virtual

Set the near clip distance at which aerial perspective starts drawing This value is useful when you are inside a building looking out and don't want to enable shadows, instead you can set the near clip so aerial perspective isn't applied until pixels are outside whatever building the camera is in

Parameters

nearClip

The distance in meters at which to start applying aerial perspective

SetNearFadeDistance()

virtual void AZ::Render::SkyAtmosphereRequests::SetNearFadeDistance ( float  nearFadeDistance )

pure virtual

Set the distance over which to fade in aerial perspective starting from the near clip distance If this value is set to 0, there may be a distinct visible line

Parameters

nearFadeDistance

The distance in meters at which to fade into aerial perspective

SetPlanetOriginMode()

virtual void AZ::Render::SkyAtmosphereRequests::SetPlanetOriginMode ( SkyAtmosphereComponentConfig::AtmosphereOrigin  mode )

pure virtual

Set the planet origin mode

Parameters

mode	Set the origin mode to use

SetPlanetRadius()

virtual void AZ::Render::SkyAtmosphereRequests::SetPlanetRadius ( float  planetRadiusKm )

pure virtual

Set the planet radius in kilometers

Parameters

planetRadiusKm

radius in km

SetRayleighExpDistribution()

virtual void AZ::Render::SkyAtmosphereRequests::SetRayleighExpDistribution ( float  rayleighExpDistribution )

pure virtual

Set the rayleigh exp distribution amount

Parameters

rayleighExpDistribution

The rayleight exp distribution

SetRayleighScattering()

virtual void AZ::Render::SkyAtmosphereRequests::SetRayleighScattering ( const AZ::Vector3 &  rayleighScattering )

pure virtual

Set the rayleigh scattering color

Parameters

rayleighScattering

The rayleigh scattering color

SetShadowsEnabled()

virtual void AZ::Render::SkyAtmosphereRequests::SetShadowsEnabled ( bool  enabled )

pure virtual

Set whether shadows affect the atmosphere or not Shadows have no effect when fast aerial perspective and fast sky are enabled

Parameters

enabled

True to allow shadows to affect the atmosphere

SetSunColor()

virtual void AZ::Render::SkyAtmosphereRequests::SetSunColor ( const AZ::Color  sunColor )

pure virtual

Set the sun color

Parameters

sunColor

The sun color

SetSunDirection()

virtual void AZ::Render::SkyAtmosphereRequests::SetSunDirection ( const AZ::Vector3 &  sunDirection )

pure virtual

Set the sun direction, has not effect if the sun entity has been set

Parameters

sunDirection

The direction for the sun to point at

SetSunEnabled()

virtual void AZ::Render::SkyAtmosphereRequests::SetSunEnabled ( bool  enabled )

pure virtual

Enable or disable drawing on the sun

Parameters

enabled

Enable drawing the sun or not

SetSunEntityId()

virtual void AZ::Render::SkyAtmosphereRequests::SetSunEntityId ( AZ::EntityId  entityId )

pure virtual

Set the sun entity to use for the orientation of the sun

Parameters

entityId

The Entity Id of the entity to use

SetSunFalloffFactor()

virtual void AZ::Render::SkyAtmosphereRequests::SetSunFalloffFactor ( float  factor )

pure virtual

Set the sun falloff factor, controls how the sun disk fades at the edges

Parameters

factor

The falloff factor for the edge of the sun

SetSunLimbColor()

virtual void AZ::Render::SkyAtmosphereRequests::SetSunLimbColor ( const AZ::Color  sunLimbColor )

pure virtual

Set the sun limb (outer edge) color

Parameters

sunLimbColor

The sun limb color

SetSunLuminanceFactor()

virtual void AZ::Render::SkyAtmosphereRequests::SetSunLuminanceFactor ( float  factor )

pure virtual

Set the sun luminance factor

Parameters

factor

The luminance color

SetSunRadiusFactor()

virtual void AZ::Render::SkyAtmosphereRequests::SetSunRadiusFactor ( float  factor )

pure virtual

Set the sun radius factor, controls how large the sun disk is

Parameters

factor

The radius factor for the edge of the sun

---

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

• Gems/AtomLyIntegration/CommonFeatures/Code/Include/AtomLyIntegration/CommonFeatures/SkyAtmosphere/SkyAtmosphereBus.h