Skip to content

Class FManusLiveLinkSource

ClassList > FManusLiveLinkSource

The main module for the plugin that implements Manus glove support.

  • #include <ManusLiveLinkSource.h>

Inherits the following classes: ILiveLinkSource, FTickableGameObject

Public Attributes

Type Name
FGuid liveLinkSourceGuid
Identifier in LiveLink.
ILiveLinkClient * m_LiveLinkClient = = nullptr
The local client to push data updates to.
TArray< FManusReplicatedFrameData > m_ReplicatedFrameDataArray
Data to replicate.

Public Functions

Type Name
virtual void Destroy ()
FManusLiveLinkSource (EManusLiveLinkSourceType InSourceType)
sets up FManusLiveLinkSource with EManusLiveLinkSourceType
ILiveLinkClient * GetLiveLinkClient ()
virtual FText GetSourceMachineName () override const
see ILiveLinkSource for more details
virtual FText GetSourceStatus () override const
get source status see ILiveLinkSource for more details
virtual FText GetSourceType () override const
get sourcetype in FText form see ILiveLinkSource for more details
virtual TStatId GetStatId () override const
virtual ETickableTickType GetTickableTickType () override const
always returns ETickableTickType::Always
virtual void Init ()
void InitSkeletons (bool p_ResetRetry, TArray< FManusLiveLinkUser > & p_ManusLiveLinkUsers)
initialize all the manus skeletons so they can be animated
virtual bool IsSourceStillValid () override const
check if source still set see ILiveLinkSource for more details
virtual bool IsTickableInEditor () override const
always returns true
virtual bool IsTickableWhenPaused () override const
always returns true.
virtual void ReceiveClient (ILiveLinkClient * InClient, FGuid InSourceGuid) override
adds client see ILiveLinkSource for more details
void ReplicateLiveLink (class AManusReplicator * p_Replicator)
replicates live link with manus data in mind.
virtual bool RequestSourceShutdown () override
shut down and clean up source see ILiveLinkSource for more details
void SetBufferOffset (float p_Offset)
sets buffer offset in EngineTimeOffset settings
void StopReplicatingLiveLink (class AManusReplicator * p_Replicator)
stop the replicator link
virtual void Tick (float DeltaTime) override
every time unreal wants to update anything it calls this function. in this everything manus related is updated. for more details also check the unreal FTickableObject documentation.
bool TickConnection ()
TODO.
void TickUpdateSkeletons ()
TODO.

Public Static Functions

Type Name
FName GetManusLiveLinkUserLiveLinkSubjectName (const class UManusComponent * p_ManusComponent)
FName GetManusLiveLinkUserLiveLinkSubjectName (int p_ManusLiveLinkUserIndex, int32 p_ReplicatorId=0)

Public Attributes Documentation

variable liveLinkSourceGuid

FGuid FManusLiveLinkSource::liveLinkSourceGuid;

variable m_LiveLinkClient

ILiveLinkClient* FManusLiveLinkSource::m_LiveLinkClient;

variable m_ReplicatedFrameDataArray

TArray<FManusReplicatedFrameData> FManusLiveLinkSource::m_ReplicatedFrameDataArray;

Public Functions Documentation

function Destroy

virtual void FManusLiveLinkSource::Destroy ()

function FManusLiveLinkSource

sets up FManusLiveLinkSource with EManusLiveLinkSourceType 

FManusLiveLinkSource::FManusLiveLinkSource (
    EManusLiveLinkSourceType InSourceType
)

Parameters:

  • InSourceType

function GetLiveLinkClient

inline ILiveLinkClient * FManusLiveLinkSource::GetLiveLinkClient ()

ILiveLinkSource Interface

Returns:

m_LiveLinkClient

function GetSourceMachineName

see ILiveLinkSource for more details 

virtual FText FManusLiveLinkSource::GetSourceMachineName () override const

Returns:

name of this pc

function GetSourceStatus

get source status see ILiveLinkSource for more details 

virtual FText FManusLiveLinkSource::GetSourceStatus () override const

Returns:

LOCTEXT("ManusLiveLinkStatus", "Active")

function GetSourceType

get sourcetype in FText form see ILiveLinkSource for more details 

virtual FText FManusLiveLinkSource::GetSourceType () override const

Returns:

sourcetype converted to FText

function GetStatId

virtual TStatId FManusLiveLinkSource::GetStatId () override const

Returns:

TStatId of the current livelink

function GetTickableTickType

always returns ETickableTickType::Always 

inline virtual ETickableTickType FManusLiveLinkSource::GetTickableTickType () override const

Returns:

function Init

virtual void FManusLiveLinkSource::Init ()

function InitSkeletons

initialize all the manus skeletons so they can be animated 

void FManusLiveLinkSource::InitSkeletons (
    bool p_ResetRetry,
    TArray< FManusLiveLinkUser > & p_ManusLiveLinkUsers
)

Parameters:

  • p_ResetRetry retry in case of a reconnect.
  • p_ManusLiveLinkUsers list of manuslivelink users for which to init the skeletons.

function IsSourceStillValid

check if source still set see ILiveLinkSource for more details 

virtual bool FManusLiveLinkSource::IsSourceStillValid () override const

Returns:

true if m_LiveLinkClient is not null.

function IsTickableInEditor

always returns true 

inline virtual bool FManusLiveLinkSource::IsTickableInEditor () override const

Returns:

function IsTickableWhenPaused

always returns true. 

inline virtual bool FManusLiveLinkSource::IsTickableWhenPaused () override const

Returns:

function ReceiveClient

adds client see ILiveLinkSource for more details 

virtual void FManusLiveLinkSource::ReceiveClient (
    ILiveLinkClient * InClient,
    FGuid InSourceGuid
) override

FTickableObject Interface ILiveLinkSource Interface

Parameters:

  • InClient
  • InSourceGuid

replicates live link with manus data in mind. 

void FManusLiveLinkSource::ReplicateLiveLink (
    class AManusReplicator * p_Replicator
)

Parameters:

  • p_Replicator

function RequestSourceShutdown

shut down and clean up source see ILiveLinkSource for more details 

virtual bool FManusLiveLinkSource::RequestSourceShutdown () override

Returns:

true

function SetBufferOffset

sets buffer offset in EngineTimeOffset settings 

void FManusLiveLinkSource::SetBufferOffset (
    float p_Offset
)

Parameters:

  • p_Offset

stop the replicator link 

void FManusLiveLinkSource::StopReplicatingLiveLink (
    class AManusReplicator * p_Replicator
)

Parameters:

  • p_Replicator

function Tick

every time unreal wants to update anything it calls this function. in this everything manus related is updated. for more details also check the unreal FTickableObject documentation. 

virtual void FManusLiveLinkSource::Tick (
    float DeltaTime
) override

Parameters:

  • DeltaTime

function TickConnection

bool FManusLiveLinkSource::TickConnection ()

function TickUpdateSkeletons

TODO. 

void FManusLiveLinkSource::TickUpdateSkeletons ()

FTickableObject Interface

Public Static Functions Documentation

function GetManusLiveLinkUserLiveLinkSubjectName [1/2]

static FName FManusLiveLinkSource::GetManusLiveLinkUserLiveLinkSubjectName (
    const class UManusComponent * p_ManusComponent
)

Parameters:

  • p_ManusComponent

Returns:

generated manus livelink name

function GetManusLiveLinkUserLiveLinkSubjectName [2/2]

static FName FManusLiveLinkSource::GetManusLiveLinkUserLiveLinkSubjectName (
    int p_ManusLiveLinkUserIndex,
    int32 p_ReplicatorId=0
)

Parameters:

  • p_ManusLiveLinkUserIndex
  • p_ReplicatorId

Returns:

generated manus livelink name

The documentation for this class was generated from the following file api/Unreal/Plugins/Manus/Source/Manus/Public/ManusLiveLinkSource.h