Navigation
API > API/Plugins > API/Plugins/AnimationSharing
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UAnimationSharingManager
References
| Module | AnimationSharing |
| Header | /Engine/Plugins/Developer/AnimationSharing/Source/AnimationSharing/Public/AnimationSharingManager.h |
| Include | #include "AnimationSharingManager.h" |
Syntax
UCLASS&40;Config&61;Engine, defaultconfig&41;
class UAnimationSharingManager : public UObject
Variables
| Type | Name | Description | |
|---|---|---|---|
| TArray< TObjectPtr< UAnimSharingInstance > > | PerSkeletonData | Sharing data required for the unique Skeleton setups | |
| FAnimationSharingScalability | ScalabilitySettings | Platform specific scalability settings | |
| TArray< TObjectPtr< const USkeleton > > | Skeletons | Array of unique skeletons, matches PerSkeletonData array entries | |
| FTickAnimationSharingFunction | TickFunction | Tick function for this manager |
Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | Returns whether or not the animation sharing is enabled | ||
| void | Ensures all actor data is cleared | ||
| uint32 | CreateActorHandle
(
uint8 SkeletonIndex, |
Dealing with Actor data and handles | |
| bool | CreateAnimationSharingManager
(
UObject* WorldContextObject, |
Create an Animation Sharing Manager using the provided Setup | |
| FPerActorData * | GetActorDataByHandle
(
uint32 InHandle |
||
| uint32 | GetActorIndexFromHandle
(
uint32 InHandle |
||
| UAnimationSharingManager * | GetAnimationSharingManager
(
UObject* WorldContextObject |
Returns the AnimationSharing Manager, nullptr if none was set up | |
| UAnimationSharingManager * | GetManagerForWorld
(
UWorld* InWorld |
Returns the AnimationSharing Manager for a specific UWorld, nullptr if none was set up | |
| FName | |||
| const FAnimationSharingScalability & | Returns current scalability settings | ||
| uint8 | GetSkeletonIndexFromHandle
(
uint32 InHandle |
||
| FTickAnimationSharingFunction & | |||
| UWorld * | GetWorld () |
||
| void | Initialise
(
const UAnimationSharingSetup* InSetup |
Initialize sharing data structures | |
| void | RegisterActor
(
AActor* InActor, |
Registers actor with the animation sharing system | |
| void | RegisterActorWithSkeleton
(
AActor* InActor, |
Registers actor with the animation sharing system according to the SharingSkeleton's sharing setup (if available) | |
| void | RegisterActorWithSkeletonBP
(
AActor* InActor, |
Register an Actor with this Animation Sharing manager, according to the SharingSkeleton | |
| void | SetDebugMaterial
(
USkeletalMeshComponent* Component, |
||
| void | SetDebugMaterialForActor
(
UAnimSharingInstance* Data, |
||
| void | SetLeaderComponentsVisibility
(
bool bVisible |
Sets the visibility of currently used Leader Pose Components | |
| void | SetupPerSkeletonData
(
const FPerSkeletonAnimationSharingSetup& SkeletonSetup |
Populates all data required for a Skeleton setup | |
| void | Tick
(
float DeltaTime |
||
| void | UnregisterActor
(
AActor* InActor |
Unregisters actor with the animation sharing system | |
| void | Ensures all currently registered actors are removed | ||
| void | UpdateSignificanceForActorHandle
(
uint32 InHandle, |
Update cached significance for registered actor |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | BeginDestroy () |
Called before destroying the object. |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
| void | SetMasterComponentsVisibility
(
bool bVisible |
This member has been deprecated. Please use SetLeaderComponentsVisibility |