A Demo Project for the UnrealEngineSDK
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | Friends | List of all members
UVRStereoWidgetComponent Class ReferenceBlueprintable

UCLASS(Blueprintable, meta = (BlueprintSpawnableComponent), ClassGroup = (VRExpansionPlugin)) More...

#include <VRStereoWidgetComponent.h>

Inheritance diagram for UVRStereoWidgetComponent:
[legend]

Public Member Functions

 UVRStereoWidgetComponent (const FObjectInitializer &ObjectInitializer)
 
 ~UVRStereoWidgetComponent ()
 
void ApplyVRComponentInstanceData (class FVRStereoWidgetComponentInstanceData *WidgetInstanceData)
 
void BeginDestroy () override
 
virtual FPrimitiveSceneProxy * CreateSceneProxy () override
 
virtual void DrawWidgetToRenderTarget (float DeltaTime) override
 
virtual TStructOnScope< FActorComponentInstanceData > GetComponentInstanceData () const override
 
int32 GetPriority () const
 UFUNCTION(BlueprintCallable, Category = "Components|Stereo Layer")
 
void OnUnregister () override
 
void SetPriority (int32 InPriority)
 UFUNCTION(BlueprintCallable, Category = "Components|Stereo Layer")
 
virtual void TickComponent (float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction) override
 
virtual void UpdateRenderTarget (FIntPoint DesiredRenderTargetSize) override
 

Public Attributes

bool bDelayForRenderThread
 UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "StereoLayer")
 
bool bDrawWithoutStereo
 UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "StereoLayer")
 
bool bIsSleeping
 UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "StereoLayer")
 
uint32 bNoAlphaChannel: 1
 UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "StereoLayer")
 
uint32 bQuadPreserveTextureRatio: 1
 UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "StereoLayer")
 
bool bRenderBothStereoAndWorld
 UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "StereoLayer")
 
bool bShouldCreateProxy
 
uint32 bSupportsDepth: 1
 UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "StereoLayer")
 
bool bUseEpicsWorldLockedStereo
 UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "StereoLayer")
 
int32 Priority
 UPROPERTY(EditAnywhere, BlueprintReadOnly, export, Category = "StereoLayer | Cylinder Overlay Properties")
 
UStereoLayerShape * Shape
 UPROPERTY(EditAnywhere, BlueprintReadOnly, NoClear, Instanced, Category = "StereoLayer", DisplayName = "Stereo Layer Shape")
 
FBox2D UVRect
 

Private Member Functions

 GENERATED_BODY ()
 

Private Attributes

bool bDirtyRenderTarget
 
bool bIsDirty
 
bool bLastVisible
 
bool bTextureNeedsUpdate
 
FTransform LastTransform
 
uint32 LayerId
 

Friends

class FStereoLayerComponentVisualizer
 

Detailed Description

UCLASS(Blueprintable, meta = (BlueprintSpawnableComponent), ClassGroup = (VRExpansionPlugin))

A widget component that displays the widget in a stereo layer instead of in worldspace. Currently this class uses a custom postion instead of the engines WorldLocked for stereo layers This is because world locked stereo layers don't account for player movement currently.

Definition at line 154 of file VRStereoWidgetComponent.h.

Constructor & Destructor Documentation

◆ UVRStereoWidgetComponent()

UVRStereoWidgetComponent::UVRStereoWidgetComponent ( const FObjectInitializer & ObjectInitializer)

Definition at line 355 of file VRStereoWidgetComponent.cpp.

◆ ~UVRStereoWidgetComponent()

UVRStereoWidgetComponent::~UVRStereoWidgetComponent ( )

Definition at line 394 of file VRStereoWidgetComponent.cpp.

Member Function Documentation

◆ ApplyVRComponentInstanceData()

void UVRStereoWidgetComponent::ApplyVRComponentInstanceData ( class FVRStereoWidgetComponentInstanceData * WidgetInstanceData)

Definition at line 1132 of file VRStereoWidgetComponent.cpp.

◆ BeginDestroy()

void UVRStereoWidgetComponent::BeginDestroy ( )
override

Definition at line 398 of file VRStereoWidgetComponent.cpp.

◆ CreateSceneProxy()

FPrimitiveSceneProxy * UVRStereoWidgetComponent::CreateSceneProxy ( )
overridevirtual

Definition at line 1082 of file VRStereoWidgetComponent.cpp.

◆ DrawWidgetToRenderTarget()

void UVRStereoWidgetComponent::DrawWidgetToRenderTarget ( float DeltaTime)
overridevirtual

Definition at line 423 of file VRStereoWidgetComponent.cpp.

◆ GENERATED_BODY()

UVRStereoWidgetComponent::GENERATED_BODY ( )
private

◆ GetComponentInstanceData()

TStructOnScope< FActorComponentInstanceData > UVRStereoWidgetComponent::GetComponentInstanceData ( ) const
overridevirtual

Definition at line 1127 of file VRStereoWidgetComponent.cpp.

◆ GetPriority()

int32 UVRStereoWidgetComponent::GetPriority ( ) const
inlineBlueprintCallable

UFUNCTION(BlueprintCallable, Category = "Components|Stereo Layer")

Definition at line 244 of file VRStereoWidgetComponent.h.

◆ OnUnregister()

void UVRStereoWidgetComponent::OnUnregister ( )
override

Definition at line 411 of file VRStereoWidgetComponent.cpp.

◆ SetPriority()

void UVRStereoWidgetComponent::SetPriority ( int32 InPriority)
BlueprintCallable

UFUNCTION(BlueprintCallable, Category = "Components|Stereo Layer")

Change the layer's render priority, higher priorities render on top of lower priorities

Parameters
InPriorityPriority value

Definition at line 765 of file VRStereoWidgetComponent.cpp.

◆ TickComponent()

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

Definition at line 430 of file VRStereoWidgetComponent.cpp.

Here is the call graph for this function:

◆ UpdateRenderTarget()

void UVRStereoWidgetComponent::UpdateRenderTarget ( FIntPoint DesiredRenderTargetSize)
overridevirtual

Definition at line 776 of file VRStereoWidgetComponent.cpp.

Friends And Related Symbol Documentation

◆ FStereoLayerComponentVisualizer

friend class FStereoLayerComponentVisualizer
friend

Definition at line 161 of file VRStereoWidgetComponent.h.

Member Data Documentation

◆ bDelayForRenderThread

bool UVRStereoWidgetComponent::bDelayForRenderThread
EditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "StereoLayer")

Definition at line 219 of file VRStereoWidgetComponent.h.

◆ bDirtyRenderTarget

bool UVRStereoWidgetComponent::bDirtyRenderTarget
private

Definition at line 324 of file VRStereoWidgetComponent.h.

◆ bDrawWithoutStereo

bool UVRStereoWidgetComponent::bDrawWithoutStereo
EditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "StereoLayer")

Forces the widget to skip stereo regardless of all other settings (localized version of vr.ForceNoStereoWithVRWidgets)

Definition at line 202 of file VRStereoWidgetComponent.h.

◆ bIsDirty

bool UVRStereoWidgetComponent::bIsDirty
private

Dirty state determines whether the stereo layer needs updating

Definition at line 323 of file VRStereoWidgetComponent.h.

◆ bIsSleeping

bool UVRStereoWidgetComponent::bIsSleeping
EditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "StereoLayer")

Definition at line 227 of file VRStereoWidgetComponent.h.

◆ bLastVisible

bool UVRStereoWidgetComponent::bLastVisible
private

Last frames visiblity state

Definition at line 336 of file VRStereoWidgetComponent.h.

◆ bNoAlphaChannel

uint32 UVRStereoWidgetComponent::bNoAlphaChannel
EditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "StereoLayer")

True if the texture should not use its own alpha channel (1.0 will be substituted)

Definition at line 260 of file VRStereoWidgetComponent.h.

◆ bQuadPreserveTextureRatio

uint32 UVRStereoWidgetComponent::bQuadPreserveTextureRatio
EditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "StereoLayer")

True if the quad should internally set it's Y value based on the set texture's dimensions

Definition at line 268 of file VRStereoWidgetComponent.h.

◆ bRenderBothStereoAndWorld

bool UVRStereoWidgetComponent::bRenderBothStereoAndWorld
EditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "StereoLayer")

Definition at line 194 of file VRStereoWidgetComponent.h.

◆ bShouldCreateProxy

bool UVRStereoWidgetComponent::bShouldCreateProxy

Definition at line 319 of file VRStereoWidgetComponent.h.

◆ bSupportsDepth

uint32 UVRStereoWidgetComponent::bSupportsDepth
EditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "StereoLayer")

True if the stereo layer needs to support depth intersections with the scene geometry, if available on the platform

Definition at line 252 of file VRStereoWidgetComponent.h.

◆ bTextureNeedsUpdate

bool UVRStereoWidgetComponent::bTextureNeedsUpdate
private

Texture needs to be marked for update

Definition at line 327 of file VRStereoWidgetComponent.h.

◆ bUseEpicsWorldLockedStereo

bool UVRStereoWidgetComponent::bUseEpicsWorldLockedStereo
EditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "StereoLayer")

Definition at line 210 of file VRStereoWidgetComponent.h.

◆ LastTransform

FTransform UVRStereoWidgetComponent::LastTransform
private

Last transform is cached to determine if the new frames transform has changed

Definition at line 333 of file VRStereoWidgetComponent.h.

◆ LayerId

uint32 UVRStereoWidgetComponent::LayerId
private

IStereoLayer id, 0 is unassigned

Definition at line 330 of file VRStereoWidgetComponent.h.

◆ Priority

int32 UVRStereoWidgetComponent::Priority
EditAnywhereexportBlueprintReadOnly

UPROPERTY(EditAnywhere, BlueprintReadOnly, export, Category = "StereoLayer | Cylinder Overlay Properties")

Radial size of the rendered stereo layer cylinder Arc angle for the stereo layer cylinder Height of the stereo layer cylinder Specifies how and where the quad is rendered to the screen Specifies which type of layer it is. Note that some shapes will be supported only on certain platforms! Render priority among all stereo layers, higher priority render on top of lower priority

UPROPERTY(EditAnywhere, BlueprintReadOnly, export, Category = "StereoLayer")

Definition at line 317 of file VRStereoWidgetComponent.h.

◆ Shape

UStereoLayerShape* UVRStereoWidgetComponent::Shape
EditAnywhereNoClearBlueprintReadOnlyInstanced

UPROPERTY(EditAnywhere, BlueprintReadOnly, NoClear, Instanced, Category = "StereoLayer", DisplayName = "Stereo Layer Shape")

Specifies which shape of layer it is. Note that some shapes will be supported only on certain platforms!

Definition at line 174 of file VRStereoWidgetComponent.h.

◆ UVRect

FBox2D UVRStereoWidgetComponent::UVRect

Texture displayed on the stereo layer (is stereocopic textures are supported on the platfrom and more than one texture is provided, this will be the right eye) Texture displayed on the stereo layer for left eye, if stereoscopic textures are supported on the platform Size of the rendered stereo layer quad UV coordinates mapped to the quad face

Definition at line 287 of file VRStereoWidgetComponent.h.

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