1. Epic GamesDeveloper
  3. UVCamWidget

UVCamWidget

A wrapper widget class that contains a set of VCam Connections

API > API/Plugins > API/Plugins/VCamCore

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.

   
Name UVCamWidget
Type class
Header File /Engine/Plugins/VirtualProduction/VirtualCameraCore/Source/VCamCore/Public/UI/VCamWidget.h
Include Path #include "UI/VCamWidget.h"

Syntax

UCLASS (Abstract)  
class UVCamWidget : public UUserWidget

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UVCamWidget ( const FObjectInitializer& ObjectInitializer
)

   UI/VCamWidget.h  

Classes

Name Remarks
FConnectionsReinitializedDelegate_Blueprint  

Typedefs

Name Type Remarks Include Path
FConnectionsReinitializedDelegate TMulticastDelegate_NoParams< void >   UI/VCamWidget.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bRegisterForInput bool Determines whether this widget will be automatically registered to receive input when the connections are initialized UI/VCamWidget.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="VCam Input"
Connections TMap< FName, FVCamConnection > The VCam Connections associated with this Widget UI/VCamWidget.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="VCam Connections"
InputContextPriority int32 If this widget is registered for input then this property defines the priority that the input mapping context is added at UI/VCamWidget.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="VCam Input"
  • Meta=(EditCondition="bRegisterForInput")
InputMappingContext TObjectPtr< UInputMappingContext > If this widget is registered for input then this input mapping context will be added to the input system UI/VCamWidget.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="VCam Input"
  • Meta=(EditCondition="bRegisterForInput")
OnPostConnectionsReinitializedDelegate FConnectionsReinitializedDelegate   UI/VCamWidget.h  
OnPostConnectionsReinitializedDelegate_Blueprint FConnectionsReinitializedDelegate_Blueprint Called when ReinitializeConnections is called. UI/VCamWidget.h
  • BlueprintAssignable
  • Meta=(DisplayName="OnConnectionsReinitialized")

Protected

Name Type Remarks Include Path Unreal Specifiers
VCamComponent TObjectPtr< UVCamComponent > Cached pointer to the VCam Component that owns this VCam Widget UI/VCamWidget.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TObjectPtr< UVCamComponent > GetVCamComponent()

   UI/VCamWidget.h  

void InitializeConnections ( UVCamComponent* VCam
)

 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 UI/VCamWidget.h  

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

 Event called when a specific connection has been updated UI/VCamWidget.h
  • BlueprintImplementableEvent
  • Category="VCam Connections"

void PostConnectionsInitialized()

 Event called after all connections have been initialized or reinitialized UI/VCamWidget.h
  • BlueprintImplementableEvent
  • Category="VCam Connections"

bool ReinitializeConnections()

 Attempts to use the cached VCam Component to initialize the connections Returns true if there was a valid VCam Component to initialize with UI/VCamWidget.h
  • BlueprintCallable
  • Category="VCam Connections"

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. UI/VCamWidget.h
  • BlueprintCallable
  • Category="VCam Connections"
  • Meta=(ExpandEnumAsExecs="Result", bReinitializeOnSuccessfulUpdate=true)

Overridden from UUserWidget

Name Remarks Include Path Unreal Specifiers

virtual void NativeDestruct()

   UI/VCamWidget.h  

virtual void NativePreConstruct()

   UI/VCamWidget.h  

Protected

Name Remarks Include Path Unreal Specifiers

void OnInitializeConnections ( UVCamComponent* VCam
)

   UI/VCamWidget.h
  • BlueprintNativeEvent
  • Category="VCam Connections"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page