Navigation
API > API/Plugins > API/Plugins/AnimDatabase
This class is used for displaying the query window in the UAnimDatabase UI. The query window is implemented as a details customization of this class.
| Name | UAnimDatabaseQuery |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Animation/AnimDatabase/Source/AnimDatabase/Public/AnimDatabase.h |
| Include Path | #include "AnimDatabase.h" |
Syntax
UCLASS ()
class UAnimDatabaseQuery : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UAnimDatabaseQuery
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveRanges | TArray< int32 > | Temporary array of active ranges used to compare selected ranges | AnimDatabase.h | |
| AdditionalFrameAttributes | TArray< FAnimDatabaseFrameAttributeEntry > | Additional Frame Attributes to display in the timeline | AnimDatabase.h |
|
| AdditionalFrameRanges | TArray< FAnimDatabaseFrameRangesEntry > | Additional Frame Ranges to display in the timeline | AnimDatabase.h |
|
| AdditionalFrames | TArray< FAnimDatabaseFramesEntry > | Additional Frames to display in the timeline | AnimDatabase.h |
|
| bForceRefresh | bool | Flag to force refresh the query during update | AnimDatabase.h | |
| bFunctionShouldTransact | bool | If the function call should transact (be undo-able) | AnimDatabase.h |
|
| CustomFrameRanges | TObjectPtr< UAnimDatabaseFrameRangesFunction > | Custom frame ranges to use for the database function | AnimDatabase.h |
|
| Database | TObjectPtr< UAnimDatabase > | A pointer to the query database, used when constructing the query ranges | AnimDatabase.h | |
| DatabaseContentHash | int32 | This hash is used to detect when the database might have changed and re-run the query | AnimDatabase.h | |
| DebugDrawer | TObjectPtr< UAnimDatabaseDebugDraw > | Custom debug draw object that can be used to add additional debug draw behavior | AnimDatabase.h |
|
| FrameRanges | TObjectPtr< UAnimDatabaseFrameRangesFunction > | The query class being used to filter the database | AnimDatabase.h |
|
| FunctionObject | TObjectPtr< UAnimDatabaseFunction > | Function object to call | AnimDatabase.h |
|
| FunctionRanges | EAnimDatabaseFunctionQueryRanges | Which set of ranges to pass to the database function | AnimDatabase.h |
|
| QueryEntries | TArray< TSharedPtr< UE::AnimDatabase::Editor::FQueryEntry > > | List of UI entries for the current query | AnimDatabase.h | |
| QueryRanges | FAnimDatabaseFrameRanges | Query Ranges object for the current query | AnimDatabase.h | |
| RangeIdentifierColorSeed | int32 | Seed used for the colors of the range identifiers | AnimDatabase.h | |
| SelectedFrameRanges | FAnimDatabaseFrameRanges | The frame ranges of the selected ranges | AnimDatabase.h | |
| SelectedRanges | TArray< int32 > | Indices of all the currently selected ranges | AnimDatabase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DeleteSelectedFromDatabase() |
Deletes the selected sequences from the database | AnimDatabase.h | |
void ForceRefresh() |
Forces a refresh of the query object | AnimDatabase.h |
|
void RunFunction() |
Evaluate the given function on the database with the chosen ranges | AnimDatabase.h |
|
bool Update () |
Checks if QueryRanges needs updating, and if so updates it. | AnimDatabase.h |