Controls reminder widget in the PixoCore module. More...

#include <ControlsReminderWidget.h>

Inheritance diagram for UControlsReminderWidget:

Public Member Functions
const FGuid &	GetGuid () const

const FString &	GetWidgetInfoName ()
	UFUNCTION(BlueprintCallable)

virtual void	Init (UBasicWidgetInfo *WidgetInfo) override
	Initializes the widget with the provided widget information.

virtual void	NativeOnInitialized () override

virtual void	OnClickExitMenuEvent (FText ButtonName)
	Event handler for the "ExitMenu" button click event.

virtual void	PlayerWentAwayHandler (const float SquaredDistanceToPlayerCm)
	Handler for when the player goes away.

void	ProcessSquaredDistanceToPlayer (const float SquaredDistanceToPlayerCm, const float DeltaSec)
	Processes the squared distance to the player.

void	SetCustomGuid (const FGuid &NewGuid)

Public Attributes
FExitMenuEventDelegate	OnExitMenuEventDelegate
	Event delegate for the "ExitMenu" event.

FOnPlayerWentAway	OnPlayerWentAway
	Event for when the player goes away.

Protected Member Functions
void	PlayerWentAway ()
	UFUNCTION(BlueprintNativeEvent, meta=(DisplayName="PlayerWentAwayHandler"))

Protected Attributes
UImage *	DeviceImage
	UPROPERTY(BlueprintReadWrite, Meta = (BindWidget))

FText	Heading = FText::FromString(TEXT("Heading"))
	UPROPERTY(BlueprintReadWrite)

float	MaxDistanceCalculationDelaySec = 5.0f
	UPROPERTY(BlueprintReadWrite)

Private Member Functions
	GENERATED_BODY ()

void	SetImage (UImage Image, UTexture2D Texture) const
	Sets the image of the device image widget.

Private Attributes
bool	bIsClosingByDistance = false
	Flag indicating if the widget should be closed by distance.

float	DistanceCalculationDelay = 0.0f

int32	MaxSquaredClosingDistance = -1

FGuid	WidgetGuid

FString	WidgetInfoName
	Name of widget info used for creating this widget.

Detailed Description

Controls reminder widget in the PixoCore module.

UCLASS()

Definition at line 18 of file ControlsReminderWidget.h.

Member Function Documentation

◆ GENERATED_BODY()

UControlsReminderWidget::GENERATED_BODY ( )

private

◆ GetGuid()

const FGuid & UBasicWidget::GetGuid ( ) const

inlineinherited

Definition at line 47 of file BasicWidget.h.

Here is the caller graph for this function:

◆ GetWidgetInfoName()

const FString & UBasicWidget::GetWidgetInfoName ( )

inlineinheritedBlueprintCallable

UFUNCTION(BlueprintCallable)

Definition at line 44 of file BasicWidget.h.

◆ Init()

void UControlsReminderWidget::Init ( UBasicWidgetInfo * WidgetInfo )

overridevirtual

Initializes the widget with the provided widget information.

Parameters

WidgetInfo The widget information.

Reimplemented from UBasicWidget.

Definition at line 10 of file ControlsReminderWidget.cpp.

Here is the call graph for this function:

◆ NativeOnInitialized()

PRAGMA_DISABLE_OPTIMIZATION void UBasicWidget::NativeOnInitialized ( )

overridevirtualinherited

Reimplemented in UButtonListWidget.

Definition at line 11 of file BasicWidget.cpp.

◆ OnClickExitMenuEvent()

void UBasicWidget::OnClickExitMenuEvent ( FText ButtonName )

virtualinherited

Event handler for the "ExitMenu" button click event.

Parameters

ButtonName The name of the clicked button.

UFUNCTION(Category = "Buttons")

Definition at line 51 of file BasicWidget.cpp.

Here is the caller graph for this function:

◆ PlayerWentAway()

void UBasicWidget::PlayerWentAway ( )

protectedinheritedBlueprintNativeEvent

UFUNCTION(BlueprintNativeEvent, meta=(DisplayName="PlayerWentAwayHandler"))

◆ PlayerWentAwayHandler()

virtual void UBasicWidget::PlayerWentAwayHandler ( const float SquaredDistanceToPlayerCm )

inlinevirtualinherited

Handler for when the player goes away.

Parameters

SquaredDistanceToPlayerCm The squared distance to the player in centimeters.

Definition at line 68 of file BasicWidget.h.

Here is the caller graph for this function:

◆ ProcessSquaredDistanceToPlayer()

void UBasicWidget::ProcessSquaredDistanceToPlayer	(	const float	SquaredDistanceToPlayerCm,
		const float	DeltaSec )

inherited

Processes the squared distance to the player.

Parameters

SquaredDistanceToPlayerCm	The squared distance to the player in centimeters.
DeltaSec	The time elapsed since the last update.

Definition at line 29 of file BasicWidget.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetCustomGuid()

void UBasicWidget::SetCustomGuid ( const FGuid & NewGuid )

inlineinherited

Definition at line 46 of file BasicWidget.h.

Here is the caller graph for this function:

◆ SetImage()

void UControlsReminderWidget::SetImage	(	UImage *	Image,
		UTexture2D *	Texture ) const

private

Sets the image of the device image widget.

Parameters

Image	The device image widget.
Texture	The texture to set as the image.

Definition at line 21 of file ControlsReminderWidget.cpp.

Here is the caller graph for this function:

Member Data Documentation

◆ bIsClosingByDistance

bool UBasicWidget::bIsClosingByDistance = false

privateinherited

Flag indicating if the widget should be closed by distance.

Definition at line 106 of file BasicWidget.h.

◆ DeviceImage

UImage* UControlsReminderWidget::DeviceImage

protectedBlueprintReadWrite

UPROPERTY(BlueprintReadWrite, Meta = (BindWidget))

Controls image for specific device.

Definition at line 34 of file ControlsReminderWidget.h.

◆ DistanceCalculationDelay

float UBasicWidget::DistanceCalculationDelay = 0.0f

privateinherited

Definition at line 108 of file BasicWidget.h.

◆ Heading

FText UBasicWidget::Heading = FText::FromString(TEXT("Heading"))

protectedinheritedBlueprintReadWrite

UPROPERTY(BlueprintReadWrite)

Heading of the widget

Definition at line 94 of file BasicWidget.h.

◆ MaxDistanceCalculationDelaySec

float UBasicWidget::MaxDistanceCalculationDelaySec = 5.0f

protectedinheritedBlueprintReadWrite

UPROPERTY(BlueprintReadWrite)

How frequently should we check closing distance.

Definition at line 99 of file BasicWidget.h.

◆ MaxSquaredClosingDistance

int32 UBasicWidget::MaxSquaredClosingDistance = -1

privateinherited

Definition at line 107 of file BasicWidget.h.

◆ OnExitMenuEventDelegate

FExitMenuEventDelegate UBasicWidget::OnExitMenuEventDelegate

inherited

Event delegate for the "ExitMenu" event.

Todo: Investigate and probably remove because not all widgets have exit.

Definition at line 86 of file BasicWidget.h.

◆ OnPlayerWentAway

FOnPlayerWentAway UBasicWidget::OnPlayerWentAway

inherited

Event for when the player goes away.

Definition at line 87 of file BasicWidget.h.

◆ WidgetGuid

FGuid UBasicWidget::WidgetGuid

privateinherited

Definition at line 103 of file BasicWidget.h.

◆ WidgetInfoName

FString UBasicWidget::WidgetInfoName

privateinherited

Name of widget info used for creating this widget.

Definition at line 102 of file BasicWidget.h.

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

SDKDemo/Plugins/UnrealEngineSDK/PixoCore/Source/PixoCore/Public/UI/ControlsReminder/ControlsReminderWidget.h
SDKDemo/Plugins/UnrealEngineSDK/PixoCore/Source/PixoCore/Private/UI/ControlsReminder/ControlsReminderWidget.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ GENERATED_BODY()

◆ GetGuid()

◆ GetWidgetInfoName()

◆ Init()

◆ NativeOnInitialized()

◆ OnClickExitMenuEvent()

◆ PlayerWentAway()

◆ PlayerWentAwayHandler()

◆ ProcessSquaredDistanceToPlayer()

◆ SetCustomGuid()

◆ SetImage()

Member Data Documentation

◆ bIsClosingByDistance

◆ DeviceImage

◆ DistanceCalculationDelay

◆ Heading

◆ MaxDistanceCalculationDelaySec

◆ MaxSquaredClosingDistance

◆ OnExitMenuEventDelegate

◆ OnPlayerWentAway

◆ WidgetGuid

◆ WidgetInfoName