1. Epic GamesDeveloper
  3. UVCamWidget

UVCamWidget

A wrapper widget class that contains a set of VCam Connections

API > API/Plugins > API/Plugins/VCamCore > API/Plugins/VCamCore/UI

Inheritance Hierarchy

References

   
Module VCamCore
Header /Engine/Plugins/VirtualProduction/VirtualCameraCore/Source/VCamCore/Public/UI/VCamWidget.h
Include #include "UI/VCamWidget.h"

Syntax

UCLASS (Abstract)  
class UVCamWidget : public UUserWidget

Remarks

A wrapper widget class that contains a set of VCam Connections

If you add a widget deriving from UVCamWidget to an Overlay Widget for a VCam Output Provider then when the Overlay is created by the Provider it will also call InitializeConnections with the owning VCam Component.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bRegisterForInput Determines whether this widget will be automatically registered to receive input when the connections are initialized
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TMap< FName, FVCamConnection > Connections The VCam Connections associated with this Widget
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly int32 InputContextPriority If this widget is registered for input then this property defines the priority that the input mapping context is added at
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly TObjectPtr< UInputMappingContext > InputMappingContext If this widget is registered for input then this input mapping context will be added to the input system
Public variable FConnectionsReinitializedDelegate OnPostConnectionsReinitializedDelegate  
Public variable UProperty Meta BlueprintAssignable FConnectionsReinitializedDelegate_Blueprint OnPostConnectionsReinitializedDelegate_Blueprint Called when ReinitializeConnections is called.

Constructors

  Type Name Description
Public function  

UVCamWidget ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const TObjectPtr< UVCamComponent >  
Public function void Iterate all VCam Connections within the widget and attempt to connect them using the provided VCam Component Optionally registers for input with the VCam Component if requested
Public function UFunction Category, BlueprintImplementableEvent void

OnConnectionUpdated ( FName ConnectionName,
bool bDidConnectSuccessfully,
FName ModifierConnectionPointName,
UVCamModifier* ConnectedModifier,
UInputAction* ConnectedAction
)

 Event called when a specific connection has been updated
Protected function UFunction Category blueprintnativeevent void  
Public function UFunction Category, BlueprintImplementableEvent void Event called after all connections have been initialized or reinitialized
Public function UFunction BlueprintCallable, Category bool Attempts to use the cached VCam Component to initialize the connections Returns true if there was a valid VCam Component to initialize with
Public function UFunction BlueprintCallable, Category, Meta void

UpdateConnectionTargets ( const TMap< FName, FVCamConnectionTargetSettings >& NewConnectionTargets,
const bool bReinitializeOnSuccessfulUpdate,
EConnectionUpdateResult& Result
)

 Looks through the set of Connections on this widget and if a matching connection name is found will attempt to update the connection target.

Overridden from UUserWidget

  Type Name Description
Public function Virtual void  
Public function Virtual void  

Classes

  Type Name Description
Public class FConnectionsReinitializedDelegate_Blueprint    

Typedefs

Name Description
FConnectionsReinitializedDelegate  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page