1. Epic GamesDeveloper
  3. UVCamOutputProviderBase

UVCamOutputProviderBase

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

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Abstract, BlueprintType, EditInlineNew&41;  
class UVCamOutputProviderBase : public UObject

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
Protected function void Applies OverrideResolution to the passed in viewport - bUseOverrideResolution was already checked.
Public 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 void  
Public function Const int32 Gets the index of this output provider in the owning UVCamComponent::OutputProviders array.
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 TSharedPtr< SLevelViewport >  
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 UVPFullScreenUserWidget *  
Protected function Const UVPFullScreenUserWidget *  
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 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 Virtual Const bool  
Public function void Calls the VCamModifierInterface on the widget if it exists and also requests any child VCam Widgets to reconnect
Public function Virtual void Called when the provider is Activated
Public function Virtual void Called when the provider is Deactivated
Public function void Reapplies the override resolution or restores back to the viewport settings.
Public function void Restore the output state from previous call to disable output.
Protected function void Removes the override resolution from the given viewport.
Public function UFunction BlueprintCallable, Category void

SetActive ( const bool bInActive
)

 Called to turn on or off this output provider
Public function UFunction BlueprintCallable, Category void

SetTargetCamera ( const UCineCameraComponent* InTargetCamera
)

  
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