Box reflection probe component. More...

#include <BoxReflectionProbeComponent.h>

Inheritance diagram for xiiBoxReflectionProbeComponent:

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
	Override this to load the current state of the component from the given stream.

const xiiVec3 &	GetExtents () const

void	SetExtents (const xiiVec3 &vExtents)

const xiiVec3 &	GetInfluenceScale () const

void	SetInfluenceScale (const xiiVec3 &vInfluenceScale)

const xiiVec3 &	GetInfluenceShift () const

void	SetInfluenceShift (const xiiVec3 &vInfluenceShift)

void	SetPositiveFalloff (const xiiVec3 &vFalloff)

const xiiVec3 &	GetPositiveFalloff () const

void	SetNegativeFalloff (const xiiVec3 &vFalloff)

const xiiVec3 &	GetNegativeFalloff () const

void	SetBoxProjection (bool bBoxProjection)

bool	GetBoxProjection () const

Public Member Functions inherited from xiiReflectionProbeComponentBase
void	SetReflectionProbeMode (xiiEnum< xiiReflectionProbeMode > mode)

xiiEnum< xiiReflectionProbeMode >	GetReflectionProbeMode () const

const xiiTagSet &	GetIncludeTags () const

void	InsertIncludeTag (xiiStringView sTag)

void	RemoveIncludeTag (xiiStringView sTag)

const xiiTagSet &	GetExcludeTags () const

void	InsertExcludeTag (xiiStringView sTag)

void	RemoveExcludeTag (xiiStringView sTag)

float	GetNearPlane () const

void	SetNearPlane (float fNearPlane)

float	GetFarPlane () const

void	SetFarPlane (float fFarPlane)

const xiiVec3 &	GetCaptureOffset () const

void	SetCaptureOffset (const xiiVec3 &vOffset)

void	SetShowDebugInfo (bool bShowDebugInfo)

bool	GetShowDebugInfo () const

void	SetShowMipMaps (bool bShowMipMaps)

bool	GetShowMipMaps () const

Public Member Functions inherited from xiiComponent
void	SetActiveFlag (bool bEnabled)
	Sets the active flag of the component, which affects its active state.

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'.

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

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

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

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

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.

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
virtual void	OnActivated () override
	This method is called when the component gets activated.

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

void	OnObjectCreated (const xiiAbstractObjectNode &node)

void	OnUpdateLocalBounds (xiiMsgUpdateLocalBounds &msg)

void	OnMsgExtractRenderData (xiiMsgExtractRenderData &msg) const

void	OnTransformChanged (xiiMsgTransformChanged &msg)

Protected Member Functions inherited from xiiReflectionProbeComponentBase
float	ComputePriority (xiiMsgExtractRenderData &msg, xiiReflectionProbeRenderData *pRenderData, float fVolume, const xiiVec3 &vScale) const

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 ()
	Can be overridden for basic initialization that depends on a valid hierarchy and position.

virtual void	Deinitialize ()
	This method is called before the component is destroyed. A derived type can override this method to do common de-initialization work.

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.

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

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

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

bool	IsInitialized () const

bool	IsInitializing () const

bool	IsSimulationStarted () const

Protected Attributes
xiiVec3	m_vExtents = xiiVec3(5.0f)

xiiVec3	m_vInfluenceScale = xiiVec3(1.0f)

xiiVec3	m_vInfluenceShift = xiiVec3(0.0f)

xiiVec3	m_vPositiveFalloff = xiiVec3(0.1f, 0.1f, 0.0f)

xiiVec3	m_vNegativeFalloff = xiiVec3(0.1f, 0.1f, 0.0f)

bool	m_bBoxProjection = true

Protected Attributes inherited from xiiReflectionProbeComponentBase
xiiReflectionProbeDesc	m_Desc

xiiReflectionProbeId	m_Id

bool	m_bStatesDirty = true

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 xiiNoBase
static const xiiRTTI *	GetStaticRTTI ()

Detailed Description

Box reflection probe component.

The generated reflection cube map is projected on a box defined by this component's extents. The influence volume can be smaller than the projection which is defined by a scale and shift parameter. Each side of the influence volume has a separate falloff parameter to smoothly blend the probe into others.

Member Function Documentation

◆ DeserializeComponent()

void xiiBoxReflectionProbeComponent::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 xiiReflectionProbeComponentBase.

◆ OnActivated()

void xiiBoxReflectionProbeComponent::OnActivated ( )

overrideprotectedvirtual

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 xiiComponent.

◆ OnDeactivated()

void xiiBoxReflectionProbeComponent::OnDeactivated ( )

overrideprotectedvirtual

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 xiiComponent.

◆ SerializeComponent()

void xiiBoxReflectionProbeComponent::SerializeComponent ( xiiWorldWriter & ref_stream ) const

overridevirtual

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

Reimplemented from xiiReflectionProbeComponentBase.

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

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

Public Member Functions

Protected Member Functions