UE::Anim::FAnimSync Struct Reference

#include <AnimSync.h>

Public Types
using	FSyncGroupMap = TMap< FName, FAnimGroupInstance >

Public Member Functions
ENGINE_API void	Reset ()
ENGINE_API void	ResetAll ()
ENGINE_API void	AddTickRecord (const FAnimTickRecord &InTickRecord, const FAnimSyncParams &InSyncParams=FAnimSyncParams())
ENGINE_API void	SetMirror (const UMirrorDataTable *MirrorTable)
ENGINE_API void	TickAssetPlayerInstances (FAnimInstanceProxy &InProxy, float InDeltaSeconds)
ENGINE_API bool	GetTimeToClosestMarker (FName SyncGroup, FName MarkerName, float &OutMarkerTime) const
ENGINE_API bool	HasMarkerBeenHitThisFrame (FName SyncGroup, FName MarkerName) const
ENGINE_API bool	IsSyncGroupBetweenMarkers (FName InSyncGroupName, FName PreviousMarker, FName NextMarker, bool bRespectMarkerOrder=true) const
ENGINE_API FMarkerSyncAnimPosition	GetSyncGroupPosition (FName InSyncGroupName) const
ENGINE_API bool	IsSyncGroupValid (FName InSyncGroupName) const
void	TickSyncGroupWriteIndex ()
int32	GetSyncGroupReadIndex () const
int32	GetSyncGroupWriteIndex () const
const FSyncGroupMap &	GetSyncGroupMapRead () const
const TArray< FAnimTickRecord > &	GetUngroupedActivePlayersRead ()
ENGINE_API FAnimTickRecord &	CreateUninitializedTickRecord (FAnimGroupInstance *&OutSyncGroupPtr, FName GroupName)
ENGINE_API FAnimTickRecord &	CreateUninitializedTickRecordInScope (FAnimInstanceProxy &InProxy, FAnimGroupInstance *&OutSyncGroupPtr, FName GroupName, EAnimSyncGroupScope Scope)
ENGINE_API void	AddReferencedObjects (UAnimInstance *InAnimInstance, FReferenceCollector &Collector)

Static Public Attributes
static ENGINE_API const FName	Attribute

Member Typedef Documentation

FSyncGroupMap

using UE::Anim::FAnimSync::FSyncGroupMap = TMap<FName, FAnimGroupInstance>

Member Function Documentation

AddReferencedObjects()

void UE::Anim::FAnimSync::AddReferencedObjects	(	UAnimInstance *	InAnimInstance,
		FReferenceCollector &	Collector
	)

AddTickRecord()

void UE::Anim::FAnimSync::AddTickRecord	(	const FAnimTickRecord &	InTickRecord,
		const FAnimSyncParams &	InSyncParams = FAnimSyncParams()
	)

CreateUninitializedTickRecord()

FAnimTickRecord & UE::Anim::FAnimSync::CreateUninitializedTickRecord	(	FAnimGroupInstance *&	OutSyncGroupPtr,
		FName	GroupName
	)

CreateUninitializedTickRecordInScope()

FAnimTickRecord & UE::Anim::FAnimSync::CreateUninitializedTickRecordInScope	(	FAnimInstanceProxy &	InProxy,
		FAnimGroupInstance *&	OutSyncGroupPtr,
		FName	GroupName,
		EAnimSyncGroupScope	Scope
	)

GetSyncGroupMapRead()

const FSyncGroupMap & UE::Anim::FAnimSync::GetSyncGroupMapRead ( ) const

inline

Get the sync group we are currently reading from

GetSyncGroupPosition()

FMarkerSyncAnimPosition UE::Anim::FAnimSync::GetSyncGroupPosition

(

FName

InSyncGroupName

)

const

GetSyncGroupReadIndex()

int32 UE::Anim::FAnimSync::GetSyncGroupReadIndex ( ) const

inline

GetSyncGroupWriteIndex()

int32 UE::Anim::FAnimSync::GetSyncGroupWriteIndex ( ) const

inline

GetTimeToClosestMarker()

bool UE::Anim::FAnimSync::GetTimeToClosestMarker	(	FName	SyncGroup,
		FName	MarkerName,
		float &	OutMarkerTime
	)		const

GetUngroupedActivePlayersRead()

const TArray< FAnimTickRecord > & UE::Anim::FAnimSync::GetUngroupedActivePlayersRead ( )

inline

Get the ungrouped active player we are currently reading from

HasMarkerBeenHitThisFrame()

bool UE::Anim::FAnimSync::HasMarkerBeenHitThisFrame	(	FName	SyncGroup,
		FName	MarkerName
	)		const

IsSyncGroupBetweenMarkers()

bool UE::Anim::FAnimSync::IsSyncGroupBetweenMarkers	(	FName	InSyncGroupName,
		FName	PreviousMarker,
		FName	NextMarker,
		bool	bRespectMarkerOrder = true
	)		const

IsSyncGroupValid()

bool UE::Anim::FAnimSync::IsSyncGroupValid

(

FName

InSyncGroupName

)

const

Reset()

void UE::Anim::FAnimSync::Reset

(

)

ResetAll()

void UE::Anim::FAnimSync::ResetAll

(

)

SetMirror()

void UE::Anim::FAnimSync::SetMirror

(

const UMirrorDataTable *

MirrorTable

)

TickAssetPlayerInstances()

void UE::Anim::FAnimSync::TickAssetPlayerInstances	(	FAnimInstanceProxy &	InProxy,
		float	InDeltaSeconds
	)

TickSyncGroupWriteIndex()

void UE::Anim::FAnimSync::TickSyncGroupWriteIndex ( )

inline

Member Data Documentation

Attribute

const FName UE::Anim::FAnimSync::Attribute

static

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/Engine/Public/Animation/AnimSync.h
• Engine/Source/Runtime/Engine/Private/Animation/AnimSync.cpp