1. Epic GamesDeveloper
  3. UVCamBlueprintFunctionLibrary

UVCamBlueprintFunctionLibrary

API > API/Plugins > API/Plugins/VirtualCamera > API/Plugins/VirtualCamera/FunctionLibraries

Inheritance Hierarchy

References

   
Module VirtualCamera
Header /Engine/Plugins/VirtualProduction/VirtualCamera/Source/VirtualCamera/Public/FunctionLibraries/VCamBlueprintFunctionLibrary.h
Include #include "FunctionLibraries/VCamBlueprintFunctionLibrary.h"

Syntax

UCLASS (BlueprintType)  
class UVCamBlueprintFunctionLibrary : public UBlueprintFunctionLibrary

Functions

  Type Name Description
Public function Static UFunction BlueprintCallable, Category float

CalculateAutoFocusDistance ( FVector2D ReticlePosition,
UCineCameraComponent* CineCamera
)

 Calculates auto focus
Public function Static UFunction BlueprintCallable, Category bool

CallFunctionByName ( UObject* ObjPtr,
FName FunctionName
)

 Returns true if the function was found & executed correctly.
Public function Static UFunction BlueprintCallable, Category FFrameRate

ConvertStringToFrameRate ( FString InFrameRateString
)

 Converts a double framerate to a FFrameRate
Public function Static UFunction BlueprintCallable, Category 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
Public function Static UFunction BlueprintCallable, Category bool

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

 Convert 2D screen position to World Space 3D position and direction in the active viewport.
Public function Static UFunction BlueprintCallable, Category 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.
Public function Static UFunction BlueprintCallable, Category UObject *

EditorLoadAsset ( FString AssetPath
)

 Load an asset through path.
Public function Static UFunction BlueprintCallable, Category bool

EditorSaveAsset ( FString AssetPath
)

 Save an asset through path. Returns true on success.
Public function Static UFunction BlueprintCallable, Category void

EditorSetGameView ( bool bIsToggled
)

 Sets the current game view
Public function Static UFunction BlueprintCallable, Category void

EnableDebugFocusPlane ( UCineCameraComponent* CineCamera,
bool bEnabled
)

 Enable/Disable debug focus plane
Public function Static UFunction BlueprintCallable, Category TArray< UObject * > Get UObject from Camera Object Bindings
Public function Static UFunction BlueprintPure, Category ULevelSequence * Get the currently opened level sequence asset
Public function Static UFunction BlueprintPure, Category int32 Get the current playback position in frames
Public function Static UFunction BlueprintCallable, Category FFrameRate

GetDisplayRate ( ULevelSequence* LevelSequence
)

 Grab the display rate from a LevelSequences' MovieScene
Public function Static UFunction BlueprintCallable, Category FTimecode

GetLevelSequenceFrameAsTimecode ( const ULevelSequence* LevelSequence,
int32 InFrame
)

 Convert a frame from a level sequence to timecode
Public function Static UFunction BlueprintCallable, Category FTimecode Convert a frame from a level sequence to timecode using only a provided display rate
Public function Static UFunction BlueprintCallable, Category int32 Get length in frames of a level sequence
Public function Static UFunction BlueprintPure, Category FString Returns the description of the undo action that will be performed next.
Public function Static UFunction BlueprintCallable, Category TMap< FName, FString > Retrieves UObject's metadata tags
Public function Static UFunction BlueprintPure, Category ULevelSequence * Gets the level sequence associated with the current pending take.
Public function Static UFunction BlueprintPure, Category float Get playback speed in Sequencer
Public function Static UFunction BlueprintCallable, Category UTexture *

ImportSnapshotTexture ( FString FileName,
FString SubFolderName,
FString AbsolutePathPackage
)

 Imports image as a uasset
Public function Static UFunction BlueprintPure, Category bool

IsAssetDirty ( const FAssetData& AssetData
)

 Checks if the asset is dirty
Public function Static UFunction BlueprintPure, Category bool Check whether the sequence is actively playing.
Public function Static UFunction BlueprintPure, Category bool Returns true if not in editor or if running the game in PIE or Simulate
Public function Static UFunction BlueprintPure, Category bool Check whether a recording is currently active
Public function Static UFunction BlueprintPure, Category bool  
Public function Static UFunction BlueprintCallable, Category void

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

 Modifies a UObject's metadata tags, adding a tag if the tag does not exist.
Public function Static UFunction BlueprintPure, Category 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.
Public function Static UFunction BlueprintCallable, Category bool

OpenLevelSequence ( ULevelSequence* LevelSequence
)

 Open a level sequence asset
Public function Static UFunction BlueprintCallable, Category void Pause the current level sequence
Public function Static UFunction BlueprintCallable, Category void

PilotActor ( AActor* SelectedActor
)

 Pilot the provided actor using editor scripting
Public function Static UFunction BlueprintCallable, Category void Play the current level sequence
Public function Static UFunction BlueprintCallable, Category void

SetActorLabel ( AActor* Actor,
const FString& NewActorLabel
)

  
Public function Static UFunction BlueprintCallable, Category void Set playback position for the current level sequence in frames
Public function Static UFunction BlueprintCallable, Category void Called when the slate is changed.
Public function Static UFunction BlueprintCallable, Category void

SetPlaybackSpeed ( float Value
)

 Set playback speed in Sequencer
Public function Static UFunction BlueprintCallable, Category TArray< FAssetData >

SortAssetsByTimecodeAssetData ( TArray< FAssetData > LevelSequenceAssets
)

 Sort array of FAssetData by metadata timecode
Public function Static UFunction BlueprintCallable, Category int32

TimecodeToFrameAmount ( FTimecode Timecode,
const FFrameRate& InFrameRate
)

 Convert timecode to amount of frames at a given framerate
Public function Static UFunction BlueprintCallable, Category bool  
Public function Static UFunction BlueprintCallable, Category bool

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

 Updates the provided USceneCaptureComponent2D's PostProcessingSettings.

Classes

  Type Name Description
Public class FOnTakeRecorderSlateChanged_VCam    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page