1. Epic GamesDeveloper
  3. UVCamComponent

UVCamComponent

Provides a modular system for editing a [UCineCameraComponent](API\Runtime\CinematicCamera\UCineCameraComponent) using user widgets.

Unreal Engine C++ API Reference > Plugins > VCamCore

Inheritance Hierarchy

References

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

Syntax

UCLASS (Blueprintable, ClassGroup=VCam, HideCategories=(Mobility),  
       Meta=(BlueprintSpawnableComponent))  
class UVCamComponent : public USceneComponent

Remarks

Provides a modular system for editing a UCineCameraComponent using user widgets. This component must be attached as a direct child of UCineCameraComponent.

This component implements a Model-View-Controller architecture where modifiers are the model, output providers the view, and this component the controller.

There are three aspects to this component:

  • Modifiers implement logic for changing properties on the UCineCameraComponent. Modifiers contain ConnectionPoints. ConnectionPoints can optionally expose UInputActions (Enhanced Input) that can be invoked by widgets.
  • Output providers create and render widgets (possibly streaming them). Usually output providers create UVCamWidgets, which are special widgets that can connect to ConnectionPoints. Widgets interact with modifiers in two ways:
  • Simple: trigger input actions that modifiers are subscribed to and expose via connections.
  • Advanced: query whether modifiers implement certain custom defined interfaces. UVCamWidget Connections can be configured with required and optional interfaces.
  • UVCamSubsystems exist for as long as a UVCamComponent is enabled (this is comparable to ULocalPlayerSubsystem). One notable such system is the UInputVCamSubsystem which allows UVCamComponents to bind to input devices similarly to how APlayerControllers do in shipped games.

Variables

  Type Name Description
Public variable UProperty Category BlueprintAssignable FOnComponentReplaced OnComponentReplaced There are situations in the editor where the component may be replaced by another component as part of the actor being reconstructed This event will notify you of that change and give you a reference to the new component.

Functions

  Type Name Description
Public function void Adds the Input Mapping Context from a modifier, if it exists, to the input system
Public function void Adds an explicitly provided Input Mapping Context to the input system
Public function UFunction BlueprintCallable, Category, Meta bool

AddInputProfileWithCurrentlyActiveMappings ( const FName ProfileName,
bool bUpdateIfProfileAlreadyExists
)

 Tries to add a new Input Profile to the VCam Input Settings and populates it with any currently active player mappable keys Note: The set of currently active player mappable keys may be larger than the set of mappings in this component's Input Profile
Public function UFunction BlueprintCallable, Category, Meta bool

AddModifier ( const FName Name,
UPARAM(meta=(AllowAbstract="false")) TSubclassOf< UVCamModifier > ModifierClass,
UVCamModifier*& CreatedModifier
)

 Add a modifier to the stack with a given name.
Public function UFunction BlueprintCallable, Category, Meta bool

AddOutputProvider ( UPARAM(meta=(AllowAbstract="false")) TSubclassOf< UVCamOutputProviderBase > ProviderClass,
UVCamOutputProviderBase*& CreatedProvider
)

  
Public function Static void  
Public function void

ApplyComponentInstanceData ( FVCamComponentInstanceData& ComponentInstanceData,
ECacheApplyPhase CacheApplyPhase
)

 Applies the component instance cache
Public function void Call this after modifying the InputProfile in code to update the player mapped keys
Public function Const bool  
Public function Const UFunction BlueprintPure, Category TArray< FName > Returns all the modifier names used to identifying connection points.
Public function Const UFunction BlueprintPure, Category void

GetAllModifiers ( TArray< UVCamModifier* >& Modifiers
)

 Returns all the Modifiers in the Component's Stack Note: It's possible not all Modifiers will be valid (such as if the user has not set a class for the modifier in the details panel)
Public function Const UFunction BlueprintPure, Category void  
Public function Const UFunction BlueprintCallable, Category, Meta TArray< FEnhancedActionKeyMapping > Searches the currently active input system for all registered key mappings that are marked as Player Mappable.
Public function Const UFunction BlueprintPure, Category bool  
Public function Const UFunction BlueprintPure, Category bool  
Public function Const UFunction BlueprintPure, Category const FVCamInputDeviceConfig & Gets the current input device settings being used (if this component is enabled) or that will be used (if not enabled).
Public function Const UFunction BlueprintPure, Category const FVCamInputProfile &  
Public function Const UFunction BlueprintPure, Category UInputVCamSubsystem * Gets the subsystem responsible for input handling.
Public function UFunction BlueprintCallable, Category bool  
Public function Const UFunction BlueprintPure, Category FLiveLinkSubjectName  
Public function Const UFunction BlueprintPure, Category UVCamModifier *

GetModifierByIndex ( const int32 Index
)

 Returns the Modifier in the Stack with the given index if it exist.
Public function Const UFunction BlueprintPure, Category UVCamModifier *

GetModifierByName ( const FName Name
)

 Tries to find a Modifier in the Stack with the given name.
Public function Const UFunction BlueprintPure, Category UVCamModifierContext * Get the current Modifier Context
Public function Const UFunction BlueprintPure, Category, Meta void

GetModifiersByClass ( UPARAM(meta=(AllowAbstract="false")) TSubclassOf< UVCamModifier > ModifierClass,
TArray< UVCamModifier* >& FoundModifiers
)

 Given a specific Modifier class, returns a list of matching Modifiers
Public function Const UFunction BlueprintPure, Category void

GetModifiersByInterface ( UPARAM(meta=(AllowAbstract="false")) TSubclassOf< UInterface > InterfaceClass,
TArray< UVCamModifier* >& FoundModifiers
)

 Given a specific Interface class, returns a list of matching Modifiers
Public function Const const TArray< FModifierStackEntry > &  
Public function Const UFunction BlueprintPure, Category int32  
Public function Const UFunction BlueprintPure, Category int32  
Public function Const UFunction BlueprintPure, Category UVCamOutputProviderBase *

GetOutputProviderByIndex ( const int32 ProviderIndex
)

  
Public function Const UFunction BlueprintPure, Category, Meta void

GetOutputProvidersByClass ( UPARAM(meta=(AllowAbstract="false")) TSubclassOf< UVCamOutputProviderBase > ProviderClass,
TArray< UVCamOutputProviderBase* >& FoundProviders
)

  
Public function Const UFunction BlueprintCallable, Category, Meta PRAGMA_DISABLE_DEPRECATION_WARNINGSTArray< FEnhancedActionKeyMapping > Returns a list of all player mappable keys that have been registered
Public function Const UFunction BlueprintCallable, Category, Meta FKey

GetPlayerMappedKey ( const FName MappingName
)

 Searches the currently active input system for the current key mapped to a given input mapping If there is not a player mapped key, then this will return EKeys::Invalid.
Public function Const UFunction BlueprintPure, Category FGameplayTag

GetRole ()

  
Public function Const TSubsystemClass *

GetSubsystem ( const TSubclassOf< TSubsystemClass >& SubsystemClass
)

  
Public function Const const TArray< TSubsystemClass * > &

GetSubsystemArray ( const TSubclassOf< TSubsystemClass >& SubsystemClass
)

  
Public function Const UFunction BlueprintPure, Category TArray< UVCamSubsystem * > Gets all subsystems implementing this interface
Public function Const UFunction BlueprintPure, Category UCineCameraComponent *  
Public function Virtual UFunction BlueprintCallable, Category, Meta void

InjectInputForAction ( const UInputAction* Action,
FInputActionValue RawValue,
const TArray< UInputModifier* >& Modifiers,
const TArray< UInputTrigger* >& Triggers
)

 Injects an input action.
Public function Virtual UFunction BlueprintCallable, Category, Meta void

InjectInputVectorForAction ( const UInputAction* Action,
FVector Value,
const TArray< UInputModifier* >& Modifiers,
const TArray< UInputTrigger* >& Triggers
)

 Injects an input vector for action.
Public function UFunction BlueprintCallable, Category, Meta bool

InsertModifier ( const FName Name,
int32 Index,
UPARAM(meta=(AllowAbstract="false")) TSubclassOf< UVCamModifier > ModifierClass,
UVCamModifier*& CreatedModifier
)

 Insert a modifier to the stack with a given name and index.
Public function UFunction BlueprintCallable, Category, Meta bool

InsertOutputProvider ( int32 Index,
UPARAM(meta=(AllowAbstract="false")) TSubclassOf< UVCamOutputProviderBase > ProviderClass,
UVCamOutputProviderBase*& CreatedProvider
)

  
Public function Const UFunction blueprintgetter bool  
Public function Const bool Whether this component is initialized, i.e. the input subsystem is set up and the output providers are allowed to be active.
Public function void  
Public function void  
Public function UFunction BlueprintCallable, Category void Registers the given object with the VCamComponent's Input Component This allows dynamic input bindings such as input events in blueprints to work correctly Note: Ensure you call UnregisterObjectForInput when you are finished with the object otherwise input events will still fire until GC actually destroys the object
Public function UFunction BlueprintCallable, Category void Remove all Modifiers from the Stack.
Public function UFunction BlueprintCallable, Category void  
Public function void Removes the Input Mapping Context from a modifier, if it exists, from the input system
Public function void Removes an explicitly provided Input Mapping Context to the input system
Public function UFunction BlueprintCallable, Category bool

RemoveModifier ( const UVCamModifier* Modifier
)

  
Public function UFunction BlueprintCallable, Category bool

RemoveModifierByIndex ( const int ModifierIndex
)

  
Public function UFunction BlueprintCallable, Category bool

RemoveModifierByName ( const FName Name
)

  
Public function UFunction BlueprintCallable, Category bool  
Public function UFunction BlueprintCallable, Category bool

RemoveOutputProviderByIndex ( const int32 ProviderIndex
)

  
Public function Const UFunction BlueprintCallable, Category, Meta bool Saves the current input profile settings to the VCam Input Settings using the provided Profile Name.
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction blueprintsetter void

SetEnabled ( bool bNewEnabled
)

 Sets whether the VCamComponent will update every frame
Public function UFunction BlueprintCallable, Category blueprintinternaluseonly void

SetInputDeviceSettings ( const FVCamInputDeviceConfig& NewInputProfile
)

 Propagates devices settings all the way to the player input.
Public function UFunction BlueprintCallable, Category blueprintinternaluseonly void

SetInputProfile ( const FVCamInputProfile& NewInputProfile
)

  
Public function UFunction BlueprintCallable, Category bool

SetInputProfileFromName ( const FName ProfileName
)

 Attempts to apply key mapping settings from an input profile defined in VCam Input Settings Returns whether the profile was found and able to be applied
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category, Meta void

SetModifierContextClass ( UPARAM(meta=(AllowAbstract="false")) TSubclassOf< UVCamModifierContext > ContextClass,
UVCamModifierContext*& CreatedContext
)

 Sets the Modifier Context to a new instance of the provided class
Public function UFunction BlueprintCallable, Category, Meta bool

SetModifierIndex ( int32 OriginalIndex,
int32 NewIndex
)

 Moves an existing modifier in the stack from its current index to a new index.
Public function UFunction BlueprintCallable, Category, Meta bool

SetOutputProviderIndex ( int32 OriginalIndex,
int32 NewIndex
)

 Moves an existing Output Provider in the stack from its current index to a new index.
Public function UFunction BlueprintCallable, Category void

SetRole ( FGameplayTag Value
)

  
Public function Const UFunction BlueprintCallable, Category void Unregisters the given object with the VCamComponent's Input Component
Public function void

Update ()

  
Public function void Updates all actor Locks on viewports to be as configured.

Overridden from USceneComponent

  Type Name Description
Public function Virtual void Called when AttachParent changes, to allow the scene to update its attachment state.

Overridden from UActorComponent

  Type Name Description
Public function Virtual void Function that gets called from within Map_Check to allow this actor component to check itself for any potential errors and register them with map check dialog.
Public function Virtual void Ends gameplay for this component.
Public function Virtual Const TStructOnScope< FActorComponentInstanceData > Called before we throw away components during RerunConstructionScripts, to cache any data we wish to persist across that operation
Public function Virtual void Called when a component is created (not loaded). This can happen in the editor or during gameplay
Public function Virtual void

OnComponentDestroyed ( bool bDestroyingHierarchy
)

 Called when a component is destroyed
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreEditChange ( FEditPropertyChain& PropertyAboutToChange
)

 This alternate version of PreEditChange is called when properties inside structs are modified.
Public function Virtual void

PreEditChange ( FProperty* PropertyAboutToChange
)

 This is called when a property is about to be modified externally
Public function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

 Presave function.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Enums

  Type Name Description
Private enum EPIEState Variable used for pausing update on editor objects while PIE is running  

Deprecated Variables

  Type Name Description
Public variable UProperty EVCamTargetViewportID TargetViewport_DEPRECATED Which viewport to use for this VCam.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page