1. Epic GamesDeveloper
  3. UVCamBlueprintFunctionLibrary

UVCamBlueprintFunctionLibrary

API > API/Plugins > API/Plugins/VirtualCamera

   
Name UVCamBlueprintFunctionLibrary
Type class
Header File /Engine/Plugins/VirtualProduction/VirtualCamera/Source/VirtualCamera/Public/FunctionLibraries/VCamBlueprintFunctionLibrary.h
Include Path #include "FunctionLibraries/VCamBlueprintFunctionLibrary.h"

Syntax

UCLASS (BlueprintType)  
class UVCamBlueprintFunctionLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Classes

Name Remarks
FOnTakeRecorderSlateChanged_VCam  

Functions

Static

Name Remarks Include Path Unreal Specifiers

static float CalculateAutoFocusDistance ( FVector2D ReticlePosition,
UCineCameraComponent* CineCamera
)

 Calculates auto focus FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"

static bool CallFunctionByName ( UObject* ObjPtr,
FName FunctionName
)

 Returns true if the function was found & executed correctly. FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"

static void ClearCameraOverscan ( UCineCameraComponent* InCameraComponent
)

 Clears any overscan from the camera FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"

static FFrameRate ConvertStringToFrameRate ( FString InFrameRateString
)

 Converts a double framerate to a FFrameRate FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"

static bool CopyToCineCameraActor ( UCineCameraComponent* SourceCameraComponent,
ACineCameraActor* TargetCameraActor
)

 Copies all properties from a CineCameraComponent to a CineCameraActor and ensure the root actor transform is updated so the CameraComponents end up in the same World Space position FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"

static bool DeprojectScreenToWorld ( const FVector2D& InScreenPosition,
FVector& OutWorldPosition,
FVector& OutWorldDirection
)

 Convert 2D screen position to World Space 3D position and direction in the active viewport. FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"

static bool DeprojectScreenToWorldByViewport ( const FVector2D& InScreenPosition,
EVCamTargetViewportID TargetViewport,
FVector& OutWorldPosition,
FVector& OutWorldDirection
)

 Converts 2D screen position to World Space 3D position and direction in the specified viewport. FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"

static UObject * EditorLoadAsset ( FString AssetPath
)

 Load an asset through path. FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera | Clips"

static bool EditorSaveAsset ( FString AssetPath
)

 Save an asset through path. Returns true on success. FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera | Clips"

static void EditorSetGameView ( bool bIsToggled
)

 Sets the current game view FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"

static void EnableDebugFocusPlane ( UCineCameraComponent* CineCamera,
bool bEnabled
)

 Enable/Disable debug focus plane FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"

static TArray< UObject * > GetBoundObjects ( FMovieSceneObjectBindingID CameraBindingID
)

 Get UObject from Camera Object Bindings FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"
Get the currently opened level sequence asset FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintPure
  • Category="VirtualCamera"

static int32 GetCurrentLevelSequenceCurrentFrame()

 Get the current playback position in frames FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintPure
  • Category="VirtualCamera"

static FFrameRate GetDisplayRate ( ULevelSequence* LevelSequence
)

 Grab the display rate from a LevelSequences' MovieScene FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"

static FTimecode GetLevelSequenceFrameAsTimecode ( const ULevelSequence* LevelSequence,
int32 InFrame
)

 Convert a frame from a level sequence to timecode FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"

static FTimecode GetLevelSequenceFrameAsTimecodeWithoutObject ( const FFrameRate DisplayRate,
int32 InFrame
)

 Convert a frame from a level sequence to timecode using only a provided display rate FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"

static int32 GetLevelSequenceLengthInFrames ( const ULevelSequence* LevelSequence
)

 Get length in frames of a level sequence FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"

static FString GetNextUndoDescription()

 Returns the description of the undo action that will be performed next. FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintPure
  • Category="VirtualCamera"

static TMap< FName, FString > GetObjectMetadataTags ( UObject* InObject
)

 Retrieves UObject's metadata tags FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera | Clips"
Gets the level sequence associated with the current pending take. FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintPure
  • Category="VirtualCamera"

static float GetPlaybackSpeed()

 Get playback speed in Sequencer FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintPure
  • Category="VirtualCamera|Sequencer"

static TWeakPtr< ISequencer > GetSequencer()

 Returns the current sequencer. FunctionLibraries/VCamBlueprintFunctionLibrary.h  

static UTexture * ImportSnapshotTexture ( FString FileName,
FString SubFolderName,
FString AbsolutePathPackage
)

 Imports image as a uasset FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"

static bool IsAssetDirty ( const FAssetData& AssetData
)

 Checks if the asset is dirty FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintPure
  • Category="VirtualCamera"

static bool IsCurrentLevelSequencePlaying()

 Check whether the sequence is actively playing. FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintPure
  • Category="VirtualCamera"

static bool IsGameRunning()

 Returns true if not in editor or if running the game in PIE or Simulate FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintPure
  • Category="VirtualCamera"

static bool IsRecording()

 Check whether a recording is currently active FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintPure
  • Category="VirtualCamera|Take Recorder"

static bool IsTakeRecorderPanelOpen()

   FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintPure
  • Category="VirtualCamera|Take Recorder"

static void ModifyObjectMetadataTags ( UObject* InObject,
FName InTag,
FString InValue
)

 Modifies a UObject's metadata tags, adding a tag if the tag does not exist. FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera | Clips"

static bool MultiTraceHitProxyOnViewport ( const FVector2D& InScreenPosition,
EVCamTargetViewportID InTargetViewport,
FVCamTraceHitProxyQueryParams InQueryParams,
TArray< FVCamTraceHitProxyResult >& Result
)

 Traces from the viewport and returns all components that contribute to the pixels surrounding InScreenPosition. FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintPure
  • Category="VirtualCamera"

static bool OpenLevelSequence ( ULevelSequence* LevelSequence
)

 Open a level sequence asset FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"

static void PauseCurrentLevelSequence()

 Pause the current level sequence FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"

static void PilotActor ( AActor* SelectedActor
)

 Pilot the provided actor using editor scripting FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera | Streaming "

static void PlayCurrentLevelSequence()

 Play the current level sequence FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"

static void SetActorLabel ( AActor* Actor,
const FString& NewActorLabel
)

   FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"

static void SetCameraOverscan ( UCineCameraComponent* InCameraComponent,
const FVector4f& InAsymmetricOverscan,
bool bScaleResolution
)

 Adds asymmetric overscan to the camera. FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"

static void SetCurrentLevelSequenceCurrentFrame ( int32 NewFrame
)

 Set playback position for the current level sequence in frames FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"

static void SetOnTakeRecorderSlateChanged ( FOnTakeRecorderSlateChanged_VCam OnTakeRecorderSlateChanged
)

 Called when the slate is changed. FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera|Take Recorder"

static void SetPlaybackSpeed ( float Value
)

 Set playback speed in Sequencer FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera|Sequencer"

static TArray< FAssetData > SortAssetsByTimecodeAssetData ( TArray< FAssetData > LevelSequenceAssets
)

 Sort array of FAssetData by metadata timecode FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera | Clips "

static int32 TimecodeToFrameAmount ( FTimecode Timecode,
const FFrameRate& InFrameRate
)

 Convert timecode to amount of frames at a given framerate FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"

static bool TryOpenTakeRecorderPanel()

   FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera|Take Recorder"

static bool UpdatePostProcessSettingsForCapture ( USceneCaptureComponent2D* CaptureComponent,
float DepthOfField,
float FStopValue
)

 Updates the provided USceneCaptureComponent2D's PostProcessingSettings. FunctionLibraries/VCamBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="VirtualCamera"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page