1. Epic GamesDeveloper
  3. ULiveLinkComponentController

ULiveLinkComponentController

API > API/Plugins > API/Plugins/LiveLinkComponents

   
Name ULiveLinkComponentController
Type class
Header File /Engine/Plugins/Animation/LiveLink/Source/LiveLinkComponents/Public/LiveLinkComponentController.h
Include Path #include "LiveLinkComponentController.h"

Syntax

UCLASS (MinimalAPI, ClassGroup=(LiveLink),  
       Meta=(DisplayName="LiveLink Controller", BlueprintSpawnableComponent))  
class ULiveLinkComponentController : public UActorComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

ULiveLinkComponentController()

   LiveLinkComponentController.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~ULiveLinkComponentController()

   LiveLinkComponentController.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bDisableEvaluateLiveLinkWhenSpawnable bool If true, will not evaluate LiveLink if the attached actor is a spawnable in Sequencer. LiveLinkComponentController.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="LiveLink"
bEvaluateLiveLink bool If false, will not evaluate live link, effectively pausing. LiveLinkComponentController.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="LiveLink"
bUpdateInEditor bool   LiveLinkComponentController.h
  • EditAnywhere
  • Category="LiveLink"
  • AdvancedDisplay
bUpdateInPreviewEditor bool If true, will tick when the world is a preview (i.e Blueprint editors) LiveLinkComponentController.h
  • EditAnywhere
  • Category="LiveLink"
  • AdvancedDisplay
  • Meta=(EditCondition="bUpdateInEditor")
ControllerMap TMap< TSubclassOf< ULiveLinkRole >, TObjectPtr< ULiveLinkControllerBase > > Instanced controllers used to control the desired role LiveLinkComponentController.h
  • Interp
  • BlueprintReadOnly
  • EditAnywhere
  • Category="LiveLink"
  • Instanced
  • NoClear
  • Meta=(ShowOnlyInnerProperties)
OnControllerMapUpdatedDelegate FOnControllerMapUpdatedDelegate This Event is triggered any time the controller map is updated. LiveLinkComponentController.h
  • BlueprintAssignable
  • Category="LiveLink"
OnLiveLinkUpdated FLiveLinkTickDelegate This Event is triggered any time new LiveLink data is available, including in the editor. LiveLinkComponentController.h
  • BlueprintAssignable
  • Category="LiveLink"
SubjectRepresentation FLiveLinkSubjectRepresentation   LiveLinkComponentController.h
  • EditAnywhere
  • BlueprintSetter=SetSubjectRepresentation
  • BlueprintGetter=GetSubjectRepresentation
  • Category="LiveLink"

Protected

Name Type Remarks Include Path Unreal Specifiers
LiveLinkControllersTickedDelegate FLiveLinkControllersTicked   LiveLinkComponentController.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
Returns the component controlled by the LiveLink controller of the input Role. LiveLinkComponentController.h
  • BlueprintPure
  • Category="LiveLink"

FLiveLinkSubjectRepresentation GetSubjectRepresentation()

 Return Representation of Subject that is used in the controller LiveLinkComponentController.h
  • BlueprintGetter
Returns true if ControllerMap needs to be updated for the current Role. LiveLinkComponentController.h  

void OnEndPIE ( bool bIsSimulating
)

 Used to cleanup controllers when exiting PIE LiveLinkComponentController.h  

FLiveLinkControllersTicked & OnLiveLinkControllersTicked()

 Multicast delegate that broadcasts after LiveLink controllers have ticked with the latest frame of subject data LiveLinkComponentController.h  
Used to notify that the subject role has changed. LiveLinkComponentController.h  

void SetControlledComponent ( TSubclassOf< ULiveLinkRole > InRoleClass,
UActorComponent* InComponent
)

 Set the component to control for the LiveLink controller of the input Role LiveLinkComponentController.h
  • BlueprintCallable
  • Category="LiveLink"

void SetControllerClassForRole ( TSubclassOf< ULiveLinkRole > RoleClass,
TSubclassOf< ULiveLinkControllerBase > DesiredControllerClass
)

 Creates an instance of the desired controller class for a specified Role class LiveLinkComponentController.h  

void SetSubjectRepresentation ( FLiveLinkSubjectRepresentation InSubjectRepresentation
)

 Set Representation of Subject that is used in the controller and update the controller map LiveLinkComponentController.h
  • BlueprintSetter

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void DestroyComponent ( bool bPromoteChildren
)

   LiveLinkComponentController.h  

virtual void OnRegister()

   LiveLinkComponentController.h  

virtual void TickComponent ( float DeltaTime,
ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

   LiveLinkComponentController.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   LiveLinkComponentController.h  

virtual void PostLoad()

   LiveLinkComponentController.h  

virtual void Serialize ( FArchive& Ar
)

   LiveLinkComponentController.h  

Protected

Name Remarks Include Path Unreal Specifiers

void CleanupControllersInMap()

 Loops through the controller map and calls Cleanup() on each entry LiveLinkComponentController.h  

void ConvertOldControllerSystem()

 Called during loading to convert old data to new scheme. LiveLinkComponentController.h  

TSubclassOf< ULiveLinkControllerBase > GetControllerClassForRoleClass ( const TSubclassOf< ULiveLinkRole > RoleClass
) const

   LiveLinkComponentController.h  

TArray< TSubclassOf< ULiveLinkRole > > GetSelectedRoleHierarchyClasses ( const TSubclassOf< ULiveLinkRole > InCurrentRoleClass
) const

 Returns an array representing the class hierarchy of the given class LiveLinkComponentController.h  

void InitializeController ( ULiveLinkControllerBase* InController
)

 Initializes the component that the newly created input controller should control based on its specified desired component class LiveLinkComponentController.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
ComponentToControl_DEPRECATED FComponentReference   LiveLinkComponentController.h  
Controller_DEPRECATED TObjectPtr< ULiveLinkControllerBase >   LiveLinkComponentController.h
  • Instanced
  • NoClear

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page