1. Epic GamesDeveloper
  3. UVCamStateSwitcherWidget

UVCamStateSwitcherWidget

A widget that has a set of states you can switch between using SetCurrentState.

API > API/Plugins > API/Plugins/VCamCore

A widget that has a set of states you can switch between using SetCurrentState. A state is a collection of VCamWidgets whose connections should be rebound to new connection points.

   
Name UVCamStateSwitcherWidget
Type class
Header File /Engine/Plugins/VirtualProduction/VirtualCameraCore/Source/VCamCore/Public/UI/Switcher/VCamStateSwitcherWidget.h
Include Path #include "UI/Switcher/VCamStateSwitcherWidget.h"

Syntax

UCLASS ()  
class UVCamStateSwitcherWidget : public UVCamWidget

Inheritance Hierarchy

Implements Interfaces

Constants

Name Type Remarks Include Path
DefaultState FName   UI/Switcher/VCamStateSwitcherWidget.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CurrentState FName   UI/Switcher/VCamStateSwitcherWidget.h
  • EditAnywhere
  • BlueprintGetter="GetCurrentState"
  • BlueprintSetter="K2_SetCurrentState"
  • Category="Connections"
OnPostStateChanged FChangeConnectionStateEvent Executes when after the state has been changed UI/Switcher/VCamStateSwitcherWidget.h
  • BlueprintAssignable
  • Category="Connections"
OnPreStateChanged FChangeConnectionStateEvent Executes when the state is about to be changed UI/Switcher/VCamStateSwitcherWidget.h
  • BlueprintAssignable
  • Category="Connections"
States TMap< FName, FVCamWidgetConnectionState > The states UI/Switcher/VCamStateSwitcherWidget.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Connections"
  • Meta=(AllowPrivateAccess="true")

Functions

Public

Name Remarks Include Path Unreal Specifiers

FName GetCurrentState()

   UI/Switcher/VCamStateSwitcherWidget.h
  • BlueprintPure
  • Category="Connections"

bool GetStateInfo ( FName State,
FVCamWidgetConnectionState& OutStateInfo
) const

   UI/Switcher/VCamStateSwitcherWidget.h
  • BlueprintPure
  • Category="Connections"

TArray< FName > GetStates()

   UI/Switcher/VCamStateSwitcherWidget.h
  • BlueprintPure
  • Category="Connections"

void K2_SetCurrentState ( FName NewState
)

   UI/Switcher/VCamStateSwitcherWidget.h
  • BlueprintCallable
  • Category="Connections"
  • Meta=(BlueprintInternalUseOnly="true")

bool SetCurrentState ( FName NewState,
bool bForceUpdate,
bool bReinitializeConnections
)

 Switches to given state - if the state transition is valid, UpdateConnectionTargets will be called. UI/Switcher/VCamStateSwitcherWidget.h
  • BlueprintCallable
  • Category="Connections"

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   UI/Switcher/VCamStateSwitcherWidget.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void OnInitializeConnections_Implementation ( UVCamComponent* VCam
)

   UI/Switcher/VCamStateSwitcherWidget.h  

Overridden from UUserWidget

Name Remarks Include Path Unreal Specifiers

virtual void NativePreConstruct()

   UI/Switcher/VCamStateSwitcherWidget.h  

Static

Name Remarks Include Path Unreal Specifiers

static FName GetCurrentStatePropertyName()

   UI/Switcher/VCamStateSwitcherWidget.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page