Navigation
API > API/Plugins > API/Plugins/AnimationSharing
| Name | UAnimationSharingManager |
| Type | class |
| Header File | /Engine/Plugins/Developer/AnimationSharing/Source/AnimationSharing/Public/AnimationSharingManager.h |
| Include Path | #include "AnimationSharingManager.h" |
Syntax
UCLASS (MinimalAPI, Config=Engine, defaultconfig)
class UAnimationSharingManager : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UAnimationSharingManager
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| InvalidActorHandle | const uint32 | AnimationSharingManager.h | |
| MaxSkeletonID | const uint32 | Max skeleton id matches the range supported in actor handles | AnimationSharingManager.h |
| MaxSkeletonIndex | const uint32 | AnimationSharingManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddSetup
(
const UAnimationSharingSetup* InSetup |
Add an animation sharing setup to the manager | AnimationSharingManager.h | |
virtual void BeginDestroy() |
AnimationSharingManager.h | ||
bool CheckDataForActor
(
AActor* InActor |
Checks whether the supplied actor is registered and all its data is valid | AnimationSharingManager.h | |
void ClearActorData() |
Ensures all actor data is cleared | AnimationSharingManager.h | |
const FAnimationSharingScalability & GetScalabilitySettings
(
const UAnimationSharingSetup* InSetup |
Returns current scalability settings, with optional setup parameter to return scalability settings specific to an animation sharing setup | AnimationSharingManager.h | |
FTickAnimationSharingFunction & GetTickFunction() |
AnimationSharingManager.h | ||
virtual UWorld * GetWorld() |
AnimationSharingManager.h | ||
void Initialise
(
const UAnimationSharingSetup* InSetup |
Initialize sharing data structures | AnimationSharingManager.h | |
void LogData() |
Log out internal data | AnimationSharingManager.h | |
void RegisterActor
(
AActor* InActor, |
Registers actor with the animation sharing system | AnimationSharingManager.h | |
void RegisterActorWithSkeleton
(
AActor* InActor, |
Registers actor with the animation sharing system according to the SharingSkeleton's sharing setup (if available) | AnimationSharingManager.h | |
void RegisterActorWithSkeletonBP
(
AActor* InActor, |
Register an Actor with this Animation Sharing manager, according to the SharingSkeleton | AnimationSharingManager.h |
|
void RemoveSetup
(
const UAnimationSharingSetup* InSetup |
Remove an animation sharing setup from the manager | AnimationSharingManager.h | |
void SetLeaderComponentsVisibility
(
bool bVisible |
Sets the visibility of currently used Leader Pose Components | AnimationSharingManager.h | |
void SetMasterComponentsVisibility
(
bool bVisible |
AnimationSharingManager.h | ||
void Tick
(
float DeltaTime |
AnimationSharingManager.h | ||
void UnregisterActor
(
AActor* InActor |
Unregisters actor with the animation sharing system | AnimationSharingManager.h | |
void UnregisterAllActors() |
Ensures all currently registered actors are removed | AnimationSharingManager.h | |
void UpdateSignificanceForActorHandle
(
uint32 InHandle, |
Update cached significance for registered actor | AnimationSharingManager.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
uint32 CreateActorHandle
(
uint8 SkeletonID, |
Dealing with Actor data and handles | AnimationSharingManager.h | |
virtual UAnimSharingInstance * CreateAnimSharingInstance() |
AnimationSharingManager.h | ||
FPerActorData * GetActorDataByHandle
(
uint32 InHandle |
AnimationSharingManager.h | ||
uint32 GetActorIndexFromHandle
(
uint32 InHandle |
AnimationSharingManager.h | ||
uint8 GetSkeletonIndexFromHandle
(
uint32 InHandle |
AnimationSharingManager.h | ||
void SetupPerSkeletonData
(
const FPerSkeletonAnimationSharingSetup& SkeletonSetup |
Populates all data required for a Skeleton setup | AnimationSharingManager.h | |
void SetupPerSkeletonData
(
const FPerSkeletonAnimationSharingSetup& SkeletonSetup, |
AnimationSharingManager.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool AnimationSharingEnabled() |
Returns whether or not the animation sharing is enabled | AnimationSharingManager.h |
|
static bool CreateAnimationSharingManager
(
UObject* WorldContextObject, |
Create an Animation Sharing Manager using the provided Setup | AnimationSharingManager.h |
|
static UAnimationSharingManager * GetAnimationSharingManager
(
UObject* WorldContextObject |
Returns the AnimationSharing Manager, nullptr if none was set up | AnimationSharingManager.h |
|
static uint32 GetInvalidActorHandle() |
AnimationSharingManager.h | ||
static UAnimationSharingManager * GetManagerForWorld
(
UWorld* InWorld |
Returns the AnimationSharing Manager for a specific UWorld, nullptr if none was set up | AnimationSharingManager.h | |
static FName GetPlatformName() |
AnimationSharingManager.h | ||
static void SetDebugMaterial
(
USkeletalMeshComponent* Component, |
AnimationSharingManager.h | ||
static void SetDebugMaterialForActor
(
UAnimSharingInstance* Data, |
AnimationSharingManager.h |