UVCamComponent

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

VCamCore

Header

/Engine/Plugins/Experimental/VirtualCamera/Source/VCamCore/Public/VCamComponent.h

Include

#include "VCamComponent.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, ClassGroup=(VCam), Meta=(BlueprintSpawnableComponent))
class UVCamComponent : public USceneComponent

Variables

Name Description

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

bool

 

bDisableComponentWhenSpawnedBySequencer

If true, the component will force bEnabled to false when it is part of a spawnable in Sequencer.

Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite

bool

 

bDisableOutputOnMultiUserReceiver

Do we disable the output if the virtual camera is in a Multi-user session and the camera is a "receiver" from multi-user

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

bool

 

bLockViewportToCamera

If true, render the viewport from the point of view of the parented CineCamera.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FLiveLinkSubjec...

 

LiveLinkSubject

LiveLink subject name for the incoming camera transform.

Public variable UProperty Category BlueprintAssignable

FOnComponentRep...

 

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.

Public variable UProperty Category, EditAnywhere instanced

TArray< UVCamOu...

 

OutputProviders

List of Output Providers (executed in order)

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FGameplayTag

 

Role

The role of this virtual camera.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

EVCamTargetView...

 

TargetViewport

Which viewport to use for this VCam.

Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta displayname

float

 

UpdateFrequencyMs

Indicates the frequency which camera updates are sent when in Multi-user mode.

Constructors

Name Description

Public function

UVCamComponent()

Functions

Name Description

Public function UFunction BlueprintCallable, Category, Meta

bool

 

AddModifier

(
    const FName Name,
    TSubclassOf< UVCamModifier > Modifi...,
    UVCamModifier*& CreatedModifie...
)

Add a modifier to the stack with a given name.

Public function UFunction BlueprintCallable, Category, Meta

bool

 

AddOutputProvider

(
    TSubclassOf< UVCamOutputProviderBas...,
    UVCamOutputProviderBase*& Crea...
)

Public function Const

bool

 

CanUpdate()

Public function Const UFunction BlueprintPure, Category

void

 

GetAllModifiers

(
    TArray< UVCamModifier* >& Mod...
)

Returns all the Modifiers in the Component's Stack.

Public function Const UFunction BlueprintPure, Category

void

 

GetAllOutputProviders

(
    TArray< UVCamOutputProviderBase...
)

Public function UFunction BlueprintCallable, Category

void

 

GetLiveLinkDataForCurrentFrame

(
    FLiveLinkCameraBlueprintData& Live...
)

Public function Const UFunction BlueprintPure, Category

UVCamModifie...

 

GetModifierByIndex

(
    const int32 Index
)

Returns the Modifier in the Stack with the given index if it exist.

Public function Const UFunction BlueprintPure, Category

UVCamModifie...

 

GetModifierByName

(
    const FName Name
)

Tries to find a Modifier in the Stack with the given name.

Public function Const UFunction BlueprintPure, Category

UVCamModifie...

 

GetModifierContext()

Get the current Modifier Context

Public function Const UFunction BlueprintPure, Category, Meta

void

 

GetModifiersByClass

(
    TSubclassOf< UVCamModifier > Modifi...,
    TArray< UVCamModifier* >& Fou...
)

Given a specific Modifier class, returns a list of matching Modifiers.

Public function Const UFunction BlueprintPure, Category

void

 

GetModifiersByInterface

(
    TSubclassOf< UInterface > Interface...,
    TArray< UVCamModifier* >& Fou...
)

Given a specific Interface class, returns a list of matching Modifiers.

Public function Const UFunction BlueprintPure, Category

int32

 

GetNumberOfModifiers()

Returns the number of Modifiers in the Component's Stack.

Public function Const UFunction BlueprintPure, Category

int32

 

GetNumberOfOutputProviders()

Public function Const UFunction BlueprintPure, Category

UVCamOutputP...

 

GetOutputProviderByIndex

(
    const int32 ProviderIndex
)

Public function Const UFunction BlueprintPure, Category, Meta

void

 

GetOutputProvidersByClass

(
    TSubclassOf< UVCamOutputProviderBas...,
    TArray< UVCamOutputProviderBase...
)

Public function Const UFunction BlueprintPure, Category

UCineCameraC...

 

GetTargetCamera()

Returns the Target CineCameraComponent.

Public function Const

TWeakPtr< SW...

 

GetTargetInputWindow()

Public function Const

TSharedPtr< ...

 

GetTargetLevelViewport()

Public function Const

FLevelEditor...

 

GetTargetLevelViewportClient()

Public function Const

TSharedPtr< ...

 

GetTargetSceneViewport()

Public function UFunction

void

 

HandleObjectReplaced

(
    const TMap< UObject*, UObject ...
)

Public function UFunction BlueprintCallable, Category, Meta

bool

 

InsertModifier

(
    const FName Name,
    int32 Index,
    TSubclassOf< UVCamModifier > Modifi...,
    UVCamModifier*& CreatedModifie...
)

Insert a modifier to the stack with a given name and index.

Public function UFunction BlueprintCallable, Category, Meta

bool

 

InsertOutputProvider

(
    int32 Index,
    TSubclassOf< UVCamOutputProviderBas...,
    UVCamOutputProviderBase*& Crea...
)

Public function Const UFunction blueprintgetter

bool

 

IsEnabled()

Returns whether or not the VCamComponent will update every frame.

Public function UFunction BlueprintCallable, Category

void

 

RemoveAllModifiers()

Remove all Modifiers from the Stack.

Public function UFunction BlueprintCallable, Category

void

 

RemoveAllOutputProviders()

Remove all Output Providers from the Component.

Public function UFunction BlueprintCallable, Category

bool

 

RemoveModifier

(
    const UVCamModifier* Modifier
)

Remove the given Modifier from the Stack. Returns true if the modifier was removed successfully

Public function UFunction BlueprintCallable, Category

bool

 

RemoveModifierByIndex

(
    const int ModifierIndex
)

Remove the Modifier at a specified index from the Stack.

Public function UFunction BlueprintCallable, Category

bool

 

RemoveModifierByName

(
    const FName Name
)

Remove the Modifier with a specific name from the Stack.

Public function UFunction BlueprintCallable, Category

bool

 

RemoveOutputProvider

(
    const UVCamOutputProviderBase*...
)

Public function UFunction BlueprintCallable, Category

bool

 

RemoveOutputProviderByIndex

(
    const int32 ProviderIndex
)

Public function UFunction blueprintsetter

void

 

SetEnabled

(
    bool bNewEnabled
)

Sets if the VCamComponent will update every frame or not.

Public function UFunction BlueprintCallable, Category, Meta

void

 

SetModifierContextClass

(
    TSubclassOf< UVCamModifierContext >...,
    UVCamModifierContext*& Created...
)

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

void

 

Update()

Overridden from USceneComponent

Name Description

Public function Virtual

void

 

OnAttachmentChanged()

Called when AttachParent changes, to allow the scene to update its attachment state.

Overridden from UActorComponent

Name Description

Public function Virtual

void

 

CheckForErrors()

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

 

OnComponentDestroyed

(
    bool bDestroyingHierarchy
)

Called when a component is destroyed

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeChainProperty

(
    FPropertyChangedChainEvent& Proper...
)

This alternate version of PostEditChange is called when properties inside structs are modified.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PreEditChange

(
    FProperty* PropertyAboutToChan...
)

This is called when a property is about to be modified externally
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss