#include <RenderComponent.h>

Inheritance diagram for xiiRenderComponent:

Public Member Functions
virtual xiiBitflags< xiiRenderExtractionCategory >	GetRenderExtractionCategories () const
virtual bool	IsRenderDataViewIndependent () const
virtual xiiResult	GetLocalBounds (xiiBoundingBoxSphere &out_bounds, bool &out_bAlwaysVisible, xiiMsgUpdateLocalBounds &ref_msg)=0
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.
virtual void	SerializeComponent (xiiWorldWriter &ref_stream) const
	Override this to save the current state of the component to the given stream.
virtual void	DeserializeComponent (xiiWorldReader &ref_stream)
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.

Static Public Member Functions
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 ()

Protected Member Functions
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

Additional Inherited Members
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.

Detailed Description

Base class for objects that should be rendered.

Member Function Documentation

◆ Deinitialize()

void xiiRenderComponent::Deinitialize ( )

overrideprotectedvirtual

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

This function is always called before destruction, even if the component is currently not active. The default implementation checks whether the component is currently active and will ensure OnDeactivated() gets called if necessary. For typical game code, prefer to use OnDeactivated().

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

Reimplemented from xiiComponent.

◆ GetLocalBounds()

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

pure virtual

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.

Implemented in xiiAlwaysVisibleComponent, xiiDecalComponent, xiiDirectionalLightComponent, xiiDiscAreaLightComponent, xiiMeshComponentBase, xiiParticleSystemComponent, xiiPointLightComponent, xiiRectangleAreaLightComponent, xiiReflectionCaptureComponent, xiiSkinnedMeshComponent, xiiSkyAtmosphereComponent, xiiSphereAreaLightComponent, xiiSpotLightComponent, xiiTubeAreaLightComponent, xiiVolumetricCloudComponent, and xiiVolumetricMediumComponent.

◆ IsRenderDataViewIndependent()

virtual bool xiiRenderComponent::IsRenderDataViewIndependent ( ) const

inlinevirtual

Opt in only when packets are independent of cameras and extraction requirement sets. Shared packets are immutable until the CPU rendering boundary has finished.

Reimplemented in xiiLightComponent, and xiiMeshComponentBase.

◆ OnActivated()

void xiiRenderComponent::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.

Reimplemented in xiiVolumetricMediumComponent.

◆ OnDeactivated()

void xiiRenderComponent::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.

Reimplemented in xiiVolumetricMediumComponent.

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

/home/runner/work/XII/XII/Source/Engine/GraphicsCore/Components/Render/RenderComponent.h
/home/runner/work/XII/XII/Source/Engine/GraphicsCore/Components/Render/Implementation/RenderComponent.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Deinitialize()

◆ GetLocalBounds()

◆ IsRenderDataViewIndependent()

◆ OnActivated()

◆ OnDeactivated()