Open 3D Engine AtomLyIntegration Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::Render::DirectionalLightComponentController Class Referencefinal

Inherits DirectionalLightRequestBus::Handler, AZ::TickBus::Handler, TransformNotificationBus::MultiHandler, and Camera::CameraNotificationBus::Handler.

Public Member Functions

 AZ_TYPE_INFO (AZ::Render::DirectionalLightComponentController, "60A9DFF4-6A05-4D83-81BD-13ADEB95B29C")
 
 DirectionalLightComponentController (const DirectionalLightComponentConfig &config)
 
void Activate (EntityId entityId)
 
void Deactivate ()
 
void SetConfiguration (const DirectionalLightComponentConfig &config)
 
const DirectionalLightComponentConfigGetConfiguration () const
 
const Color & GetColor () const override
 
void SetColor (const Color &color) override
 
float GetIntensity () const override
 
void SetIntensity (float intensity, PhotometricUnit unit) override
 
void SetIntensity (float intensity) override
 
float GetAngularDiameter () const override
 
void SetAngularDiameter (float angularDiameter) override
 
ShadowmapSize GetShadowmapSize () const override
 
void SetShadowmapSize (ShadowmapSize size) override
 
uint32_t GetCascadeCount () const override
 
void SetCascadeCount (uint32_t cascadeCount) override
 
float GetShadowmapFrustumSplitSchemeRatio () const override
 
void SetShadowmapFrustumSplitSchemeRatio (float ratio) override
 
const Vector4 & GetCascadeFarDepth () override
 
void SetCascadeFarDepth (const Vector4 &farDepth) override
 
bool GetShadowmapFrustumSplitAutomatic () const override
 
void SetShadowmapFrustumSplitAutomatic (bool isAutomatic) override
 
EntityId GetCameraEntityId () const override
 
void SetCameraEntityId (EntityId entityId) override
 
float GetShadowFarClipDistance () const override
 
void SetShadowFarClipDistance (float farDist) override
 
float GetGroundHeight () const override
 
void SetGroundHeight (float groundHeight) override
 
bool GetViewFrustumCorrectionEnabled () const override
 
void SetViewFrustumCorrectionEnabled (bool enabled) override
 
bool GetDebugColoringEnabled () const override
 
void SetDebugColoringEnabled (bool enabled) override
 
ShadowFilterMethod GetShadowFilterMethod () const override
 
void SetShadowFilterMethod (ShadowFilterMethod method) override
 
uint32_t GetFilteringSampleCount () const override
 
void SetFilteringSampleCount (uint32_t count) override
 
bool GetShadowReceiverPlaneBiasEnabled () const override
 
void SetShadowReceiverPlaneBiasEnabled (bool enable) override
 
float GetShadowBias () const override
 
void SetShadowBias (float bias) override
 
float GetNormalShadowBias () const override
 
void SetNormalShadowBias (float bias) override
 
bool GetCascadeBlendingEnabled () const override
 
void SetCascadeBlendingEnabled (bool enable) override
 
void SetFullscreenBlurEnabled (bool enable)
 
void SetFullscreenBlurConstFalloff (float blurConstFalloff)
 
void SetFullscreenBlurDepthFalloffStrength (float blurDepthFalloffStrength)
 
bool GetAffectsGI () const override
 
void SetAffectsGI (bool affectsGI) override
 
float GetAffectsGIFactor () const override
 
void SetAffectsGIFactor (float affectsGIFactor) override
 
void BindConfigurationChangedEventHandler (DirectionalLightConfigurationChangedEvent::Handler &configurationChangedHandler) override
 

Static Public Member Functions

static void Reflect (ReflectContext *context)
 
static void GetDependentServices (ComponentDescriptor::DependencyArrayType &dependent)
 
static void GetProvidedServices (ComponentDescriptor::DependencyArrayType &provided)
 
static void GetIncompatibleServices (ComponentDescriptor::DependencyArrayType &incompatible)
 

Friends

class EditorDirectionaLightComponent
 
class EditorDirectionalLightComponent
 

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