Navigation
API > API/Plugins > API/Plugins/AnimNext > API/Plugins/AnimNext/DecoratorInterfaces
Inheritance Hierarchy
- IDecoratorInterface
- IDiscreteBlend
References
| Module | AnimNext |
| Header | /Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorInterfaces/IDiscreteBlend.h |
| Include | #include "DecoratorInterfaces/IDiscreteBlend.h" |
Syntax
struct IDiscreteBlend : public UE::AnimNext::IDecoratorInterface
Remarks
This interface exposes discrete blend related information.
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
int32 | GetBlendDestinationChildIndex
(
const FExecutionContext& Context, |
Returns the blend destination child index (aka the active child index) Returns INDEX_NONE if no child is active |
   |
const FAlphaBlend * | GetBlendState
(
const FExecutionContext& Context, |
Returns the blend alpha for the specified child Returns nullptr if the child index is invalid Allows additive decorators to query the internal state of the base decorator |
   |
float | GetBlendWeight
(
const FExecutionContext& Context, |
Returns the blend weight for the specified child Multiple children can have non-zero weight but their sum must be 1.0 Returns -1.0 if the child index is invalid |
   |
void | OnBlendInitiated
(
const FExecutionContext& Context, |
Called when the blend for specified child is initiated. |
   |
void | OnBlendTerminated
(
const FExecutionContext& Context, |
Called when the blend for specified child terminates. |
   |
void | OnBlendTransition
(
const FExecutionContext& Context, |
Called when a blend transition between children occurs OldChildIndex can be INDEX_NONE if there was no previously active child NewChildIndex can be larger than the current number of known children to support a dynamic number of children at runtime When this occurs, the number of children increments by one The number of children never shrinks |
Overridden from IDecoratorInterface
| Type | Name | Description | |
|---|---|---|---|
   |
UE::AnimNext::FDecoratorInterfaceUID |
Constants
| Name | Description |
|---|---|
| InterfaceUID | Globally unique UID for this interface |