FSlateInvalidationRoot Class Reference

#include <SlateInvalidationRoot.h>

Inheritance diagram for FSlateInvalidationRoot:

Public Member Functions
SLATECORE_API	FSlateInvalidationRoot ()
virtual SLATECORE_API	~FSlateInvalidationRoot ()
virtual SLATECORE_API void	AddReferencedObjects (FReferenceCollector &Collector) override
virtual SLATECORE_API FString	GetReferencerName () const override
SLATECORE_API void	InvalidateRootChildOrder (const SWidget *Investigator=nullptr)
SLATECORE_API void	InvalidateRootLayout (const SWidget *Investigator=nullptr)
SLATECORE_API void	InvalidateScreenPosition (const SWidget *Investigator=nullptr)
bool	NeedsSlowPath () const
FHittestGrid *	GetHittestGrid () const
FSlateCachedElementData &	GetCachedElements ()
const FSlateCachedElementData &	GetCachedElements () const
const SWidget *	GetInvalidationRootWidget () const
FSlateInvalidationRootHandle	GetInvalidationRootHandle () const
const FSlateInvalidationWidgetList &	GetFastPathWidgetList () const
SLATECORE_API const TSharedPtr< SWidget >	GetFastPathWidgetListRoot () const
SLATECORE_API FSlateInvalidationResult	PaintInvalidationRoot (const FSlateInvalidationContext &Context)
void	OnWidgetDestroyed (const SWidget *Widget)
SLATECORE_API void	Advanced_ResetInvalidation (bool bClearResourcesImmediately)
Public Member Functions inherited from FGCObject
	FGCObject ()
	FGCObject (const FGCObject &Other)
	FGCObject (FGCObject &&Other)
	FGCObject (EFlags Flags)
virtual	~FGCObject ()
FGCObject &	operator= (const FGCObject &)
FGCObject &	operator= (FGCObject &&)
COREUOBJECT_API void	RegisterGCObject ()
COREUOBJECT_API void	UnregisterGCObject ()
virtual bool	GetReferencerPropertyName (UObject *Object, FString &OutPropertyName) const

Protected Member Functions
virtual TSharedRef< SWidget >	GetRootWidget ()=0
virtual int32	PaintSlowPath (const FSlateInvalidationContext &Context)=0
void	SetInvalidationRootWidget (SWidget &InInvalidationRootWidget)
void	SetInvalidationRootHittestGrid (FHittestGrid &InHittestGrid)
int32	GetCachedMaxLayerId () const
SLATECORE_API bool	ProcessInvalidation ()
SLATECORE_API void	ClearAllFastPathData (bool bClearResourcesImmediately)
virtual void	OnRootInvalidated ()
SLATECORE_API void	SetNeedsSlowPath (bool InNeedsSlowPath)
Protected Member Functions inherited from FNoncopyable
	FNoncopyable ()
	~FNoncopyable ()

Friends
class	FSlateUpdateFastWidgetPathTask
class	FSlateUpdateFastPathAndHitTestGridTask
class	FWidgetProxyHandle

Additional Inherited Members
Public Types inherited from FGCObject
enum class	EFlags : uint32 { None = 0 , RegisterLater = 1 << 0 , AddStableNativeReferencesOnly = 1 << 1 }
Static Public Member Functions inherited from FGCObject
static COREUOBJECT_API void	StaticInit ()
Static Public Attributes inherited from FGCObject
static COREUOBJECT_API UGCObjectReferencer *	GGCObjectReferencer = nullptr

Constructor & Destructor Documentation

FSlateInvalidationRoot()

FSlateInvalidationRoot::FSlateInvalidationRoot

(

)

~FSlateInvalidationRoot()

FSlateInvalidationRoot::~FSlateInvalidationRoot ( )

virtual

Member Function Documentation

AddReferencedObjects()

void FSlateInvalidationRoot::AddReferencedObjects ( FReferenceCollector &  Collector )

overridevirtual

Pure virtual that must be overloaded by the inheriting class. Use this method to serialize any UObjects contained that you wish to keep around.

Parameters

Collector

The collector of referenced objects.

Implements FGCObject.

Advanced_ResetInvalidation()

void FSlateInvalidationRoot::Advanced_ResetInvalidation

(

bool

bClearResourcesImmediately

)

ClearAllFastPathData()

void FSlateInvalidationRoot::ClearAllFastPathData ( bool  bClearResourcesImmediately )

protected

GetCachedElements() [1/2]

FSlateCachedElementData & FSlateInvalidationRoot::GetCachedElements ( )

inline

Returns

the cached draw elements for this window and its widget hierarchy.

GetCachedElements() [2/2]

const FSlateCachedElementData & FSlateInvalidationRoot::GetCachedElements ( ) const

inline

Returns

the cached draw elements for this window and its widget hierarchy.

GetCachedMaxLayerId()

int32 FSlateInvalidationRoot::GetCachedMaxLayerId ( ) const

inlineprotected

GetFastPathWidgetList()

const FSlateInvalidationWidgetList & FSlateInvalidationRoot::GetFastPathWidgetList ( ) const

inline

Returns

the list of widgets that are controlled by the InvalidationRoot.

GetFastPathWidgetListRoot()

const TSharedPtr< SWidget > FSlateInvalidationRoot::GetFastPathWidgetListRoot

(

)

const

Returns

the widget that is the root of the InvalidationRoot.

GetHittestGrid()

FHittestGrid * FSlateInvalidationRoot::GetHittestGrid ( ) const

inline

Returns

the HittestGrid of the InvalidationRoot.

GetInvalidationRootHandle()

FSlateInvalidationRootHandle FSlateInvalidationRoot::GetInvalidationRootHandle ( ) const

inline

Returns

the Handle of the InvalidationRoot.

GetInvalidationRootWidget()

const SWidget * FSlateInvalidationRoot::GetInvalidationRootWidget ( ) const

inline

Returns

the invalidation root as a widget.

GetReferencerName()

FString FSlateInvalidationRoot::GetReferencerName ( ) const

overridevirtual

Overload this method to report a name for your referencer

Implements FGCObject.

GetRootWidget()

virtual TSharedRef< SWidget > FSlateInvalidationRoot::GetRootWidget ( )

protectedpure virtual

Returns

the children root widget of the Invalidation root.

Implemented in SInvalidationPanel, SWindow, and SRetainerWidget.

InvalidateRootChildOrder()

void FSlateInvalidationRoot::InvalidateRootChildOrder

(

const SWidget *

Investigator = nullptr

)

Rebuild the list and request a SlowPath.

InvalidateRootLayout()

void FSlateInvalidationRoot::InvalidateRootLayout

(

const SWidget *

Investigator = nullptr

)

Invalidate the layout, forcing the parent of the InvalidationRoot to be repainted.

InvalidateScreenPosition()

void FSlateInvalidationRoot::InvalidateScreenPosition

(

const SWidget *

Investigator = nullptr

)

Update the screen position of the SWidget owning the InvalidationRoot. This is faster then doing a SlowPath when only the DesktopGeometry changed.

NeedsSlowPath()

bool FSlateInvalidationRoot::NeedsSlowPath ( ) const

inline

Returns

if the InvalidationRoot will be rebuild, Prepass() and Paint will be called.

OnRootInvalidated()

virtual void FSlateInvalidationRoot::OnRootInvalidated ( )

inlineprotectedvirtual

Reimplemented in SRetainerWidget.

OnWidgetDestroyed()

void FSlateInvalidationRoot::OnWidgetDestroyed

(

const SWidget *

Widget

)

PaintInvalidationRoot()

FSlateInvalidationResult FSlateInvalidationRoot::PaintInvalidationRoot

(

const FSlateInvalidationContext &

Context

)

Returns

the cached draw elements for this window and its widget hierarchy

PaintSlowPath()

virtual int32 FSlateInvalidationRoot::PaintSlowPath ( const FSlateInvalidationContext &  Context )

protectedpure virtual

Implemented in SInvalidationPanel, SRetainerWidget, and SWindow.

ProcessInvalidation()

bool FSlateInvalidationRoot::ProcessInvalidation ( )

protected

SetInvalidationRootHittestGrid()

void FSlateInvalidationRoot::SetInvalidationRootHittestGrid ( FHittestGrid &  InHittestGrid )

inlineprotected

SetInvalidationRootWidget()

void FSlateInvalidationRoot::SetInvalidationRootWidget ( SWidget &  InInvalidationRootWidget )

inlineprotected

SetNeedsSlowPath()

void FSlateInvalidationRoot::SetNeedsSlowPath ( bool  InNeedsSlowPath )

protected

Friends And Related Symbol Documentation

FSlateUpdateFastPathAndHitTestGridTask

friend class FSlateUpdateFastPathAndHitTestGridTask

friend

FSlateUpdateFastWidgetPathTask

friend class FSlateUpdateFastWidgetPathTask

friend

FWidgetProxyHandle

friend class FWidgetProxyHandle

friend

---

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

• Engine/Source/Runtime/SlateCore/Public/FastUpdate/SlateInvalidationRoot.h
• Engine/Source/Runtime/SlateCore/Private/FastUpdate/SlateInvalidationRoot.cpp