Navigation
API > API/Plugins > API/Plugins/ACLPlugin
An ACL database object references several UAnimSequence instances that it contains.
| Name | UAnimationCompressionLibraryDatabase |
| Type | class |
| Header File | /Engine/Plugins/Animation/ACLPlugin/Source/ACLPlugin/Classes/AnimationCompressionLibraryDatabase.h |
| Include Path | #include "AnimationCompressionLibraryDatabase.h" |
Syntax
UCLASS (MinimalAPI, Config=Engine, Meta=(DisplayName="ACL Database"))
class UAnimationCompressionLibraryDatabase : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UAnimationCompressionLibraryDatabase
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UAnimationCompressionLibraryDatabase
(
const FObjectInitializer& ObjectInitializer |
AnimationCompressionLibraryDatabase.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AnimSequences | TArray< TObjectPtr< class UAnimSequence > > | The anim sequences contained within the database. | AnimationCompressionLibraryDatabase.h |
|
| AnimSequencesNewSizeKB | int32 | The total size of all Animation Sequences with the database in use. | AnimationCompressionLibraryDatabase.h |
|
| AnimSequencesOldSizeKB | int32 | The total size of all Animation Sequences if the database were not used. | AnimationCompressionLibraryDatabase.h |
|
| CookedAnimSequenceMappings | TArray< uint64 > | Stores a mapping for each anim sequence, where its compressed data lives in our compressed buffer. | AnimationCompressionLibraryDatabase.h | |
| CookedBulkData | FByteBulkData | Bulk data that we'll stream. Present only in cooked builds. | AnimationCompressionLibraryDatabase.h | |
| CookedCompressedBytes | TArray< uint8 > | The raw binary data for our compressed database and anim sequences. Present only in cooked builds. | AnimationCompressionLibraryDatabase.h | |
| CurrentVisualFidelity | ACLVisualFidelity | The current visual fidelity level. | AnimationCompressionLibraryDatabase.h | |
| DatabaseContext | acl::database_context< UEDefaultDatabaseSettings > | The database decompression context object. Bound to the compressed database instance. | AnimationCompressionLibraryDatabase.h | |
| DatabaseMetadataSizeKB | int32 | The size of the database metadata. | AnimationCompressionLibraryDatabase.h |
|
| DatabaseSizeKB | int32 | The total size of the database. | AnimationCompressionLibraryDatabase.h |
|
| DatabaseStreamer | TUniquePtr< acl::database_streamer > | The streamer instance used by the database context. Only used in cooked builds. | AnimationCompressionLibraryDatabase.h | |
| DefaultVisualFidelity | ACLVisualFidelity | The default level of quality to set when the database loads in-game. | AnimationCompressionLibraryDatabase.h |
|
| FidelityChangeRequests | TArray< FFidelityChangeRequest > | A queue of visual fidelity change requests. | AnimationCompressionLibraryDatabase.h | |
| FidelityUpdateTickerHandle | FTSTicker::FDelegateHandle | The handle to the fidelity update ticket. | AnimationCompressionLibraryDatabase.h | |
| HighestImportanceProportion | float | What percentage of the key frames should remain in the anim sequences. | AnimationCompressionLibraryDatabase.h |
|
| LowestImportanceProportion | float | What percentage of the key frames should be moved to the database. | AnimationCompressionLibraryDatabase.h |
|
| LowImportanceSizeSizeKB | int32 | The size of the database low importance streaming tier before any stripping. | AnimationCompressionLibraryDatabase.h |
|
| MaxStreamRequestSizeKB | uint32 | The maximum size in KiloBytes of streaming requests. | AnimationCompressionLibraryDatabase.h |
|
| MediumImportanceProportion | float | What percentage of the key frames should be moved to the database. | AnimationCompressionLibraryDatabase.h |
|
| MediumImportanceSizeKB | int32 | The size of the database medium importance streaming tier. | AnimationCompressionLibraryDatabase.h |
|
| NextFidelityChangeRequestID | uint32 | The next fidelity change request ID. Always increments. | AnimationCompressionLibraryDatabase.h | |
| NumAnimSequences | int32 | The total num of Animation Sequences in this database. | AnimationCompressionLibraryDatabase.h |
|
| PreviewAnimSequenceMappings | TArray< uint64 > | Editor only, transient, preview version of 'CookedAnimSequenceMappings'. | AnimationCompressionLibraryDatabase.h | |
| PreviewBulkData | TArray< uint8 > | Editor only, transient, preview version of 'CookedBulkData'. | AnimationCompressionLibraryDatabase.h | |
| PreviewCompressedBytes | TArray< uint8 > | Editor only, transient, preview version of 'CookedCompressedBytes'. | AnimationCompressionLibraryDatabase.h | |
| PreviewDatabaseStreamer | TUniquePtr< acl::database_streamer > | Editor only, transient, preview version of 'DatabaseStreamer'. | AnimationCompressionLibraryDatabase.h | |
| PreviewVisualFidelity | ACLVisualFidelity | The level of quality to preview with the database when decompressing in the editor. | AnimationCompressionLibraryDatabase.h |
|
| StripLowestImportanceTier | FPerPlatformBool | Whether or not to strip the lowest importance tier entirely from disk. | AnimationCompressionLibraryDatabase.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Retrieves the current visual fidelity level. | AnimationCompressionLibraryDatabase.h | ||
void SetVisualFidelity
(
ACLVisualFidelity VisualFidelity |
Initiate a latent database change in visual fidelity by streaming in/out as necessary. | AnimationCompressionLibraryDatabase.h | |
| Updates the internal list of anim sequences that reference this database. | AnimationCompressionLibraryDatabase.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
UObject implementation. | AnimationCompressionLibraryDatabase.h | |
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
UObject implementation. | AnimationCompressionLibraryDatabase.h | |
virtual void PostLoad() |
AnimationCompressionLibraryDatabase.h | ||
virtual void PreSave
(
FObjectPreSaveContext ObjectSaveContext |
AnimationCompressionLibraryDatabase.h | ||
virtual void Serialize
(
FArchive& Ar |
AnimationCompressionLibraryDatabase.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static ACLVisualFidelity GetVisualFidelity
(
UAnimationCompressionLibraryDatabase* DatabaseAsset |
AnimationCompressionLibraryDatabase.h |
|
|
static void SetVisualFidelity
(
UObject* WorldContextObject, |
Initiate a latent database change in quality by streaming in/out as necessary. | AnimationCompressionLibraryDatabase.h |
|