1. Epic GamesDeveloper
  3. UVPBlueprintLibrary

UVPBlueprintLibrary

Functionality added to prototype the VR scouting tools

API > API/Plugins > API/Plugins/VPUtilities

Functionality added to prototype the VR scouting tools

   
Name UVPBlueprintLibrary
Type class
Header File /Engine/Plugins/Experimental/VirtualProductionUtilities/Source/VPUtilities/Public/Libraries/VPBlueprintLibrary.h
Include Path #include "Libraries/VPBlueprintLibrary.h"

Syntax

UCLASS ()  
class UVPBlueprintLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static bool EditorDeleteSelectedObjects()

 Trigger an UnrealEd Delete Libraries/VPBlueprintLibrary.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="Use UEditorActorSubsystem::DeleteSelectedActors instead.")

static bool EditorDuplicate()

 Trigger an UnrealEd Duplicate Libraries/VPBlueprintLibrary.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="Use UEditorActorSubsystem::DuplicateSelectedActors instead.")

static bool EditorRedo()

 Trigger an UnrealEd Redo Libraries/VPBlueprintLibrary.h
  • BlueprintCallable
  • Category="Virtual Production"

static bool EditorUndo()

 Trigger an UnrealEd Undo Libraries/VPBlueprintLibrary.h
  • BlueprintCallable
  • Category="Virtual Production"

static FTransform GetEditorViewportTransform()

 Get the location of the 2D viewport camera Libraries/VPBlueprintLibrary.h
  • BlueprintCallable
  • Category="Virtual Production"

static FTransform GetEditorVRHeadTransform()

 Get the location of the VR HMD Libraries/VPBlueprintLibrary.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="VR Editor mode is deprecated; use the XR Creative Framework plugin instead.")

static FTransform GetEditorVRRoomTransform()

 Get the VR room transform (the playable area shown as a wireframe cage on Vive and Rift Libraries/VPBlueprintLibrary.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="VR Editor mode is deprecated; use the XR Creative Framework plugin instead.")

static UWorld * GetEditorWorld ()

 Wrapper around UUnrealEditorSubsystem::GetEditorWorld. Libraries/VPBlueprintLibrary.h
  • BlueprintCallable
  • Category="Virtual Production"

static FVector GetLeftInteractorLocation()

 Get the location of the left interactor, in world space Libraries/VPBlueprintLibrary.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="VR Editor mode is deprecated; use the XR Creative Framework plugin instead.")

static FGameplayTagContainer GetVirtualProductionRole()

 The machine role(s) in a virtual production context. Libraries/VPBlueprintLibrary.h
  • BlueprintCallable
  • Category="Virtual Production"

static FVector GetVREditorLaserHoverLocation()

 Get the hitlocation of the interaction controller's laser pointer, in world space Libraries/VPBlueprintLibrary.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="VR Editor mode is deprecated; use the XR Creative Framework plugin instead.")

static bool IsVREditorModeActive()

 Get whether the user is in editor VR mode Libraries/VPBlueprintLibrary.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="VR Editor mode is deprecated; use the XR Creative Framework plugin instead.")

static bool JumpToBookmarkInLevelEditor ( const UVPBookmark* Bookmark
)

 Jump to a virtual production bookmark Libraries/VPBlueprintLibrary.h
  • BlueprintCallable
  • Category="Virtual Production"

static void Refresh3DEditorViewport()

 Refresh the desktop 3D viewport so that it updates changes even when not set to 'Realtime' Libraries/VPBlueprintLibrary.h
  • BlueprintCallable
  • Category="Virtual Production"

static void SetGrabSpeed ( const float Speed
)

 Set the VR grab speed cvar Libraries/VPBlueprintLibrary.h
  • BlueprintCallable
  • Category="Virtual Production"
  • Meta=(DeprecatedFunction, DeprecationMessage="VR Editor mode is deprecated; use the XR Creative Framework plugin instead.")

static void SortActorsByName ( TArray< AActor* >& Actors,
bool Ascending
)

 Sort actors by actor label Libraries/VPBlueprintLibrary.h
  • BlueprintCallable
  • Category="VPBookmarks"

static void SortVPBookmarkActorsByTimestamp ( TArray< AVPBookmarkActor* >& Actors,
bool Ascending
)

 Sort VPBookmarkActors by Timestamp parameter Libraries/VPBlueprintLibrary.h
  • BlueprintCallable
  • Category="VPBookmarks"

static AActor * SpawnBookmarkAtCurrentLevelEditorPosition ( const TSubclassOf< AActor > ActorClass,
const FVPBookmarkCreationContext CreationContext,
const FVector Offset,
const bool bFlattenRotation
)

 Spawn a virtual production bookmark Libraries/VPBlueprintLibrary.h
  • BlueprintCallable
  • Category="Virtual Production"

static AVPViewportTickableActorBase * SpawnVPTickableActor ( UObject* ContextObject,
const TSubclassOf< AVPViewportTickableActorBase > ActorClass,
const FVector Location,
const FRotator Rotation
)

 Spawn a virtual production tickable actor Libraries/VPBlueprintLibrary.h
  • BlueprintCallable
  • Category="Virtual Production"

static void VPBookmarkSplineMeshIndicatorDisable ( USplineMeshComponent* SplineMesh
)

   Libraries/VPBlueprintLibrary.h
  • BlueprintCallable
  • Category="VPBookmarks"

static void VPBookmarkSplineMeshIndicatorSetStartAndEnd ( USplineMeshComponent* SplineMesh
)

   Libraries/VPBlueprintLibrary.h
  • BlueprintCallable
  • Category="VPBookmarks"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page