FDebugDrawDelegateHelper Struct Reference

#include <DebugRenderSceneProxy.h>

Inheritance diagram for FDebugDrawDelegateHelper:

Public Member Functions
	FDebugDrawDelegateHelper ()
virtual	~FDebugDrawDelegateHelper ()
ENGINE_API void	InitDelegateHelper (const FDebugRenderSceneProxy *InSceneProxy)
ENGINE_API void	RequestRegisterDebugDrawDelegate (FRegisterComponentContext *Context)
ENGINE_API void	ProcessDeferredRegister ()
virtual ENGINE_API void	UnregisterDebugDrawDelegate ()
ENGINE_API void	ReregisterDebugDrawDelegate ()

Protected Types
enum	EState { UndefinedState , InitializedState , RegisteredState }
typedef TArray< FDebugRenderSceneProxy::FText3d >	TextArray

Protected Member Functions
virtual ENGINE_API void	RegisterDebugDrawDelegateInternal ()
ENGINE_API void	HandleDrawDebugLabels (UCanvas *Canvas, APlayerController *PlayerController)
virtual ENGINE_API void	DrawDebugLabels (UCanvas *Canvas, APlayerController *PlayerController)
void	ResetTexts ()
const TextArray &	GetTexts () const
float	GetTextWithoutShadowDistance () const
double	GetFarClippingDistance () const

Protected Attributes
FDebugDrawDelegate	DebugTextDrawingDelegate
FDelegateHandle	DebugTextDrawingDelegateHandle
enum FDebugDrawDelegateHelper::EState	State
bool	bDeferredRegister = false

Member Typedef Documentation

TextArray

typedef TArray<FDebugRenderSceneProxy::FText3d> FDebugDrawDelegateHelper::TextArray

protected

Member Enumeration Documentation

EState

enum FDebugDrawDelegateHelper::EState

protected

Enumerator
UndefinedState
InitializedState
RegisteredState

Constructor & Destructor Documentation

FDebugDrawDelegateHelper()

FDebugDrawDelegateHelper::FDebugDrawDelegateHelper ( )

inline

~FDebugDrawDelegateHelper()

virtual FDebugDrawDelegateHelper::~FDebugDrawDelegateHelper ( )

inlinevirtual

Member Function Documentation

DrawDebugLabels()

void FDebugDrawDelegateHelper::DrawDebugLabels ( UCanvas *  Canvas, APlayerController *  PlayerController  )

protectedvirtual

GetFarClippingDistance()

double FDebugDrawDelegateHelper::GetFarClippingDistance ( ) const

inlineprotected

GetTexts()

const TextArray & FDebugDrawDelegateHelper::GetTexts ( ) const

inlineprotected

GetTextWithoutShadowDistance()

float FDebugDrawDelegateHelper::GetTextWithoutShadowDistance ( ) const

inlineprotected

HandleDrawDebugLabels()

void FDebugDrawDelegateHelper::HandleDrawDebugLabels ( UCanvas *  Canvas, APlayerController *  PlayerController  )

protected

InitDelegateHelper()

void FDebugDrawDelegateHelper::InitDelegateHelper

(

const FDebugRenderSceneProxy *

InSceneProxy

)

ProcessDeferredRegister()

void FDebugDrawDelegateHelper::ProcessDeferredRegister

(

)

Method that should be called when creating scene proxy (i.e. CreateSceneProxy) to process any pending registration that might have been requested from deferred primitive batching (i.e. CreateRenderState_Concurrent(FRegisterComponentContext != nullptr)).

RegisterDebugDrawDelegateInternal()

void FDebugDrawDelegateHelper::RegisterDebugDrawDelegateInternal ( )

protectedvirtual

called to set up debug drawing delegate in UDebugDrawService if you want to draw labels

Reimplemented in FGameplayDebuggerDebugDrawDelegateHelper.

RequestRegisterDebugDrawDelegate()

void FDebugDrawDelegateHelper::RequestRegisterDebugDrawDelegate

(

FRegisterComponentContext *

Context

)

Method that should be called at render state creation (i.e. CreateRenderState_Concurrent). It will either call RegisterDebugDrawDelegate when deferring context is not provided or mark for deferred registration that should be flushed by calling ProcessDeferredRegister on scene proxy creation.

Parameters

Context

valid context is provided when primitives are batched for deferred 'add'

ReregisterDebugDrawDelegate()

void FDebugDrawDelegateHelper::ReregisterDebugDrawDelegate

(

)

ResetTexts()

void FDebugDrawDelegateHelper::ResetTexts ( )

inlineprotected

UnregisterDebugDrawDelegate()

void FDebugDrawDelegateHelper::UnregisterDebugDrawDelegate ( )

virtual

called to clean up debug drawing delegate in UDebugDrawService

Reimplemented in FGameplayDebuggerDebugDrawDelegateHelper.

Member Data Documentation

bDeferredRegister

bool FDebugDrawDelegateHelper::bDeferredRegister = false

protected

DebugTextDrawingDelegate

FDebugDrawDelegate FDebugDrawDelegateHelper::DebugTextDrawingDelegate

protected

DebugTextDrawingDelegateHandle

FDelegateHandle FDebugDrawDelegateHelper::DebugTextDrawingDelegateHandle

protected

State

enum FDebugDrawDelegateHelper::EState FDebugDrawDelegateHelper::State

protected

---

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

• Engine/Source/Runtime/Engine/Public/DebugRenderSceneProxy.h
• Engine/Source/Runtime/Engine/Private/DebugRenderSceneProxy.cpp