Finite spherical Lambertian emitter authored in physical photometric units. More...

#include <SphereAreaLightComponent.h>

Inheritance diagram for xiiSphereAreaLightComponent:

Public Member Functions
virtual void	SerializeComponent (xiiWorldWriter &inout_stream) const override
	Override this to save the current state of the component to the given stream.
virtual void	DeserializeComponent (xiiWorldReader &inout_stream) override
virtual xiiResult	GetLocalBounds (xiiBoundingBoxSphere &ref_bounds, bool &ref_bAlwaysVisible, xiiMsgUpdateLocalBounds &ref_msg) override
void	SetRadius (float fRadius)
float	GetRadius () const
void	SetRange (float fRange)
float	GetRange () const
float	GetEffectiveRange () const
void	SetShadowFadeOutRange (float fRange)
float	GetShadowFadeOutRange () const
Public Member Functions inherited from xiiLightComponent
xiiBitflags< xiiRenderExtractionCategory >	GetRenderExtractionCategories () const override
bool	IsRenderDataViewIndependent () const override
void	SetLightColor (xiiColorGammaUB lightColor)
xiiColorGammaUB	GetLightColor () const
void	SetTemperature (xiiUInt32 uiTemperature)
xiiUInt32	GetTemperature () const
void	SetIntensity (float fIntensity)
float	GetIntensity () const
void	SetIntensityUnit (xiiEnum< xiiPhotometricUnit > unit)
xiiEnum< xiiPhotometricUnit >	GetIntensityUnit () const
void	SetCastShadows (bool bCastShadows)
bool	GetCastShadows () const
void	OnMsgSetColor (xiiMsgSetColor &ref_msg)
Public Member Functions inherited from xiiRenderComponent
void	TriggerLocalBoundsUpdate ()
	Call this when some value was modified that affects the size of the local bounding box and it should be recomputed.
XII_ALWAYS_INLINE xiiUInt32	GetUniqueIdForRendering (xiiUInt32 uiInnerIndex=0, xiiUInt32 uiInnerIndexShift=24) const
	Computes a unique ID for the given component, that is usually given to the renderer to distinguish objects.
Public Member Functions inherited from xiiComponent
void	SetActiveFlag (bool bEnabled)
bool	GetActiveFlag () const
bool	IsActive () const
bool	IsActiveAndInitialized () const
bool	IsActiveAndSimulating () const
xiiComponentManagerBase *	GetOwningManager ()
	Returns the corresponding manager for this component.
const xiiComponentManagerBase *	GetOwningManager () const
	Returns the corresponding manager for this component.
xiiGameObject *	GetOwner ()
	Returns the owner game object if the component is attached to one or nullptr.
const xiiGameObject *	GetOwner () const
	Returns the owner game object if the component is attached to one or nullptr.
xiiWorld *	GetWorld ()
	Returns the corresponding world for this component.
const xiiWorld *	GetWorld () const
	Returns the corresponding world for this component.
xiiComponentHandle	GetHandle () const
	Returns a handle to this component.
xiiUInt32	GetUniqueID () const
	Returns the unique id for this component.
void	SetUniqueID (xiiUInt32 uiUniqueID)
	Sets the unique id for this component.
void	EnsureInitialized ()
	Ensures that the component is initialized. Must only be called from another component's Initialize callback.
void	EnsureSimulationStarted ()
XII_ALWAYS_INLINE bool	SendMessage (xiiMessage &ref_msg)
	Sends a message to this component.
XII_ALWAYS_INLINE bool	SendMessage (xiiMessage &ref_msg) const
void	PostMessage (const xiiMessage &msg, xiiTime delay=xiiTime::MakeZero(), xiiObjectMsgQueueType::Enum queueType=xiiObjectMsgQueueType::NextFrame) const
	Queues the message for the given phase. The message is processed after the given delay in the corresponding phase.
virtual bool	HandlesMessage (const xiiMessage &msg) const
	Returns whether the given Message is handled by this component.
void	SetUserFlag (xiiUInt8 uiFlagIndex, bool bSet)
	Be careful to check which flags may already be in use by base classes.
bool	GetUserFlag (xiiUInt8 uiFlagIndex) const
	Retrieves a custom flag. Index must be between 0 and 7.
void	SetCreatedByPrefab ()
	Adds xiiObjectFlags::CreatedByPrefab to the component. See the flag for details.
bool	WasCreatedByPrefab () const
	Checks whether the xiiObjectFlags::CreatedByPrefab flag is set on this component.
void	DeleteComponent ()
	Deletes this component. Note that the component will be invalidated first and the actual deletion is postponed.
Public Member Functions inherited from xiiReflectedClass
virtual const xiiRTTI *	GetDynamicRTTI () const
bool	IsInstanceOf (const xiiRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.
template<typename T>
XII_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.

Protected Member Functions
void	OnMsgExtractRenderData (xiiMsgExtractRenderData &ref_msg) const
float	GetLuminanceNits () const
float	GetOnAxisCandela () const
Protected Member Functions inherited from xiiLightComponent
float	GetLuminousIntensity (float fEmissionSolidAngleSteradians, float fProjectedAreaSquareMeters=0.0f) const
	Converts the authored value to the canonical quantity consumed by a local-light shader.
float	GetIlluminance (float fSourceSolidAngleSteradians) const
	Converts the authored value to illuminance for an infinitely distant emitter.
float	GetLuminance (float fEmittingAreaSquareMeters, float fProjectedAreaSquareMeters) const
	Converts the authored value to luminance for a finite Lambertian area emitter.
Protected Member Functions inherited from xiiRenderComponent
virtual void	Deinitialize () override
virtual void	OnActivated () override
virtual void	OnDeactivated () override
void	OnUpdateLocalBounds (xiiMsgUpdateLocalBounds &msg)
void	InvalidateCachedRenderData ()
void	OnTransformChanged (xiiMsgTransformChanged &msg)
Protected Member Functions inherited from xiiComponent
	xiiComponent ()
	Keep the constructor private or protected in derived classes, so it cannot be called manually.
bool	IsDynamic () const
	Returns whether this component is dynamic and thus can only be attached to dynamic game objects.
virtual xiiWorldModuleTypeId	GetTypeId () const =0
virtual xiiComponentMode::Enum	GetMode () const =0
virtual void	Initialize ()
virtual void	OnSimulationStarted ()
void	EnableUnhandledMessageHandler (bool enable)
	By default disabled. Enable to have OnUnhandledMessage() called for every unhandled message.
virtual bool	OnUnhandledMessage (xiiMessage &msg, bool bWasPostedMsg)
virtual bool	OnUnhandledMessage (xiiMessage &msg, bool bWasPostedMsg) const
bool	IsInitialized () const
bool	IsInitializing () const
bool	IsSimulationStarted () const

Protected Attributes
float	m_fRadius = 0.25f
float	m_fRange = 0.0f
float	m_fEffectiveRange = 0.0f
float	m_fShadowFadeOutRange = 0.0f
Protected Attributes inherited from xiiLightComponent
xiiColorGammaUB	m_LightColor = xiiColor::White
xiiUInt32	m_uiTemperature = 6550
float	m_fIntensity = 1.0f
xiiEnum< xiiPhotometricUnit >	m_IntensityUnit = xiiPhotometricUnit::Candela
bool	m_bCastShadows = false
Protected Attributes inherited from xiiComponent
const xiiRTTI *	m_pMessageDispatchType = nullptr
	Messages will be dispatched to this type. Default is what GetDynamicRTTI() returns, can be redirected if necessary.

Additional Inherited Members
Static Public Member Functions inherited from xiiLightComponent
static float	CalculateEffectiveRange (float fRange, float fIntensity)
static float	CalculateScreenSpaceSize (const xiiBoundingSphere &sphere, const xiiCamera &camera)
	Calculates how large on screen (relative height) the light source would be.
Static Public Member Functions inherited from xiiRenderComponent
static xiiUInt32	GetUniqueIdForRendering (const xiiComponent &component, xiiUInt32 uiInnerIndex=0, xiiUInt32 uiInnerIndexShift=24)
	Computes a unique ID for the given component, that is usually given to the renderer to distinguish objects.
Static Public Member Functions inherited from xiiNoBase
static const xiiRTTI *	GetStaticRTTI ()

Detailed Description

Finite spherical Lambertian emitter authored in physical photometric units.

Member Function Documentation

◆ DeserializeComponent()

void xiiSphereAreaLightComponent::DeserializeComponent ( xiiWorldReader & ref_stream )

overridevirtual

Override this to load the current state of the component from the given stream.

The active state will be automatically serialized. The 'initialized' state is not serialized, all components will be initialized after creation, even if they were already in an initialized state when they were serialized.

Reimplemented from xiiLightComponent.

◆ GetLocalBounds()

xiiResult xiiSphereAreaLightComponent::GetLocalBounds	(	xiiBoundingBoxSphere &	out_bounds,
		bool &	out_bAlwaysVisible,
		xiiMsgUpdateLocalBounds &	ref_msg )

overridevirtual

Called by xiiRenderComponent::OnUpdateLocalBounds().

If XII_SUCCESS is returned, out_bounds and out_bAlwaysVisible will be integrated into the xiiMsgUpdateLocalBounds ref_msg, otherwise the out values are simply ignored.

Implements xiiRenderComponent.

◆ SerializeComponent()

void xiiSphereAreaLightComponent::SerializeComponent ( xiiWorldWriter & ref_stream ) const

overridevirtual

Override this to save the current state of the component to the given stream.

Reimplemented from xiiLightComponent.

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

/home/runner/work/XII/XII/Source/Engine/GraphicsCore/Components/Lights/SphereAreaLightComponent.h
/home/runner/work/XII/XII/Source/Engine/GraphicsCore/Components/Lights/Implementation/SphereAreaLightComponent.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeserializeComponent()

◆ GetLocalBounds()

◆ SerializeComponent()