#include <NullApplication.h>

Inheritance diagram for FNullApplication:

Public Member Functions
virtual APPLICATIONCORE_API	~FNullApplication ()

virtual APPLICATIONCORE_API void	DestroyApplication () override

virtual APPLICATIONCORE_API bool	Exec_Dev (UWorld InWorld, const TCHAR Cmd, FOutputDevice &Ar) override

APPLICATIONCORE_API TSharedPtr< FNullWindow >	FindWindowByPtr (FGenericWindow *WindowToFind)

APPLICATIONCORE_API void	ActivateWindow (const TSharedPtr< FNullWindow > &Window)

virtual APPLICATIONCORE_API void	SetMessageHandler (const TSharedRef< class FGenericApplicationMessageHandler > &InMessageHandler) override

virtual APPLICATIONCORE_API void	PollGameDeviceState (const float TimeDelta) override

virtual APPLICATIONCORE_API void	PumpMessages (const float TimeDelta) override

virtual APPLICATIONCORE_API void	ProcessDeferredEvents (const float TimeDelta) override

virtual APPLICATIONCORE_API TSharedRef< FGenericWindow >	MakeWindow () override

virtual APPLICATIONCORE_API void	InitializeWindow (const TSharedRef< FGenericWindow > &Window, const TSharedRef< FGenericWindowDefinition > &InDefinition, const TSharedPtr< FGenericWindow > &InParent, const bool bShowImmediately) override

APPLICATIONCORE_API void	DestroyWindow (TSharedRef< FNullWindow > WindowToRemove)

virtual APPLICATIONCORE_API void	SetCapture (const TSharedPtr< FGenericWindow > &InWindow) override

virtual APPLICATIONCORE_API void *	GetCapture (void) const override

virtual APPLICATIONCORE_API void	SetHighPrecisionMouseMode (const bool Enable, const TSharedPtr< FGenericWindow > &InWindow) override

virtual bool	IsUsingHighPrecisionMouseMode () const override

virtual APPLICATIONCORE_API bool	IsGamepadAttached () const override

virtual APPLICATIONCORE_API FModifierKeysState	GetModifierKeys () const override

virtual APPLICATIONCORE_API FPlatformRect	GetWorkArea (const FPlatformRect &CurrentWindow) const override

APPLICATIONCORE_API void	SetWorkArea (const FPlatformRect &NewWorkArea)

virtual EWindowTransparency	GetWindowTransparencySupport () const override

virtual APPLICATIONCORE_API bool	IsCursorDirectlyOverSlateWindow () const override

virtual APPLICATIONCORE_API TSharedPtr< FGenericWindow >	GetWindowUnderCursor () override

virtual bool	IsMouseAttached () const override

virtual IInputInterface *	GetInputInterface () override

virtual APPLICATIONCORE_API void	SetForceFeedbackChannelValue (int32 ControllerId, FForceFeedbackChannelType ChannelType, float Value) override

virtual APPLICATIONCORE_API void	SetForceFeedbackChannelValues (int32 ControllerId, const FForceFeedbackValues &Values) override

virtual APPLICATIONCORE_API void	SetHapticFeedbackValues (int32 ControllerId, int32 Hand, const FHapticFeedbackValues &Values) override

virtual void	SetLightColor (int32 ControllerId, FColor Color) override

virtual void	ResetLightColor (int32 ControllerId) override

Public Member Functions inherited from GenericApplication
	DECLARE_MULTICAST_DELEGATE_OneParam (FOnConsoleCommandAdded, const FString &)

APPLICATIONCORE_API	GenericApplication (const TSharedPtr< ICursor > &InCursor)

virtual APPLICATIONCORE_API	~GenericApplication ()

TSharedRef< FGenericApplicationMessageHandler >	GetMessageHandler ()

virtual void	Tick (const float TimeDelta)

virtual bool	IsMinimized () const

virtual bool	IsUsingTrackpad () const

virtual void	RegisterConsoleCommandListener (const FOnConsoleCommandListener &InListener)

virtual void	AddPendingConsoleCommand (const FString &InCommand)

virtual bool	TryCalculatePopupWindowPosition (const FPlatformRect &InAnchor, const FVector2D &InSize, const FVector2D &ProposedPlacement, const EPopUpOrientation::Type Orientation, FVector2D *const CalculatedPopUpPosition) const

	DECLARE_EVENT_OneParam (GenericApplication, FOnDisplayMetricsChanged, const FDisplayMetrics &)

FOnDisplayMetricsChanged &	OnDisplayMetricsChanged ()

virtual void	GetInitialDisplayMetrics (FDisplayMetrics &OutDisplayMetrics) const

	DECLARE_EVENT_OneParam (FSlateApplication, FVirtualKeyboardShownEvent, FPlatformRect)

FVirtualKeyboardShownEvent &	OnVirtualKeyboardShown ()

	DECLARE_EVENT (FSlateApplication, FVirtualKeyboardHiddenEvent)

FVirtualKeyboardHiddenEvent &	OnVirtualKeyboardHidden ()

	DECLARE_EVENT (FSlateApplication, FOnClipboardContentChanged)

FOnClipboardContentChanged &	OnClipboardContentChanged ()

virtual EWindowTitleAlignment::Type	GetWindowTitleAlignment () const

virtual ITextInputMethodSystem *	GetTextInputMethodSystem ()

virtual void	SendAnalytics (IAnalyticsProvider *Provider)

virtual bool	SupportsSystemHelp () const

virtual void	ShowSystemHelp ()

virtual bool	ApplicationLicenseValid (FPlatformUserId PlatformUser=PLATFORMUSERID_NONE)

virtual bool	IsAllowedToRender () const

virtual void	FinishedInputThisFrame ()

Public Member Functions inherited from FSelfRegisteringExec
CORE_API	FSelfRegisteringExec ()

virtual CORE_API	~FSelfRegisteringExec ()

Public Member Functions inherited from FExec
virtual CORE_API	~FExec ()

virtual CORE_API bool	Exec (UWorld InWorld, const TCHAR Cmd, FOutputDevice &Ar)

Public Member Functions inherited from IInputInterface
virtual	~IInputInterface ()

virtual void	SetDeviceProperty (int32 ControllerId, const FInputDeviceProperty *Property)

Static Public Member Functions
static APPLICATIONCORE_API FNullApplication *	CreateNullApplication ()

static APPLICATIONCORE_API void	MoveWindowTo (FGenericWindow *Window, const int32 X, const int32 Y)

static APPLICATIONCORE_API void	OnSizeChanged (FGenericWindow *Window, const int32 Width, const int32 Height)

static APPLICATIONCORE_API void	GetFullscreenInfo (int32 &X, int32 &Y, int32 &Width, int32 &Height)

static APPLICATIONCORE_API void	ShowWindow (FGenericWindow *Window)

static APPLICATIONCORE_API void	HideWindow (FGenericWindow *Window)

static APPLICATIONCORE_API void	DestroyWindow (FGenericWindow *Window)

Static Public Member Functions inherited from FSelfRegisteringExec
static CORE_API bool	StaticExec (UWorld Inworld, const TCHAR Cmd, FOutputDevice &Ar)

Additional Inherited Members
Public Types inherited from GenericApplication
typedef FOnConsoleCommandAdded::FDelegate	FOnConsoleCommandListener

Public Attributes inherited from GenericApplication
const TSharedPtr< ICursor >	Cursor

Protected Member Functions inherited from GenericApplication
void	BroadcastDisplayMetricsChanged (const FDisplayMetrics &InMetrics)

Protected Member Functions inherited from FExec
virtual bool	Exec_Runtime (UWorld InWorld, const TCHAR Cmd, FOutputDevice &Ar)

virtual bool	Exec_Editor (UWorld InWorld, const TCHAR Cmd, FOutputDevice &Ar)

Protected Attributes inherited from GenericApplication
TSharedRef< class FGenericApplicationMessageHandler >	MessageHandler

FOnDisplayMetricsChanged	OnDisplayMetricsChangedEvent

FVirtualKeyboardShownEvent	VirtualKeyboardShownEvent

FVirtualKeyboardHiddenEvent	VirtualKeyboardHiddenEvent

FOnClipboardContentChanged	OnClipboardContentChangedEvent

Detailed Description

An implementation of GenericApplication specifically for use when rendering off screen. This application has no platform backing so instead keeps track of its associated NullWindows itself.

Constructor & Destructor Documentation

◆ ~FNullApplication()

FNullApplication::~FNullApplication ( )

virtual

Member Function Documentation

◆ ActivateWindow()

void FNullApplication::ActivateWindow ( const TSharedPtr< FNullWindow > & Window )

◆ CreateNullApplication()

FNullApplication * FNullApplication::CreateNullApplication ( )

static

◆ DestroyApplication()

void FNullApplication::DestroyApplication ( )

overridevirtual

Reimplemented from GenericApplication.

◆ DestroyWindow() [1/2]

void FNullApplication::DestroyWindow ( FGenericWindow * Window )

static

◆ DestroyWindow() [2/2]

void FNullApplication::DestroyWindow ( TSharedRef< FNullWindow > WindowToRemove )

◆ Exec_Dev()

bool FNullApplication::Exec_Dev	(	UWorld *	InWorld,
		const TCHAR *	Cmd,
		FOutputDevice &	Ar
	)

overridevirtual

Implementation of Exec that is only called in non-shipping targets

Reimplemented from FExec.

◆ FindWindowByPtr()

TSharedPtr< FNullWindow > FNullApplication::FindWindowByPtr ( FGenericWindow * WindowToFind )

◆ GetCapture()

void * FNullApplication::GetCapture ( void ) const

overridevirtual

Reimplemented from GenericApplication.

◆ GetFullscreenInfo()

void FNullApplication::GetFullscreenInfo	(	int32 &	X,
		int32 &	Y,
		int32 &	Width,
		int32 &	Height
	)

static

◆ GetInputInterface()

virtual IInputInterface * FNullApplication::GetInputInterface ( )

inlineoverridevirtual

Reimplemented from GenericApplication.

◆ GetModifierKeys()

FModifierKeysState FNullApplication::GetModifierKeys ( ) const

overridevirtual

Reimplemented from GenericApplication.

◆ GetWindowTransparencySupport()

virtual EWindowTransparency FNullApplication::GetWindowTransparencySupport ( ) const

inlineoverridevirtual

Reimplemented from GenericApplication.

◆ GetWindowUnderCursor()

TSharedPtr< FGenericWindow > FNullApplication::GetWindowUnderCursor ( )

overridevirtual

Returns: Native window under the mouse cursor.

Reimplemented from GenericApplication.

◆ GetWorkArea()

FPlatformRect FNullApplication::GetWorkArea ( const FPlatformRect & CurrentWindow ) const

overridevirtual

Reimplemented from GenericApplication.

◆ HideWindow()

void FNullApplication::HideWindow ( FGenericWindow * Window )

static

◆ InitializeWindow()

void FNullApplication::InitializeWindow	(	const TSharedRef< FGenericWindow > &	Window,
		const TSharedRef< FGenericWindowDefinition > &	InDefinition,
		const TSharedPtr< FGenericWindow > &	InParent,
		const bool	bShowImmediately
	)

overridevirtual

Reimplemented from GenericApplication.

◆ IsCursorDirectlyOverSlateWindow()

bool FNullApplication::IsCursorDirectlyOverSlateWindow ( ) const

overridevirtual

Returns: true if the system cursor is currently directly over a slate window.

Reimplemented from GenericApplication.

◆ IsGamepadAttached()

bool FNullApplication::IsGamepadAttached ( ) const

overridevirtual

Reimplemented from GenericApplication.

◆ IsMouseAttached()

virtual bool FNullApplication::IsMouseAttached ( ) const

inlineoverridevirtual

Reimplemented from GenericApplication.

◆ IsUsingHighPrecisionMouseMode()

virtual bool FNullApplication::IsUsingHighPrecisionMouseMode ( ) const

inlineoverridevirtual

Reimplemented from GenericApplication.

◆ MakeWindow()

TSharedRef< FGenericWindow > FNullApplication::MakeWindow ( )

overridevirtual

Reimplemented from GenericApplication.

◆ MoveWindowTo()

void FNullApplication::MoveWindowTo	(	FGenericWindow *	Window,
		const int32	X,
		const int32	Y
	)

static

◆ OnSizeChanged()

void FNullApplication::OnSizeChanged	(	FGenericWindow *	Window,
		const int32	Width,
		const int32	Height
	)

static

◆ PollGameDeviceState()

void FNullApplication::PollGameDeviceState ( const float TimeDelta )

overridevirtual

Reimplemented from GenericApplication.

◆ ProcessDeferredEvents()

void FNullApplication::ProcessDeferredEvents ( const float TimeDelta )

overridevirtual

Reimplemented from GenericApplication.

◆ PumpMessages()

void FNullApplication::PumpMessages ( const float TimeDelta )

overridevirtual

Reimplemented from GenericApplication.

◆ ResetLightColor()

virtual void FNullApplication::ResetLightColor ( int32 ControllerId )

inlineoverridevirtual

Implements IInputInterface.

◆ SetCapture()

void FNullApplication::SetCapture ( const TSharedPtr< FGenericWindow > & InWindow )

overridevirtual

Reimplemented from GenericApplication.

◆ SetForceFeedbackChannelValue()

void FNullApplication::SetForceFeedbackChannelValue	(	int32	ControllerId,
		FForceFeedbackChannelType	ChannelType,
		float	Value
	)

overridevirtual

Sets the strength/speed of the given channel for the given controller id. NOTE: If the channel is not supported, the call will silently fail

Parameters

ControllerId	the id of the controller whose value is to be set
ChannelType	the type of channel whose value should be set
Value	strength or speed of feedback, 0.0f to 1.0f. 0.0f will disable

Implements IInputInterface.

◆ SetForceFeedbackChannelValues()

void FNullApplication::SetForceFeedbackChannelValues	(	int32	ControllerId,
		const FForceFeedbackValues &	Values
	)

overridevirtual

Sets the strength/speed of all the channels for the given controller id. NOTE: Unsupported channels are silently ignored

Parameters

ControllerId	the id of the controller whose value is to be set
FForceFeedbackChannelValues	strength or speed of feedback for all channels

Implements IInputInterface.

◆ SetHapticFeedbackValues()

void FNullApplication::SetHapticFeedbackValues	(	int32	ControllerId,
		int32	Hand,
		const FHapticFeedbackValues &	Values
	)

overridevirtual

Sets the frequency and amplitude of haptic feedback channels for a given controller id. Some devices / platforms may support just haptics, or just force feedback.

Parameters

ControllerId	ID of the controller to issue haptic feedback for
HandId	Which hand id (e.g. left or right) to issue the feedback for. These usually correspond to EControllerHands
Values	Frequency and amplitude to haptics at

Reimplemented from IInputInterface.

◆ SetHighPrecisionMouseMode()

void FNullApplication::SetHighPrecisionMouseMode	(	const bool	Enable,
		const TSharedPtr< FGenericWindow > &	InWindow
	)

overridevirtual

Reimplemented from GenericApplication.

◆ SetLightColor()

virtual void FNullApplication::SetLightColor	(	int32	ControllerId,
		FColor	Color
	)

inlineoverridevirtual

Implements IInputInterface.

◆ SetMessageHandler()

void FNullApplication::SetMessageHandler ( const TSharedRef< class FGenericApplicationMessageHandler > & InMessageHandler )

overridevirtual

Reimplemented from GenericApplication.

◆ SetWorkArea()

void FNullApplication::SetWorkArea ( const FPlatformRect & NewWorkArea )

◆ ShowWindow()

void FNullApplication::ShowWindow ( FGenericWindow * Window )

static

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

Engine/Source/Runtime/ApplicationCore/Public/Null/NullApplication.h
Engine/Source/Runtime/ApplicationCore/Private/Null/NullApplication.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~FNullApplication()

Member Function Documentation

◆ ActivateWindow()

◆ CreateNullApplication()

◆ DestroyApplication()

◆ DestroyWindow() [1/2]

◆ DestroyWindow() [2/2]

◆ Exec_Dev()

◆ FindWindowByPtr()

◆ GetCapture()

◆ GetFullscreenInfo()

◆ GetInputInterface()

◆ GetModifierKeys()

◆ GetWindowTransparencySupport()

◆ GetWindowUnderCursor()

◆ GetWorkArea()

◆ HideWindow()

◆ InitializeWindow()

◆ IsCursorDirectlyOverSlateWindow()

◆ IsGamepadAttached()

◆ IsMouseAttached()

◆ IsUsingHighPrecisionMouseMode()

◆ MakeWindow()

◆ MoveWindowTo()

◆ OnSizeChanged()

◆ PollGameDeviceState()

◆ ProcessDeferredEvents()

◆ PumpMessages()

◆ ResetLightColor()

◆ SetCapture()

◆ SetForceFeedbackChannelValue()

◆ SetForceFeedbackChannelValues()

◆ SetHapticFeedbackValues()

◆ SetHighPrecisionMouseMode()

◆ SetLightColor()

◆ SetMessageHandler()

◆ SetWorkArea()

◆ ShowWindow()