Navigation
API > API/Plugins > API/Plugins/AnimationBudgetAllocator
A skeletal mesh component that has its tick rate governed by a global animation budget
| Name | USkeletalMeshComponentBudgeted |
| Type | class |
| Header File | /Engine/Plugins/Runtime/AnimationBudgetAllocator/Source/AnimationBudgetAllocator/Public/SkeletalMeshComponentBudgeted.h |
| Include Path | #include "SkeletalMeshComponentBudgeted.h" |
Syntax
UCLASS (MinimalAPI, Meta=(BlueprintSpawnableComponent))
class USkeletalMeshComponentBudgeted : public USkeletalMeshComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → UPrimitiveComponent → UMeshComponent → USkinnedMeshComponent → USkeletalMeshComponent → USkeletalMeshComponentBudgeted
Implements Interfaces
- IAsyncPhysicsStateProcessor
- IInterface_AssetUserData
- IInterface_AsyncCompilation
- INavRelevantInterface
- IPhysicsComponent
- IClothSimulationDataProvider
- ILODSyncInterface
- IInterface_CollisionDataProvider
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
USkeletalMeshComponentBudgeted
(
const FObjectInitializer& ObjectInitializer |
SkeletalMeshComponentBudgeted.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| OnCalculateSignificanceDelegate | FOnCalculateSignificance | Delegate called to calculate significance if bAutoCalculateSignificance = true | SkeletalMeshComponentBudgeted.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AnimationBudgetAllocator | IAnimationBudgetAllocator * | Owning animation budget allocator | SkeletalMeshComponentBudgeted.h | |
| AnimationBudgetHandle | int32 | Handle used for identification | SkeletalMeshComponentBudgeted.h | |
| AutoCalculatedSignificance | float | Cached calculated significance | SkeletalMeshComponentBudgeted.h | |
| bAutoCalculateSignificance | uint8 | Whether this component should automatically calculate its significance (rather than some external system pushing the significance to it) | SkeletalMeshComponentBudgeted.h |
|
| bAutoRegisterWithBudgetAllocator | uint8 | Whether this component should automatically register with the budget allocator in OnRegister/OnUnregister | SkeletalMeshComponentBudgeted.h |
|
| bShouldUseActorRenderedFlag | uint8 | Whether this component should use its owning actor's rendered state to determine visibility. | SkeletalMeshComponentBudgeted.h |
|
| OnReduceWorkDelegate | FOnReduceWork | Delegate called to increase/decrease the amount of work a component performs | SkeletalMeshComponentBudgeted.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool GetAutoCalculateSignificance() |
Check whether this component auto-calculates its significance | SkeletalMeshComponentBudgeted.h | |
bool GetShouldUseActorRenderedFlag() |
SkeletalMeshComponentBudgeted.h | ||
FOnReduceWork & OnReduceWork() |
Get delegate called to increase/decrease the amount of work a component performs | SkeletalMeshComponentBudgeted.h | |
void SetAutoCalculateSignificance
(
bool bInAutoCalculateSignificance |
Set this component to automatically calculate its significance | SkeletalMeshComponentBudgeted.h | |
void SetAutoRegisterWithBudgetAllocator
(
bool bInAutoRegisterWithBudgetAllocator |
Set this component to automatically register with the budget allocator | SkeletalMeshComponentBudgeted.h |
|
void SetComponentSignificance
(
float Significance, |
Updates significance budget if this component has been registered with a AnimationBudgetAllocator | SkeletalMeshComponentBudgeted.h | |
virtual void SetComponentTickEnabled
(
bool bEnabled |
SkeletalMeshComponentBudgeted.h | ||
void SetShouldUseActorRenderedFlag
(
bool value |
SkeletalMeshComponentBudgeted.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginPlay() |
SkeletalMeshComponentBudgeted.h | ||
virtual void EndPlay
(
const EEndPlayReason::Type EndPlayReason |
SkeletalMeshComponentBudgeted.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FOnCalculateSignificance & OnCalculateSignificance() |
Get delegate called to calculate significance if bAutoCalculateSignificance = true | SkeletalMeshComponentBudgeted.h |