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

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

#include <SteamVRKeyboardComponent.h>

Inheritance diagram for USteamVRKeyboardComponent:
[legend]

Public Member Functions

 USteamVRKeyboardComponent (const FObjectInitializer &ObjectInitializer)
 
 ~USteamVRKeyboardComponent ()
 
void CloseVRKeyboard (EBPOVRResultSwitch &Result)
 UFUNCTION(BlueprintCallable, Category = "VRExpansionFunctions|SteamVR", meta = (bIgnoreSelf = "true", ExpandEnumAsExecs = "Result"))
 
 GENERATED_BODY ()
 
void GetVRKeyboardText (FString &Text, EBPOVRResultSwitch &Result)
 UFUNCTION(BlueprintCallable, Category = "VRExpansionFunctions|SteamVR", meta = (bIgnoreSelf = "true", ExpandEnumAsExecs = "Result"))
 
virtual void OnUnregister () override
 
void OpenVRKeyboard (bool bIsForPassword, bool bIsMultiline, bool bUseMinimalMode, bool bIsRightHand, int32 MaxCharacters, FString Description, FString StartingString, EBPOVRResultSwitch &Result)
 UFUNCTION(BlueprintCallable, Category = "VRExpansionFunctions|SteamVR", meta = (bIgnoreSelf = "true", ExpandEnumAsExecs = "Result"))
 
void ReOpenVRKeyboardForUser (bool bIsForPassword, bool bIsMultiline, bool bUseMinimalMode, bool bIsRightHand, int32 MaxCharacters, FString Description, FString StartingString, EBPOVRResultSwitch &Result)
 UFUNCTION(BlueprintCallable, Category = "VRExpansionFunctions|SteamVR", meta = (bIgnoreSelf = "true", ExpandEnumAsExecs = "Result"))
 
virtual void TickComponent (float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction) override
 

Public Attributes

FVRKeyboardStringCallbackSignature OnKeyboardCharInput
 UPROPERTY(BlueprintAssignable, Category = "VRExpansionFunctions|SteamVR")
 
FVRKeyboardNullCallbackSignature OnKeyboardClosed
 UPROPERTY(BlueprintAssignable, Category = "VRExpansionFunctions|SteamVR")
 
FVRKeyboardStringCallbackSignature OnKeyboardDone
 UPROPERTY(BlueprintAssignable, Category = "VRExpansionFunctions|SteamVR")
 

Detailed Description

UCLASS(Blueprintable, meta = (BlueprintSpawnableComponent))

Allows displaying / hiding and sending input to and from the SteamVR keyboard. Has events for keyboard inputs Generally outdated with the data table based keyboards I added, but still useful.

Definition at line 29 of file SteamVRKeyboardComponent.h.

Constructor & Destructor Documentation

◆ USteamVRKeyboardComponent()

USteamVRKeyboardComponent::USteamVRKeyboardComponent ( const FObjectInitializer & ObjectInitializer)

Definition at line 12 of file SteamVRKeyboardComponent.cpp.

◆ ~USteamVRKeyboardComponent()

USteamVRKeyboardComponent::~USteamVRKeyboardComponent ( )

Definition at line 21 of file SteamVRKeyboardComponent.cpp.

Member Function Documentation

◆ CloseVRKeyboard()

void USteamVRKeyboardComponent::CloseVRKeyboard ( EBPOVRResultSwitch & Result)
inlineBlueprintCallable

UFUNCTION(BlueprintCallable, Category = "VRExpansionFunctions|SteamVR", meta = (bIgnoreSelf = "true", ExpandEnumAsExecs = "Result"))

Definition at line 159 of file SteamVRKeyboardComponent.h.

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

◆ GENERATED_BODY()

USteamVRKeyboardComponent::GENERATED_BODY ( )

◆ GetVRKeyboardText()

void USteamVRKeyboardComponent::GetVRKeyboardText ( FString & Text,
EBPOVRResultSwitch & Result )
inlineBlueprintCallable

UFUNCTION(BlueprintCallable, Category = "VRExpansionFunctions|SteamVR", meta = (bIgnoreSelf = "true", ExpandEnumAsExecs = "Result"))

Definition at line 259 of file SteamVRKeyboardComponent.h.

Here is the call graph for this function:

◆ OnUnregister()

void USteamVRKeyboardComponent::OnUnregister ( )
overridevirtual

Definition at line 25 of file SteamVRKeyboardComponent.cpp.

Here is the call graph for this function:

◆ OpenVRKeyboard()

void USteamVRKeyboardComponent::OpenVRKeyboard ( bool bIsForPassword,
bool bIsMultiline,
bool bUseMinimalMode,
bool bIsRightHand,
int32 MaxCharacters,
FString Description,
FString StartingString,
EBPOVRResultSwitch & Result )
inlineBlueprintCallable

UFUNCTION(BlueprintCallable, Category = "VRExpansionFunctions|SteamVR", meta = (bIgnoreSelf = "true", ExpandEnumAsExecs = "Result"))

Definition at line 73 of file SteamVRKeyboardComponent.h.

Here is the call graph for this function:

◆ ReOpenVRKeyboardForUser()

void USteamVRKeyboardComponent::ReOpenVRKeyboardForUser ( bool bIsForPassword,
bool bIsMultiline,
bool bUseMinimalMode,
bool bIsRightHand,
int32 MaxCharacters,
FString Description,
FString StartingString,
EBPOVRResultSwitch & Result )
inlineBlueprintCallable

UFUNCTION(BlueprintCallable, Category = "VRExpansionFunctions|SteamVR", meta = (bIgnoreSelf = "true", ExpandEnumAsExecs = "Result"))

Definition at line 202 of file SteamVRKeyboardComponent.h.

Here is the call graph for this function:

◆ TickComponent()

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

Definition at line 39 of file SteamVRKeyboardComponent.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ OnKeyboardCharInput

FVRKeyboardStringCallbackSignature USteamVRKeyboardComponent::OnKeyboardCharInput
BlueprintAssignable

UPROPERTY(BlueprintAssignable, Category = "VRExpansionFunctions|SteamVR")

Definition at line 65 of file SteamVRKeyboardComponent.h.

◆ OnKeyboardClosed

FVRKeyboardNullCallbackSignature USteamVRKeyboardComponent::OnKeyboardClosed
BlueprintAssignable

UPROPERTY(BlueprintAssignable, Category = "VRExpansionFunctions|SteamVR")

Definition at line 59 of file SteamVRKeyboardComponent.h.

◆ OnKeyboardDone

FVRKeyboardStringCallbackSignature USteamVRKeyboardComponent::OnKeyboardDone
BlueprintAssignable

UPROPERTY(BlueprintAssignable, Category = "VRExpansionFunctions|SteamVR")

Definition at line 53 of file SteamVRKeyboardComponent.h.

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