1. Epic GamesDeveloper
  3. ULiveLinkComponentController

ULiveLinkComponentController

API > API/Plugins > API/Plugins/LiveLinkComponents

Inheritance Hierarchy

  • UActorComponent
  • ULiveLinkComponentController

References

   
Module LiveLinkComponents
Header /Engine/Plugins/Animation/LiveLink/Source/LiveLinkComponents/Public/LiveLinkComponentController.h
Include #include "LiveLinkComponentController.h"

Syntax

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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bDisableEvaluateLiveLinkWhenSpawnable If true, will not evaluate LiveLink if the attached actor is a spawnable in Sequencer.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bEvaluateLiveLink If false, will not evaluate live link, effectively pausing.
Protected variable bool bIsDirty Keep track when component gets registered or controller map gets changed.
Protected variable TOptional< bool > bIsSpawnableCache Cache if the owner is a spawnable.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay bool bUpdateInEditor  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta bool bUpdateInPreviewEditor If true, will tick when the world is a preview (i.e Blueprint editors)
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly instanced, noclear TMap< TSubclassOf< ULiveLinkRole >, TObjectPtr< ULiveLinkControllerBase > > ControllerMap Instanced controllers used to control the desired role
Public variable UProperty Category BlueprintAssignable FOnControllerMapUpdatedDelegate OnControllerMapUpdatedDelegate This Event is triggered any time the controller map is updated.
Public variable UProperty Category BlueprintAssignable FLiveLinkTickDelegate OnLiveLinkUpdated This Event is triggered any time new LiveLink data is available, including in the editor.
Public variable UProperty Category, EditAnywhere blueprintgetter, blueprintsetter FLiveLinkSubjectRepresentation SubjectRepresentation  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function void Loops through the controller map and calls Cleanup() on each entry
Protected function void Called during loading to convert old data to new scheme.
Public function Virtual void

DestroyComponent ( bool bPromoteChildren
)

  
Public function Const UFunction BlueprintPure, Category UActorComponent *

GetControlledComponent ( TSubclassOf< ULiveLinkRole > InRoleClass
)

 Returns the component controlled by the LiveLink controller of the input Role.
Protected function Const TSubclassOf< ULiveLinkControllerBase >

GetControllerClassForRoleClass ( const TSubclassOf< ULiveLinkRole > RoleClass
)

  
Protected function Const TArray< TSubclassOf< ULiveLinkRole > >

GetSelectedRoleHierarchyClasses ( const TSubclassOf< ULiveLinkRole > InCurrentRoleClass
)

 Returns an array representing the class hierarchy of the given class
Public function Const UFunction blueprintgetter FLiveLinkSubjectRepresentation Return Representation of Subject that is used in the controller
Protected function void Initializes the component that the newly created input controller should control based on its specified desired component class
Public function Const bool Returns true if ControllerMap needs to be updated for the current Role.
Public function void

OnEndPIE ( bool bIsSimulating
)

 Used to cleanup controllers when exiting PIE
Public function FLiveLinkControllersTicked & Multicast delegate that broadcasts after LiveLink controllers have ticked with the latest frame of subject data
Public function Virtual void  
Public function void Used to notify that the subject role has changed.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void  
Public function Virtual void

Serialize ( FArchive& Ar
)

  
Public function UFunction BlueprintCallable, Category void

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

 Set the component to control for the LiveLink controller of the input Role
Public function void

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

 Creates an instance of the desired controller class for a specified Role class
Public function UFunction blueprintsetter void

SetSubjectRepresentation ( FLiveLinkSubjectRepresentation InSubjectRepresentation
)

 Set Representation of Subject that is used in the controller and update the controller map
Public function Virtual void

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

  

Deprecated Variables

  Type Name Description
Public variable UProperty FComponentReference ComponentToControl_DEPRECATED  
Public variable UProperty instanced, noclear TObjectPtr< ULiveLinkControllerBase > Controller_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page