1. Epic GamesDeveloper
  3. UVCamOutputProviderBase

UVCamOutputProviderBase

Output providers implement methods of overlaying a widget onto a target viewport.

API > API/Plugins > API/Plugins/VCamCore > API/Plugins/VCamCore/Output

Inheritance Hierarchy

References

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

Syntax

UCLASS (Abstract, BlueprintType, EditInlineNew, CollapseCategories)  
class UVCamOutputProviderBase : public UObject

Remarks

Output providers implement methods of overlaying a widget onto a target viewport. The composition of viewport and widget is then usually streamed to an application outside the engine, e.g. via Pixel Streaming or Remote Session.

To start outputting, the owning UVCamComponent must be enabled and the output provider activated.

Output providers are managed by UVCamComponent, which own them and must be attached as a child to a UCineCameraComponent. Output providers have a target viewport that the widget is overlayed onto. The target viewport can be locked to the target camera, which happens when:

The output provider is outputting IsOutputting() == true

The output provider is configured to do so, either by 2.1 NeedsForceLockToViewport returning true or 2.2 UVCamComponent::ViewportLocker being configured accordingly. When a viewport is locked, the owning output provider can affect its resolution (see bUseOverrideResolution and OverrideResolution).

A concept of viewport ownership is implemented in FViewportManager ensuring that at most 1 output provider affects a viewport's lock and resolution at a time; the first output provider to request lock, gets the ownership over that viewport. When lock, resolution or target viewport change, call RequestResolutionRefresh to updat the viewport state.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bUseOverrideResolution Override the default output resolution with a custom value - NOTE you must toggle bIsActive off then back on for this to take effect
Protected variable UProperty Transient EVPWidgetDisplayType DisplayType Defines how the overlay widget should be added to the viewport.
Protected variable UProperty Category, EditAnywhere, Meta instanced TObjectPtr< UGameplayViewTargetPolicy > GameplayViewTargetPolicy In game worlds, such as PIE or shipped games, determines which a player controller whose view target should be set to the owning cine camera.
Public variable FActivationDelegate OnActivatedDelegate  
Public variable UProperty Meta BlueprintAssignable FActivationDelegate_Blueprint OnActivatedDelegate_Blueprint Called when the activation state of this output provider changes.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FIntPoint OverrideResolution When bUseOverrideResolution is set, use this custom resolution

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function UFunction BlueprintPure, Category bool  
Protected function Virtual void Called to create the UMG overlay widget.
Public function Virtual void Called when the provider is being shutdown such as before changing level or on exit
Protected function void  
Protected function Const void  
Protected function void  
Public function Const int32 Gets the index of this output provider in the owning UVCamComponent::OutputProviders array.
Public function Const UGameplayViewTargetPolicy *  
Public function Static FName  
Public function Const UVCamOutputProviderBase * Utility that gets the owning VCam component and gets another output provider by its index.
Public function Const TSharedPtr< FSceneViewport > Gets the viewport identified by the passed in parameters.
Public function Const TWeakPtr< SWindow >  
Protected function Const FLevelEditorViewportClient *  
Public function Const TSharedPtr< FSceneViewport > Gets the scene viewport identified by the currently configured TargetViewport.
Public function Const UFunction BlueprintPure, Category EVCamTargetViewportID  
Public function Static FName  
Public function Const UFunction BlueprintPure, Category TSubclassOf< UUserWidget >  
Public function Static FName  
Public function UFunction BlueprintPure, Category UVPFullScreenUserWidget *  
Protected function Const UVPFullScreenUserWidget *  
Public function Const UFunction BlueprintPure, Category UVCamComponent *  
Public function Virtual void Called when the provider is brought online such as after instantiating or loading a component containing this provider Use Initialize for any setup logic that needs to survive between Start / Stop cycles such as spawning transient objects
Public function void Uses this version in constructors (e.g. for initializing a CDO).
Public function bool

IsActivationChangeAllowed ( bool bRequestActiveState
)

  
Public function bool

IsActivationChangeAllowedWithReason ( bool bRequestActiveState,
FText& OutReason
)

  
Public function Const UFunction BlueprintPure, Category bool Returns if this output provider is currently active or not
Public function Const UFunction BlueprintPure, Category bool Returns if this output provider has been initialized or not
Public function Const bool  
Public function Virtual Const bool  
Public function void Calls the VCamModifierInterface on the widget if it exists and also requests any child VCam Widgets to reconnect
Protected function Virtual void Called when the provider is Activated
Protected function Virtual void Called when the provider is Deactivated
Protected function void

OnSetTargetCamera ( const UCineCameraComponent* InTargetCamera
)

 Called by owning UVCamComponent when the target camera changes.
Protected function Virtual void If PreReapplyViewport returned EVCamViewportChangeReply::ApplyViewportChange, then this function is called after the UMG widget has been placed in the new target viewport.
Protected function Virtual UE::VCamCore::EViewportChangeReply Called a new target viewport has been set while outputting but before the viewport change is processed.
Public function Virtual TFuture< FVCamStringPromptResponse > Request string input from the streaming client. Returns true if the request was handled.
Public function Const void  
Protected function void Called while a UMG widget is being outputted.
Protected function void Called after changing viewport.
Public function Const void Requests that at end of the frame the target viewport's resolution is updated to match this provider's settings.
Public function void Restore the output state from previous call to disable output.
Public function UFunction BlueprintCallable, Category void

SetActive ( const bool bInActive
)

 Called to turn on or off this output provider
Protected function void

SetActiveInternal ( bool bInActive
)

 Triggers all callbacks without checking whether the bIsActive flag is actually being changed.
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetUMGClass ( const TSubclassOf< UUserWidget > InUMGClass
)

  
Public function void Temporarily disable the output. Caller must eventually call RestoreOutput.
Public function Virtual void

Tick ( const float DeltaTime
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after applying a transaction to the object.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Called before applying a transaction to the object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Classes

  Type Name Description
Public class FActivationDelegate_Blueprint    

Typedefs

Name Description
FActivationDelegate  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page