A Demo Project for the UnrealEngineSDK
Loading...
Searching...
No Matches
UVRLogComponent Class ReferenceBlueprintable

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

#include <VRLogComponent.h>

Inheritance diagram for UVRLogComponent:
[legend]

Public Member Functions

 UVRLogComponent (const FObjectInitializer &ObjectInitializer)
 
 ~UVRLogComponent ()
 
void AppendTextToConsole (FString Text, bool bReturnAtEnd=false)
 UFUNCTION(BlueprintCallable, Category = "VRLogComponent|Console", meta = (bIgnoreSelf = "true"))
 
void DrawConsole (bool bLowerHalfOnly, UCanvas *Canvas)
 
bool DrawConsoleToRenderTarget2D (EBPVRConsoleDrawType DrawType, UTextureRenderTarget2D *Texture, float ScrollOffset, bool bForceDraw)
 UFUNCTION(BlueprintCallable, Category = "VRLogComponent|Console", meta = (bIgnoreSelf = "true", DisplayName = "DrawConsoleToCanvasRenderTarget2D"))
 
void DrawOutputLog (bool bUpperHalfOnly, UCanvas *Canvas, float ScrollOffset)
 
virtual void PostInitProperties () override
 
void SendKeyEventToConsole (FKey Key, EInputEvent KeyEvent)
 UFUNCTION(BlueprintCallable, Category = "VRLogComponent|Console", meta = (bIgnoreSelf = "true"))
 
void SetConsoleText (FString Text)
 UFUNCTION(BlueprintCallable, Category = "VRLogComponent|Console", meta = (bIgnoreSelf = "true"))
 

Public Attributes

int32 MaxLineLength
 UPROPERTY(BlueprintReadWrite,EditAnywhere, Category = "VRLogComponent|Console")
 
int32 MaxStoredMessages
 UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "VRLogComponent|Console")
 
FVROutputLogHistory OutputLogHistory
 

Private Member Functions

 GENERATED_BODY ()
 

Detailed Description

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

This class taps into the output log and console and renders them to textures so they can be viewed in levels. Generally used for debugging and testing in VR, also allows sending input to the console.

Definition at line 203 of file VRLogComponent.h.

Constructor & Destructor Documentation

◆ UVRLogComponent()

UVRLogComponent::UVRLogComponent ( const FObjectInitializer & ObjectInitializer)

Definition at line 10 of file VRLogComponent.cpp.

◆ ~UVRLogComponent()

UVRLogComponent::~UVRLogComponent ( )

Definition at line 19 of file VRLogComponent.cpp.

Member Function Documentation

◆ AppendTextToConsole()

void UVRLogComponent::AppendTextToConsole ( FString Text,
bool bReturnAtEnd = false )
BlueprintCallable

UFUNCTION(BlueprintCallable, Category = "VRLogComponent|Console", meta = (bIgnoreSelf = "true"))

Definition at line 49 of file VRLogComponent.cpp.

◆ DrawConsole()

void UVRLogComponent::DrawConsole ( bool bLowerHalfOnly,
UCanvas * Canvas )

Definition at line 134 of file VRLogComponent.cpp.

Here is the caller graph for this function:

◆ DrawConsoleToRenderTarget2D()

bool UVRLogComponent::DrawConsoleToRenderTarget2D ( EBPVRConsoleDrawType DrawType,
UTextureRenderTarget2D * Texture,
float ScrollOffset,
bool bForceDraw )
BlueprintCallable

UFUNCTION(BlueprintCallable, Category = "VRLogComponent|Console", meta = (bIgnoreSelf = "true", DisplayName = "DrawConsoleToCanvasRenderTarget2D"))

Definition at line 67 of file VRLogComponent.cpp.

Here is the call graph for this function:

◆ DrawOutputLog()

void UVRLogComponent::DrawOutputLog ( bool bUpperHalfOnly,
UCanvas * Canvas,
float ScrollOffset )

Definition at line 144 of file VRLogComponent.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GENERATED_BODY()

UVRLogComponent::GENERATED_BODY ( )
private

◆ PostInitProperties()

virtual void UVRLogComponent::PostInitProperties ( )
inlineoverridevirtual

Definition at line 215 of file VRLogComponent.h.

◆ SendKeyEventToConsole()

void UVRLogComponent::SendKeyEventToConsole ( FKey Key,
EInputEvent KeyEvent )
BlueprintCallable

UFUNCTION(BlueprintCallable, Category = "VRLogComponent|Console", meta = (bIgnoreSelf = "true"))

Definition at line 37 of file VRLogComponent.cpp.

◆ SetConsoleText()

void UVRLogComponent::SetConsoleText ( FString Text)
BlueprintCallable

UFUNCTION(BlueprintCallable, Category = "VRLogComponent|Console", meta = (bIgnoreSelf = "true"))

Definition at line 25 of file VRLogComponent.cpp.

Member Data Documentation

◆ MaxLineLength

int32 UVRLogComponent::MaxLineLength
BlueprintReadWriteEditAnywhere

UPROPERTY(BlueprintReadWrite,EditAnywhere, Category = "VRLogComponent|Console")

Definition at line 227 of file VRLogComponent.h.

◆ MaxStoredMessages

int32 UVRLogComponent::MaxStoredMessages
BlueprintReadWriteEditAnywhere

UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "VRLogComponent|Console")

Definition at line 234 of file VRLogComponent.h.

◆ OutputLogHistory

FVROutputLogHistory UVRLogComponent::OutputLogHistory

Definition at line 213 of file VRLogComponent.h.


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