1. Epic GamesDeveloper
  3. UAnimSharingInstance

UAnimSharingInstance

API > API/Plugins > API/Plugins/AnimationSharing

Inheritance Hierarchy

References

   
Module AnimationSharing
Header /Engine/Plugins/Developer/AnimationSharing/Source/AnimationSharing/Public/AnimationSharingManager.h
Include #include "AnimationSharingManager.h"

Syntax

UCLASS&40;&41;  
class UAnimSharingInstance : public UObject

Variables

  Type Name Description
Public variable TArray< FAdditiveInstance > AdditiveInstances Currently running additive instances
Public variable UAnimationSharingManager * AnimSharingManager Animation sharing manager for the current world
Public variable TArray< FBlendInstance > BlendInstances Currently running blend instances
Public variable FInstanceStack< FTransitionBlendInstance > BlendInstanceStack Blend actors data structure
Public variable bool bNativeStateProcessor  
Public variable uint32 NumSetups Number of animation setups
Public variable TArray< FOnDemandInstance > OnDemandInstances Currently running on-demand instance
Public variable TArray< FPerActorData > PerActorData Per actor data, matches RegisteredActors
Public variable TArray< FPerComponentData > PerComponentData Per component state data indexed from FPerActorData.ComponentIndices
Public variable TArray< FPerStateData > PerStateData Array of unique state data
Public variable UProperty Category Transient visibleanywhere TArray< TObjectPtr< AActor > > RegisteredActors Actors currently registered to be animation driven by the AnimManager using this setup
Public variable const FAnimationSharingScalability * ScalabilitySettings Platform specific scalability settings
Public variable UProperty Category Transient visibleanywhere TObjectPtr< AActor > SharingActor Actor to which all the running SkeletalMeshComponents used for the sharing are attached to
Public variable USignificanceManager * SignificanceManager Significance manager used for retrieve AI actor significance values
Public variable FVector SkeletalMeshBounds Bounds for the currently used skeletal mesh
Public variable UProperty Category Transient visibleanywhere TObjectPtr< UEnum > StateEnum Enum class set up by the user to 'describe' the animation states
Public variable UProperty Category, EditAnywhere Transient TObjectPtr< UAnimationSharingStateProcessor > StateProcessor (Blueprint)class instance used for determining the state enum value for each registered actor
Public variable UProperty Category Transient visibleanywhere TArray< TObjectPtr< UAnimSequence > > UsedAnimationSequences  
Public variable float WorldTime Holds the current frame world time

Functions

  Type Name Description
Public function Const float

CalculateBlendTime ( uint8 StateIndex
)

 Retrieves the blend-time for this specific state
Public function Const uint32

DeterminePermutationIndex ( uint32 ActorIndex,
uint8 State
)

 Determines a permutation index for the given actor and state
Public function uint8

DetermineStateForActor ( uint32 ActorIndex,
bool& bShouldProcess
)

 This uses the StateProcessor to determine the state index the actor is currently in
Public function bool

DoAnyActorsRequireTicking ( const InstanceType& Instance
)

  
Public function void

FreeAdditiveInstance ( uint8 StateIndex,
FAdditiveAnimationInstance* Instance
)

 Frees up an Additive Animation instance and resets it state
Public function void Frees up a Blend instance and resets its state
Public function void Kicks off the blend and on-demand instances at the end of the current frame tick, this sets up the blend instance with the correct components to blend between
Public function void

RemoveAdditiveInstance ( int32 InstanceIndex
)

  
Public function void

RemoveBlendInstance ( int32 InstanceIndex
)

 Removal functions which also make sure that indices of other data-structres are correctly remapped
Public function void

RemoveComponent ( int32 ComponentIndex
)

  
Public function void

RemoveFromCurrentBlend ( int32 ActorIndex
)

 Removal functions which also make sure the actor is set to the correct leader pose component
Public function void

RemoveFromCurrentOnDemand ( int32 ActorIndex
)

  
Public function void

RemoveOnDemandInstance ( int32 InstanceIndex
)

  
Public function void

SetComponentTick ( uint8 StateIndex,
uint32 ComponentIndex
)

 Sets the whether or not any of the follower components are visible
Public function void

SetComponentUsage ( bool bUsage,
uint8 StateIndex,
uint32 ComponentIndex
)

 Marks the component as either used/not-used, this is used to disable ticking of components which are not in use
Public function void

SetLeaderComponentForActor ( uint32 ActorIndex,
USkeletalMeshComponent* Component
)

 Sets up all components of an actor to be followers of Component
Public function void

SetPermutationFollowerComponent ( uint8 StateIndex,
uint32 ActorIndex,
uint32 PermutationIndex
)

 Sets up the correct LeaderPoseComponent according to the state and permutation indices
Public function bool

Setup ( UAnimationSharingManager* AnimationSharingManager,
const FPerSkeletonAnimationSharingSetup& SkeletonSetup,
const FAnimationSharingScalability* ScalabilitySettings,
uint32 Index
)

 Initial set up of all animation sharing data and states
Public function uint32

SetupAdditiveInstance ( uint8 StateIndex,
uint8 FromState,
uint8 StateComponentIndex
)

 Retrieves an additive instance, these are unique and cannot be reused
Public function uint32

SetupBlend ( uint8 FromState,
uint8 ToState,
uint32 ActorIndex
)

 Retrieves a blend instance, this could either mean reusing an already in progress one or a brand new one (if available according to scalability settings) returns whether or not the setup was successful
Public function uint32

SetupBlendBetweenOnDemands ( uint8 FromOnDemandInstanceIndex,
uint32 ToOnDemandInstanceIndex,
uint32 ActorIndex
)

 Retrieves a blend instance, and sets up a blend between a currently running On-Demand instance and another one which was started this frame
Public function uint32

SetupBlendFromOnDemand ( uint8 ToState,
uint32 OnDemandInstanceIndex,
uint32 ActorIndex
)

 Retrieves a blend instance, and sets up a blend from a currently running On-Demand instance to ToState
Public function uint32

SetupBlendToOnDemand ( uint8 FromState,
uint32 ToOnDemandInstanceIndex,
uint32 ActorIndex
)

 Retrieves a blend instance, and setups up a blend to an On-Demand instance from a regular animation state
Public function void

SetupFollowerComponent ( uint8 CurrentState,
uint32 ActorIndex
)

 Sets up the correct LeaderPoseComponent for the passed in Component and State indices
Public function uint32

SetupOnDemandInstance ( uint8 StateIndex
)

 Retrieves a blend instance, this could either mean reusing an already in progress one or a brand new one (if available according to scalability settings) returns an index into OnDemandInstances array or INDEX_NONE if unable to setup an instance
Public function void

SetupState ( FPerStateData& StateData,
const FAnimationStateEntry& StateEntry,
USkeletalMesh* SkeletalMesh,
const FPerSkeletonAnimationSharingSetup& SkeletonSetup,
uint32 Index
)

 Populates data for a state setup
Public function void

SwitchBetweenOnDemands ( uint32 FromOnDemandInstanceIndex,
uint32 ToOnDemandInstanceIndex,
uint32 ActorIndex
)

 Switches between on-demand instances directly, without blending
Public function void Ticks all Actor Data entries and determines their current state, if changed since last tick it will alter their animation accordingly
Public function void Ticks all currently running additive animation instances, this checks whether or not it has finished yet and sets the base-component as the leader component when it has
Public function void Ticks all unique animation states, this checks which components are currently used and turns of those which currently don't have any followerss
Public function void Ticks all currently running blend instances, checks whether or not the blend is finished and forwards the actor/components to the correct animation state
Public function void Ticks various types of debugging data / drawing (not active in shipping build)
Public function void Ticks all currently running on-demand instances, this checks whether or not the animation has finished or if we have to start blending out of the state already

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.

Deprecated Functions

  Type Name Description
Public function void

SetMasterComponentForActor ( uint32 ActorIndex,
USkeletalMeshComponent* Component
)

 This function has been deprecated. Please use SetLeaderComponentForActor instead.
Public function void

SetPermutationSlaveComponent ( uint8 StateIndex,
uint32 ActorIndex,
uint32 PermutationIndex
)

 This function has been deprecated. Please use SetPermutationFollowerComponent instead.
Public function void

SetupSlaveComponent ( uint8 CurrentState,
uint32 ActorIndex
)

 This function has been deprecated. Please use SetupFollowerComponent instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page