Navigation
API > API/Plugins > API/Plugins/AnimNext > API/Plugins/AnimNext/DecoratorInterfaces
Inheritance Hierarchy
- IDecoratorInterface
- IGroupSynchronization
References
| Module | AnimNext |
| Header | /Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorInterfaces/IGroupSynchronization.h |
| Include | #include "DecoratorInterfaces/IGroupSynchronization.h" |
Syntax
struct IGroupSynchronization : public UE::AnimNext::IDecoratorInterface
Remarks
This interface exposes group synchronization related information and behavior.
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
float | AdvanceBy
(
const FExecutionContext& Context, |
Called by the sync group graph instance component once a group has been synchronized to advance time on the leader Returns the progress ratio of playback: 0.0 = start of animation, 1.0 = end of animation |
   |
void | AdvanceToRatio
(
const FExecutionContext& Context, |
Called by the sync group graph instance component once a group has been synchronized to advance time on each follower Progress ratio must be between [0.0, 1.0] |
   |
FName | GetGroupName
(
const FExecutionContext& Context, |
Returns the group name used for synchronization. |
   |
EAnimGroupRole::Type | GetGroupRole
(
const FExecutionContext& Context, |
Returns the group role used for synchronization. |
Overridden from IDecoratorInterface
| Type | Name | Description | |
|---|---|---|---|
   |
UE::AnimNext::FDecoratorInterfaceUID |
Constants
| Name | Description |
|---|---|
| InterfaceUID | Globally unique UID for this interface |