unreal.PoseSearchDatabase

class unreal.PoseSearchDatabase(outer: Object | None = None, name: Name | str = 'None')

Bases: DataAsset

A data asset for indexing a collection of animation sequences.

C++ Source:

  • Plugin: PoseSearch

  • Module: PoseSearch

  • File: PoseSearchDatabase.h

Editor Properties: (see get_editor_property/set_editor_property)

  • animation_assets (Array[InstancedStruct]): [Read-Write]

  • exclude_from_database_parameters (PoseSearchExcludeFromDatabaseParameters): [Read-Write] These settings allow users to trim the start and end of animations in the database to preserve start/end frames for blending, and prevent the system from selecting the very last frames before it blends out.

  • kd_tree_max_leaf_size (int32): [Read-Write]

  • kd_tree_query_num_neighbors (int32): [Read-Write] Out of a kdtree search, results will have only an approximate cost, so the database search will select the best “KDTree Query Num Neighbors” poses to perform the full cost analysis, and be able to elect the best pose.

  • normalization_set (PoseSearchNormalizationSet): [Read-Write] This optional asset defines a list of databases you want to normalize together. Without it, it would be difficult to compare costs from separately normalized databases containing different types of animation, like only idles versus only runs animations, given that the range of movement would be dramatically different.

  • number_of_principal_components (int32): [Read-Write] Number of dimensions used to create the kdtree. More dimensions allows a better explanation of the variance of the dataset that usually translates in better search results, but will imply more memory usage and worse performances.

  • pose_search_mode (PoseSearchMode): [Read-Write] This dictates how the database will perform the search.

  • preview_mesh (SkeletalMesh): [Read-Write] If null, the default preview mesh for the skeleton will be used. Otherwise, this will be used in preview scenes. todo:: Move this to be a setting in the Pose Search Database editor.

  • schema (PoseSearchSchema): [Read-Write] The Motion Database Config sets what channels this database will use to match against (bones, trajectory and what properties of those you’re interested in, such as position and velocity).

  • skip_search_if_possible (bool): [Read-Write] When evaluating multiple searches, including the continuing pose search, the system keeps track of the best pose and associated cost. if the current database cannot possibly improve the current cost, the database search will be skipped entirely.

property normalization_set: PoseSearchNormalizationSet

[Read-Only] This optional asset defines a list of databases you want to normalize together. Without it, it would be difficult to compare costs from separately normalized databases containing different types of animation, like only idles versus only runs animations, given that the range of movement would be dramatically different.

Type:

(PoseSearchNormalizationSet)

property schema: PoseSearchSchema

[Read-Only] The Motion Database Config sets what channels this database will use to match against (bones, trajectory and what properties of those you’re interested in, such as position and velocity).

Type:

(PoseSearchSchema)