Adds a lensflare or corona effect to a lightsource. More...

#include <LensFlareComponent.h>

Inheritance diagram for ezLensFlareComponent:

[legend]

Public Member Functions
virtual void	OnActivated () override
	This method is called when the component gets activated. More...

virtual void	OnDeactivated () override
	This method is called when the component gets deactivated. More...

virtual void	SerializeComponent (ezWorldWriter &inout_stream) const override
	Override this to save the current state of the component to the given stream.

virtual void	DeserializeComponent (ezWorldReader &inout_stream) override
	Override this to load the current state of the component from the given stream. More...

virtual ezResult	GetLocalBounds (ezBoundingBoxSphere &ref_bounds, bool &ref_bAlwaysVisible, ezMsgUpdateLocalBounds &ref_msg) override
	Called by ezRenderComponent::OnUpdateLocalBounds(). More...

void	SetLinkToLightShape (bool bLink)
	Link the lens flare to the first light component on the same owner object or any of its parent objects. More...

bool	GetLinkToLightShape () const

void	SetOcclusionSampleRadius (float fRadius)
	Sets the world space radius in which the depth buffer is sampled to determine how much the lens flare is occluded. Typically this would be the size of the light emitting area, like e.g. a lamp, or slightly larger.

float	GetOcclusionSampleRadius () const

Public Member Functions inherited from ezRenderComponent
void	TriggerLocalBoundsUpdate ()
	Call this when some value was modified that affects the size of the local bounding box and it should be recomputed.

EZ_ALWAYS_INLINE ezUInt32	GetUniqueIdForRendering (ezUInt32 uiInnerIndex=0, ezUInt32 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 ezComponent
void	SetActiveFlag (bool bEnabled)
	Sets the active flag of the component, which affects its active state. More...

bool	GetActiveFlag () const
	Checks whether the 'active flag' is set on this component. Note that this does not mean that the component is also 'active'. More...

bool	IsActive () const
	Checks whether this component is in an active state. More...

bool	IsActiveAndInitialized () const
	Returns whether this component is active and initialized. More...

bool	IsActiveAndSimulating () const
	Whether the component is currently active and simulation has been started as well. More...

ezComponentManagerBase *	GetOwningManager ()
	Returns the corresponding manager for this component.

const ezComponentManagerBase *	GetOwningManager () const
	Returns the corresponding manager for this component.

ezGameObject *	GetOwner ()
	Returns the owner game object if the component is attached to one or nullptr.

const ezGameObject *	GetOwner () const
	Returns the owner game object if the component is attached to one or nullptr.

ezWorld *	GetWorld ()
	Returns the corresponding world for this component.

const ezWorld *	GetWorld () const
	Returns the corresponding world for this component.

ezComponentHandle	GetHandle () const
	Returns a handle to this component.

ezUInt32	GetUniqueID () const
	Returns the unique id for this component.

void	SetUniqueID (ezUInt32 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 ()
	Ensures that the OnSimulationStarted method has been called. Must only be called from another component's OnSimulationStarted callback.

EZ_ALWAYS_INLINE bool	SendMessage (ezMessage &ref_msg)
	Sends a message to this component.

EZ_ALWAYS_INLINE bool	SendMessage (ezMessage &ref_msg) const

void	PostMessage (const ezMessage &msg, ezTime delay=ezTime::MakeZero(), ezObjectMsgQueueType::Enum queueType=ezObjectMsgQueueType::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 ezMessage &msg) const
	Returns whether the given Message is handled by this component.

void	SetUserFlag (ezUInt8 uiFlagIndex, bool bSet)
	Be careful to check which flags may already be in use by base classes.

bool	GetUserFlag (ezUInt8 uiFlagIndex) const
	Retrieves a custom flag. Index must be between 0 and 7.

void	SetCreatedByPrefab ()
	Adds ezObjectFlags::CreatedByPrefab to the component. See the flag for details.

bool	WasCreatedByPrefab () const
	Checks whether the ezObjectFlags::CreatedByPrefab flag is set on this component.

Public Member Functions inherited from ezReflectedClass
virtual const ezRTTI *	GetDynamicRTTI () const

bool	IsInstanceOf (const ezRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.

template<typename T >
EZ_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.

Public Attributes
float	m_fIntensity = 1.0f
	Adjusts the overall intensity of the lens flare.

float	m_fOcclusionSampleSpread = 0.5f
	Move the occlusion sample center towards the lens flare corner to introduce a slight gradient when the lens flare is only partially occluded. This value is relative to the sample radius.

float	m_fOcclusionDepthOffset = 0.0f
	Adjusts the occlusion sample depth in world space. Negative values will move towards the camera. This can be used to prevent self occlusion with the light source object.

ezSmallArray< ezLensFlareElement, 1 >	m_Elements

Additional Inherited Members
Static Public Member Functions inherited from ezRenderComponent
static ezUInt32	GetUniqueIdForRendering (const ezComponent &component, ezUInt32 uiInnerIndex=0, ezUInt32 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 ezNoBase
static const ezRTTI *	GetStaticRTTI ()

Protected Member Functions inherited from ezRenderComponent
virtual void	Deinitialize () override
	This method is called before the component is destroyed. A derived type can override this method to do common de-initialization work. More...

void	OnUpdateLocalBounds (ezMsgUpdateLocalBounds &msg)

void	InvalidateCachedRenderData ()

Protected Member Functions inherited from ezComponent
	ezComponent ()
	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 ezWorldModuleTypeId	GetTypeId () const =0

virtual ezComponentMode::Enum	GetMode () const =0

virtual void	Initialize ()
	Can be overridden for basic initialization that depends on a valid hierarchy and position. More...

virtual void	OnSimulationStarted ()
	This method is called once for active components, at the start of the next world update, but only when the world is simulated. More...

void	EnableUnhandledMessageHandler (bool enable)
	By default disabled. Enable to have OnUnhandledMessage() called for every unhandled message.

virtual bool	OnUnhandledMessage (ezMessage &msg, bool bWasPostedMsg)
	When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler. More...

virtual bool	OnUnhandledMessage (ezMessage &msg, bool bWasPostedMsg) const
	When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler. More...

bool	IsInitialized () const

bool	IsInitializing () const

bool	IsSimulationStarted () const

Protected Attributes inherited from ezComponent
const ezRTTI *	m_pMessageDispatchType = nullptr
	Messages will be dispatched to this type. Default is what GetDynamicRTTI() returns, can be redirected if necessary.

Detailed Description

Adds a lensflare or corona effect to a lightsource.

This component can be used to add a lensflare effect to a lightsource, typically the sun. It can, however, also be used on smaller lightsources. For a full lensflare one would add multiple billboard textures that are positioned along a line that rotates around the screen center. If only a single billboard is added and it is always at distance 'zero' along that line, it acts like a 'corona' that is only at the location of the lightsource.

The lensflare renderer determines how much the lightsource is occluded and scales the transparency of the lensflare accordingly.

The component does not require a lightsource, it can be attached to any other object, as well, it is just mostly used in conjunction with a point or directional lightsource.

Member Function Documentation

◆ DeserializeComponent()

void ezLensFlareComponent::DeserializeComponent ( ezWorldReader & inout_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 ezComponent.

◆ GetLocalBounds()

ezResult ezLensFlareComponent::GetLocalBounds	(	ezBoundingBoxSphere &	out_bounds,
		bool &	out_bAlwaysVisible,
		ezMsgUpdateLocalBounds &	ref_msg
	)

overridevirtual

Called by ezRenderComponent::OnUpdateLocalBounds().

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

Implements ezRenderComponent.

◆ OnActivated()

void ezLensFlareComponent::OnActivated ( )

overridevirtual

This method is called when the component gets activated.

By default a component is active, but it can be created in an inactive state. In such a case OnActivated() is only called once a component is activated. If a component gets switched between active and inactive at runtime, OnActivated() and OnDeactivated() are called accordingly. In contrast Initialize() and Deinitialize() are only ever called once.

See also: OnActivated(), OnDeactivated(), Initialize(), Deinitialize(), OnSimulationStarted()

Reimplemented from ezRenderComponent.

◆ OnDeactivated()

void ezLensFlareComponent::OnDeactivated ( )

overridevirtual

This method is called when the component gets deactivated.

Upon destruction, a component that is active first gets deactivated. Therefore OnDeactivated() should be used for typical game code cleanup.

See also: OnActivated(), OnDeactivated(), Initialize(), Deinitialize(), OnSimulationStarted()

Reimplemented from ezRenderComponent.

◆ SetLinkToLightShape()

void ezLensFlareComponent::SetLinkToLightShape ( bool bLink )

Link the lens flare to the first light component on the same owner object or any of its parent objects.

When a lens flare is linked it will take the light color and intensity to modulate the lens flare color and intensity for elements that have the m_bModulateByLightColor flag set. For directional lights the lens flare is positioned at far plane and moved with the camera to simulate a light that is at infinite distance, like e.g. the sun. For spot lights the lens flare intensity is additionally adjusted so that the lens flare is only visible when the camera is inside the light cone.

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

/home/runner/work/ezEngine/ezEngine/Code/Engine/RendererCore/Components/LensFlareComponent.h
/home/runner/work/ezEngine/ezEngine/Code/Engine/RendererCore/Components/Implementation/LensFlareComponent.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeserializeComponent()

◆ GetLocalBounds()

◆ OnActivated()

◆ OnDeactivated()

◆ SetLinkToLightShape()