UCLASS(Blueprintable, meta = (BlueprintSpawnableComponent), ClassGroup = (VRExpansionPlugin), HideCategories = ("Stereoscopic Properties", Collision)) More...

#include <VRStereoWidgetComponent.h>

Inheritance diagram for UVRStereoWidgetRenderComponent:

[legend]

Public Member Functions
	UVRStereoWidgetRenderComponent (const FObjectInitializer &ObjectInitializer)

virtual void	BeginPlay () override

virtual void	DestroyComponent (bool bPromoteChildren) override

virtual void	EndPlay (const EEndPlayReason::Type EndPlayReason) override

void	InitWidget ()

void	OnLevelRemovedFromWorld (ULevel InLevel, UWorld InWorld)

void	ReleaseResources ()

void	RenderWidget (float DeltaTime)

void	SetWidgetAndInit (TSubclassOf< UUserWidget > NewWidgetClass)
	UFUNCTION(BlueprintCallable, Category = "WidgetSettings")

virtual void	TickComponent (float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction) override

Public Attributes
bool	bDrawAtDesiredSize
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "WidgetSettings", meta = (ExposeOnSpawn = true))

bool	bDrawWithoutStereo
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "WidgetSettings", meta = (ExposeOnSpawn = true))

bool	bUseGammaCorrection
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "WidgetSettings", meta = (ExposeOnSpawn = true))

float	DrawCounter

float	DrawRate
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "WidgetSettings", meta = (ExposeOnSpawn = true))

UTextureRenderTarget2D *	RenderTarget
	UPROPERTY(BlueprintReadOnly, Transient, DuplicateTransient, Category = "WidgetSettings")

FLinearColor	RenderTargetClearColor
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "WidgetSettings", meta = (ExposeOnSpawn = true))

TSharedPtr< SWidget >	SlateWidget

TSharedPtr< class SVirtualWindow >	SlateWindow

UUserWidget *	Widget
	UPROPERTY(Transient, DuplicateTransient)

TSubclassOf< UUserWidget >	WidgetClass
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "WidgetSettings", meta = (ExposeOnSpawn = true))

class FWidgetRenderer *	WidgetRenderer

float	WidgetRenderGamma
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "WidgetSettings", meta = (ExposeOnSpawn = true))

float	WidgetRenderScale
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "WidgetSettings", meta = (ExposeOnSpawn = true))

Private Member Functions
	GENERATED_BODY ()

Detailed Description

UCLASS(Blueprintable, meta = (BlueprintSpawnableComponent), ClassGroup = (VRExpansionPlugin), HideCategories = ("Stereoscopic Properties", Collision))

A stereo component that displays a widget instead of a texture.

Definition at line 28 of file VRStereoWidgetComponent.h.

Constructor & Destructor Documentation

◆ UVRStereoWidgetRenderComponent()

UVRStereoWidgetRenderComponent::UVRStereoWidgetRenderComponent ( const FObjectInitializer & ObjectInitializer )

Definition at line 46 of file VRStereoWidgetComponent.cpp.

Member Function Documentation

◆ BeginPlay()

void UVRStereoWidgetRenderComponent::BeginPlay ( )

overridevirtual

Definition at line 101 of file VRStereoWidgetComponent.cpp.

Here is the call graph for this function:

◆ DestroyComponent()

void UVRStereoWidgetRenderComponent::DestroyComponent ( bool bPromoteChildren )

overridevirtual

Definition at line 163 of file VRStereoWidgetComponent.cpp.

Here is the call graph for this function:

◆ EndPlay()

void UVRStereoWidgetRenderComponent::EndPlay ( const EEndPlayReason::Type EndPlayReason )

overridevirtual

Definition at line 121 of file VRStereoWidgetComponent.cpp.

Here is the call graph for this function:

◆ GENERATED_BODY()

UVRStereoWidgetRenderComponent::GENERATED_BODY ( )

private

◆ InitWidget()

void UVRStereoWidgetRenderComponent::InitWidget ( )

Definition at line 187 of file VRStereoWidgetComponent.cpp.

Here is the caller graph for this function:

◆ OnLevelRemovedFromWorld()

void UVRStereoWidgetRenderComponent::OnLevelRemovedFromWorld	(	ULevel *	InLevel,
		UWorld *	InWorld )

Definition at line 176 of file VRStereoWidgetComponent.cpp.

Here is the call graph for this function:

◆ ReleaseResources()

void UVRStereoWidgetRenderComponent::ReleaseResources ( )

CanReceiveHardwareInput() &&

Definition at line 128 of file VRStereoWidgetComponent.cpp.

Here is the caller graph for this function:

◆ RenderWidget()

void UVRStereoWidgetRenderComponent::RenderWidget ( float DeltaTime )

Definition at line 276 of file VRStereoWidgetComponent.cpp.

Here is the caller graph for this function:

◆ SetWidgetAndInit()

void UVRStereoWidgetRenderComponent::SetWidgetAndInit ( TSubclassOf< UUserWidget > NewWidgetClass )

BlueprintCallable

UFUNCTION(BlueprintCallable, Category = "WidgetSettings")

Definition at line 170 of file VRStereoWidgetComponent.cpp.

Here is the call graph for this function:

◆ TickComponent()

void UVRStereoWidgetRenderComponent::TickComponent	(	float	DeltaTime,
		enum ELevelTick	TickType,
		FActorComponentTickFunction *	ThisTickFunction )

overridevirtual

Definition at line 63 of file VRStereoWidgetComponent.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ bDrawAtDesiredSize

bool UVRStereoWidgetRenderComponent::bDrawAtDesiredSize

EditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "WidgetSettings", meta = (ExposeOnSpawn = true))

If true then we sample the requested size of the widget and reset the texture to be that size

Definition at line 57 of file VRStereoWidgetComponent.h.

◆ bDrawWithoutStereo

bool UVRStereoWidgetRenderComponent::bDrawWithoutStereo

EditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "WidgetSettings", meta = (ExposeOnSpawn = true))

If true we will draw to the render target even without active stereo layers and skip the stereo tick

Definition at line 97 of file VRStereoWidgetComponent.h.

◆ bUseGammaCorrection

bool UVRStereoWidgetRenderComponent::bUseGammaCorrection

EditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "WidgetSettings", meta = (ExposeOnSpawn = true))

Automatically correct for gamma

Definition at line 81 of file VRStereoWidgetComponent.h.

◆ DrawCounter

float UVRStereoWidgetRenderComponent::DrawCounter

Definition at line 108 of file VRStereoWidgetComponent.h.

◆ DrawRate

float UVRStereoWidgetRenderComponent::DrawRate

EditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "WidgetSettings", meta = (ExposeOnSpawn = true))

Rate (HTZ) we should draw the texture at

Definition at line 105 of file VRStereoWidgetComponent.h.

◆ RenderTarget

UTextureRenderTarget2D* UVRStereoWidgetRenderComponent::RenderTarget

BlueprintReadOnlyTransientDuplicateTransient

UPROPERTY(BlueprintReadOnly, Transient, DuplicateTransient, Category = "WidgetSettings")

The render target being display

Definition at line 122 of file VRStereoWidgetComponent.h.

◆ RenderTargetClearColor

FLinearColor UVRStereoWidgetRenderComponent::RenderTargetClearColor

EditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "WidgetSettings", meta = (ExposeOnSpawn = true))

The desired clear color of the render target

Definition at line 89 of file VRStereoWidgetComponent.h.

◆ SlateWidget

TSharedPtr<SWidget> UVRStereoWidgetRenderComponent::SlateWidget

The Slate widget to be displayed by this component. Only one of either Widget or SlateWidget can be used

Definition at line 111 of file VRStereoWidgetComponent.h.

◆ SlateWindow

TSharedPtr<class SVirtualWindow> UVRStereoWidgetRenderComponent::SlateWindow

The slate window that contains the user widget content

Definition at line 125 of file VRStereoWidgetComponent.h.

◆ Widget

UUserWidget* UVRStereoWidgetRenderComponent::Widget

TransientDuplicateTransient

UPROPERTY(Transient, DuplicateTransient)

The User Widget object displayed and managed by this component

Definition at line 49 of file VRStereoWidgetComponent.h.

◆ WidgetClass

TSubclassOf<UUserWidget> UVRStereoWidgetRenderComponent::WidgetClass

EditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "WidgetSettings", meta = (ExposeOnSpawn = true))

The class of User Widget to create and display an instance of

Definition at line 41 of file VRStereoWidgetComponent.h.

◆ WidgetRenderer

class FWidgetRenderer* UVRStereoWidgetRenderComponent::WidgetRenderer

Definition at line 113 of file VRStereoWidgetComponent.h.

◆ WidgetRenderGamma

float UVRStereoWidgetRenderComponent::WidgetRenderGamma

EditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "WidgetSettings", meta = (ExposeOnSpawn = true))

The desired render gamma of the widget

Definition at line 73 of file VRStereoWidgetComponent.h.

◆ WidgetRenderScale

float UVRStereoWidgetRenderComponent::WidgetRenderScale

EditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "WidgetSettings", meta = (ExposeOnSpawn = true))

The desired render scale of the widget

Definition at line 65 of file VRStereoWidgetComponent.h.

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

SDKDemo/Plugins/UnrealEngineSDK/VRExpansionPlugin/VRExpansionPlugin/Source/VRExpansionPlugin/Public/VRStereoWidgetComponent.h
SDKDemo/Plugins/UnrealEngineSDK/VRExpansionPlugin/VRExpansionPlugin/Source/VRExpansionPlugin/Private/VRStereoWidgetComponent.cpp

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ UVRStereoWidgetRenderComponent()

Member Function Documentation

◆ BeginPlay()

◆ DestroyComponent()

◆ EndPlay()

◆ GENERATED_BODY()

◆ InitWidget()

◆ OnLevelRemovedFromWorld()

◆ ReleaseResources()

◆ RenderWidget()

◆ SetWidgetAndInit()

◆ TickComponent()

Member Data Documentation

◆ bDrawAtDesiredSize

◆ bDrawWithoutStereo

◆ bUseGammaCorrection

◆ DrawCounter

◆ DrawRate

◆ RenderTarget

◆ RenderTargetClearColor

◆ SlateWidget

◆ SlateWindow

◆ Widget

◆ WidgetClass

◆ WidgetRenderer

◆ WidgetRenderGamma

◆ WidgetRenderScale