1. Epic GamesDeveloper
  3. FVCamConnection

FVCamConnection

A VCam Connection allows an external object (primarily widgets) to communicate with VCam Modifiers through Connection Points that have known properties.

API > API/Plugins > API/Plugins/VCamCore

A VCam Connection allows an external object (primarily widgets) to communicate with VCam Modifiers through Connection Points that have known properties. The connection allows you to specify a set of requirements that a connection point on a modifier must implement for it to be considered a valid thing to connect to and then a function "AttemptConnection" that will try to resolve a given VCam Component to a specific Modifier along with an optional associated Input Action

   
Name FVCamConnection
Type struct
Header File /Engine/Plugins/VirtualProduction/VirtualCameraCore/Source/VCamCore/Public/UI/VCamConnectionStructs.h
Include Path #include "UI/VCamConnectionStructs.h"

Syntax

USTRUCT (BlueprintType )  
struct FVCamConnection

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ActionType EInputActionValueType If this connection requires an Input Action then this property specifies what Input Action Type the Connection Point must provide to be considered a valid connection UI/VCamConnectionStructs.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Connection
  • Meta=(EditCondition="bRequiresInputAction")
bManuallyConfigureConnection bool If you are not using an external system to configure the connection then you can enable this to have explicit control over which Modifier and Connection Point to look for when attempting a connection UI/VCamConnectionStructs.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Connection
bRequiresInputAction bool Whether this connection requires a target Connection Point to have an associated Input Action to be considered a valid connection UI/VCamConnectionStructs.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Connection
ConnectedAction TObjectPtr< UInputAction > The Input Action that we are currently connected to UI/VCamConnectionStructs.h
  • Transient
ConnectedModifier TObjectPtr< UVCamModifier > The VCam Modifier that we are currently connected to UI/VCamConnectionStructs.h
  • Transient
ConnectionTargetSettings FVCamConnectionTargetSettings A struct containing information about which Modifier and Connection Point to look for when attempting a connection UI/VCamConnectionStructs.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Connection
  • Meta=(EditCondition="bManuallyConfigureConnection", EditConditionHides)
OptionalInterfaces TArray< TSubclassOf< UInterface > > A list of interfaces that a modifier may optionally implement that this connection can use UI/VCamConnectionStructs.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Connection
RequiredInterfaces TArray< TSubclassOf< UInterface > > A list of interfaces that a modifier must implement to be considered a valid connection UI/VCamConnectionStructs.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Connection

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AttemptConnection ( UVCamComponent* VCamComponent
)

 Attempts to make a connection to a target Connection Point and returns a bool indicating success UI/VCamConnectionStructs.h  

bool IsConnected()

 Check whether this connection was successfully connected to a Connection Point UI/VCamConnectionStructs.h  

bool IsConnectionValid ( UVCamModifier& Modifier,
FName ConnectionPointName,
bool bLogWarnings
) const

 Whether under the filter criteria of this struct it is legal to connection to ConnectionPoint from Modifier. UI/VCamConnectionStructs.h  

void ResetConnection()

 Clears any currently connected modifier and action UI/VCamConnectionStructs.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page