Navigation
| Name | VCamCore |
| Type | Plugin |
| Part of Plugins | VirtualCameraCore |
| Location | /Engine/Plugins/VirtualProduction/VirtualCameraCore/Source/VCamCore/ |
| Module Build Rules | VCamCore.Build.cs |
Classes
| Name | Remarks |
|---|---|
| AVCamBaseActor | Utility base class which sets up a UVCamComponent with a Cine Camera. |
| FCanChangeActiviationDynamicVCamDelegate | |
| FChangeConnectionStateEvent | |
| FOnComponentReplaced | |
| FUnifiedActivationDelegateContainer | Manages multiple FUnifiedActivationDelegates. |
| UFocusFirstPlayerViewTargetPolicy | Chooses the first local player controller. |
| UGameplayViewTargetPolicy | A gameplay view target policy determines which player controller should change its view target when gameplay is started, e.g. PIE or in shipped games. |
| UInputVCamSubsystem | Handles all input for UVCamComponent. |
| UPromptClientForStringAsyncAction | Sends a prompt for a string to the current VCam client. |
| UVCamBlueprintModifier | |
| UVCamComponent | Provides a modular system for editing a UCineCameraComponent using user widgets. |
| UVCamCoreScriptingFunctionLibrary | |
| UVCamInputSettings | These settings store input profiles. |
| UVCamModifier | |
| UVCamModifierContext | |
| UVCamOutputComposure | |
| UVCamOutputMediaOutput | |
| UVCamOutputProviderBase | Output providers implement methods of overlaying a widget onto a target viewport. |
| UVCamOutputProviderCreatedWidget | |
| UVCamOutputRemoteSession | |
| UVCamOutputViewport | Adds a widget on top of the viewport locally. |
| UVCamPlayerInput | Receives raw input from input processor (or player controller in user code). Filters input |
| UVCamStateSwitcherWidget | A widget that has a set of states you can switch between using SetCurrentState. |
| UVCamSubsystem | Base class for auto instanced and initialized subsystem that share the lifetime of UVCamComponents. |
| UVCamUIFunctionLibrary | Function Library primarily used for exposing functionality of UI related structs to Blueprints |
| UVCamWidget | A wrapper widget class that contains a set of VCam Connections |
| UVirtualCameraCoreUserSettings | Virtual Camera Core User Settings |
| UWidgetReferenceBlueprintFunctionLibrary |
Structs
| Name | Remarks |
|---|---|
| FChildWidgetReference | A reference to any child widget within an UMG Blueprint; only widgets in the same widget tree can be referenced. |
| FDeterminePlayerControllersTargetPolicyParams | |
| FModifierStackEntry | Links a Modifier with a Name for use in a Modifier Stack. |
| FMultiUserVCamCameraComponentEvent | |
| FMultiUserVCamCameraData | |
| FMultiUserVCamCameraFocusData | |
| FUnifiedActivationDelegate | Delegate for deciding whether an output provider can change its activation state. |
| FUpdateViewTargetPolicyParams | |
| FVCamChildWidgetReference | Version that restraints Widget to UVCamWidget instances. |
| FVCamComponentInstanceData | Saves internal UVCamComponent state for Blueprint created components. |
| FVCamConnection | A VCam Connection allows an external object (primarily widgets) to communicate with VCam Modifiers through Connection Points that have known properties. |
| FVCamConnectionTargetSettings | This stores information about the target for a given VCam Widget Connection Ideally this is controlled externally via a configurator system but can be set explicitly if required |
| FVCamCoreChangeActivationArgs | Input struct for deciding whether an output provider can change its activation state. |
| FVCamCoreChangeActivationResult | Output struct for deciding whether an output provider can change its activation state. |
| FVCamInputDeviceConfig | Defines the input devices a UVCamComponent will accept input from. |
| FVCamInputDeviceID | |
| FVCamInputProfile | |
| FVCamModifierConnectionPoint | |
| FVCamReceiveOutputProviderData | |
| FVCamStringPromptRequest | Request for string input which will be sent to a VCam streaming client |
| FVCamStringPromptResponse | Response to a request for string input from a VCam streaming client |
| FVCamViewportLocker | Keeps track of which viewports are locked |
| FVCamViewportLockState | |
| FVCamWidgetConnectionState | |
| FWidgetConnectionConfig | |
| FWidgetSnapshot | Saves a subset of properties of a widget. |
| FWidgetTreeSnapshot | Saves properties from widgets within a widget tree. |
Interfaces
| Name | Remarks |
|---|---|
| IVCamCoreModule | |
| IVCamOutputProviderCreatedWidget | Implemented by widgets that are either directly or indirectly created via an output provider's UMGClass. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FCanChangeActiviationVCamDelegate | TBaseDelegate_OneParam< FVCamCoreChangeActivationResult, const FVCamCoreChangeActivationArgs & > | Util/UnifiedActivationDelegate.h | |
| FCompatibleModifierCallback | TFunctionRef< EBreakBehavior(const FModifierStackEntry &Modifier, FName ConnectionPoint)> | Util/ConnectionUtils.h |
Enums
Public
| Name | Remarks |
|---|---|
| EConnectionUpdateResult | |
| EVCamInputLoggingMode | |
| EVCamInputMode | |
| EVCamStringPromptResult | Result of a request for string input from a VCam streaming client |
| EVCamTargetViewportID | |
| UE::VCamCore::ConnectionUtils::EBreakBehavior | |
| UE::VCamCore::ENameGenerationFlags | Flags for GenerateUniqueOutputProviderName. |
| UE::VCamCore::EViewportChangeReply | Result of UVCamOutputProviderBase::PreReapplyViewport |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TArray< FName > UE::VCamCore::ConnectionUtils::FindCompatibleModifierNames
(
const FVCamConnection& Connection, |
Util/ConnectionUtils.h | ||
void UE::VCamCore::ConnectionUtils::ForEachCompatibleConnectionPoint
(
const FVCamConnection& Connection, |
Util/ConnectionUtils.h | ||
void UE::VCamCore::ForEachWidgetToConsiderForVCam
(
UUserWidget& Widget, |
Calls the callback for each widget, including the children of UUserWidgets. | Util/WidgetTreeUtils.h | |
bool UE::VCamCore::operator!
(
ENameGenerationFlags E |
Util/OutputProviderUtils.h | ||
ENameGenerationFlags UE::VCamCore::operator&
(
ENameGenerationFlags Lhs, |
Util/OutputProviderUtils.h | ||
ENameGenerationFlags & UE::VCamCore::operator&=
(
ENameGenerationFlags& Lhs, |
Util/OutputProviderUtils.h | ||
ENameGenerationFlags UE::VCamCore::operator^
(
ENameGenerationFlags Lhs, |
Util/OutputProviderUtils.h | ||
ENameGenerationFlags & UE::VCamCore::operator^=
(
ENameGenerationFlags& Lhs, |
Util/OutputProviderUtils.h | ||
ENameGenerationFlags UE::VCamCore::operator|
(
ENameGenerationFlags Lhs, |
Util/OutputProviderUtils.h | ||
ENameGenerationFlags & UE::VCamCore::operator|=
(
ENameGenerationFlags& Lhs, |
Util/OutputProviderUtils.h | ||
ENameGenerationFlags UE::VCamCore::operator~
(
ENameGenerationFlags E |
Util/OutputProviderUtils.h | ||
int32 UE::VCamCore::ViewportIdToOrdinality
(
EVCamTargetViewportID TargetViewport |
EVCamTargetViewportID.h | ||
FString UE::VCamCore::ViewportIdToString
(
EVCamTargetViewportID TargetViewport |
EVCamTargetViewportID.h |