unreal.AnimDatabaseFrameRangesLibrary

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

Bases: BlueprintFunctionLibrary

Anim Database Frame Ranges Library

C++ Source:

  • Plugin: AnimDatabase

  • Module: AnimDatabase

  • File: AnimDatabaseFrameRanges.h

classmethod find_all_anim_notify_state_classes(base_class=None) → Array[type(Class)]

Finds all of the AnimNotifyState Classes which are subclasses of the given base class (exclusive). Only returns classes loaded in memory.

Parameters:

base_class (type(Class))

Returns:

out_classes (Array[type(Class)]):

Return type:

Array[type(Class)]

classmethod find_anim_notify_classes_in_frame_ranges(database, frame_ranges) → Array[type(Class)]

Finds all of the Anim Notify Classes in the given frame ranges

Parameters:
Returns:

out_anim_notify_classes (Array[type(Class)]):

Return type:

Array[type(Class)]

classmethod find_anim_notify_state_classes_in_frame_ranges(database, frame_ranges) → Array[type(Class)]

Finds all of the Anim Notify State Classes in the given frame ranges

Parameters:
Returns:

out_anim_notify_state_classes (Array[type(Class)]):

Return type:

Array[type(Class)]

classmethod find_curves_in_frame_ranges(database, frame_ranges) → Array[Name]

Finds all of the Curves present in the given frame ranges

Parameters:
Returns:

out_curves (Array[Name]):

Return type:

Array[Name]

classmethod find_sync_markers_in_frame_ranges(database, frame_ranges) → Array[Name]

Finds all of the sync markers which are present in the given frame ranges

Parameters:
Returns:

sync_markers (Array[Name]):

Return type:

Array[Name]

classmethod frame_ranges_all(database) → AnimDatabaseFrameRanges

Make a set of frame ranges for all the data in a database. (This is the same as MakeFrameRangesFromDatabase).

Parameters:

database (AnimDatabase)

Return type:

AnimDatabaseFrameRanges

classmethod frame_ranges_anim_sequence_assets(database, frame_ranges) → Array[AnimSequence]

Gets all the anim sequence assets included in a given set of frame ranges

Parameters:
Returns:

out_anim_sequence_assets (Array[AnimSequence]):

Return type:

Array[AnimSequence]

classmethod frame_ranges_anim_sequences(database, frame_ranges) → Array[AnimSequence]

Gets all the anim sequences included in a given set of frame ranges

Parameters:
Returns:

out_anim_sequences (Array[AnimSequence]):

Return type:

Array[AnimSequence]

classmethod frame_ranges_average_frame_num(frame_ranges) → float

Returns the average number of frames in a set of frame ranges

Parameters:

frame_ranges (AnimDatabaseFrameRanges)

Return type:

float

classmethod frame_ranges_bounds(frame_ranges) → AnimDatabaseFrameRanges

Returns the frame ranges that bound the given frame ranges in each sequence

Parameters:

frame_ranges (AnimDatabaseFrameRanges)

Return type:

AnimDatabaseFrameRanges

classmethod frame_ranges_bounds_frames(frames) → AnimDatabaseFrameRanges

Returns the frame ranges that bound the given frames in each sequence

Parameters:

frames (AnimDatabaseFrames)

Return type:

AnimDatabaseFrameRanges

classmethod frame_ranges_contains(frame_ranges, sequence_idx, frame_idx) → bool

Check if a set of frame ranges contains the given sequence and frame

Parameters:
Return type:

bool

classmethod frame_ranges_contains_sequence(frame_ranges, sequence_idx) → bool

Check if a set of frame ranges contains the given sequence

Parameters:
Return type:

bool

classmethod frame_ranges_contains_time(frame_ranges, sequence_idx, sequence_time, frame_rate) → bool

Check if a set of frame ranges contains the given sequence and time

Parameters:
Return type:

bool

classmethod frame_ranges_content_hash(database, frame_ranges) → int32

Computes a hash representing the contents of a set of frame ranges in a database. This hash is not strong, so should not be relied on for critical purposes, but can be used to detect data changes for things such as displaying warnings in UIs.

Parameters:
Return type:

int32

classmethod frame_ranges_difference(a, b) → AnimDatabaseFrameRanges

Returns the difference of one or more frame range sets

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod frame_ranges_difference_from_array(frame_ranges) → AnimDatabaseFrameRanges

Returns the difference of multiple frame ranges

Parameters:

frame_ranges (Array[AnimDatabaseFrameRanges])

Return type:

AnimDatabaseFrameRanges

classmethod frame_ranges_equal(a, b) → bool

Check if two sets of frame ranges are equal

Parameters:
Return type:

bool

classmethod frame_ranges_frames_difference(frame_ranges, frames) → AnimDatabaseFrameRanges

Returns the difference of a set of frame ranges and a set of frames

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod frame_ranges_gather_ranges(frame_ranges, range_indices) → AnimDatabaseFrameRanges

Returns a set of frame ranges with just the ranges of the given indices.

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod frame_ranges_intersection(a, b) → AnimDatabaseFrameRanges

Returns the intersection of one or more frame range sets

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod frame_ranges_intersection_from_array(frame_ranges) → AnimDatabaseFrameRanges

Returns the intersection of multiple frame ranges

Parameters:

frame_ranges (Array[AnimDatabaseFrameRanges])

Return type:

AnimDatabaseFrameRanges

classmethod frame_ranges_intersects(a, b) → AnimDatabaseFrameRanges

Returns all the frame ranges from A which contain any part of the frame ranges from B

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod frame_ranges_intersects_frames(a, b) → AnimDatabaseFrameRanges

Returns all the frame ranges from A which contain any part of the frames from B

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod frame_ranges_is_empty(frame_ranges) → bool

Check if a given set of frame ranges is empty

Parameters:

frame_ranges (AnimDatabaseFrameRanges)

Return type:

bool

classmethod frame_ranges_max_frame_num(frame_ranges) → int32

Returns the largest number of frames in a set of frame ranges

Parameters:

frame_ranges (AnimDatabaseFrameRanges)

Return type:

int32

classmethod frame_ranges_min_frame_num(frame_ranges) → int32

Returns the smallest number of frames in a set of frame ranges

Parameters:

frame_ranges (AnimDatabaseFrameRanges)

Return type:

int32

classmethod frame_ranges_none() → AnimDatabaseFrameRanges

Makes an empty set of frame ranges. (This is the same as MakeEmptyFrameRanges).

Return type:

AnimDatabaseFrameRanges

classmethod frame_ranges_not(database, frame_ranges) → AnimDatabaseFrameRanges

Returns all the frame ranges in the data minus the given set of frame ranges.

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod frame_ranges_pad(a, pad_start_frames, pad_end_frames) → AnimDatabaseFrameRanges

Return a set of frame ranges with the given amount of frames added to either end. Will merge ranges if this causes overlaps.

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod frame_ranges_pad_end(a, pad_frames) → AnimDatabaseFrameRanges

Return a set of frame ranges with the given amount of frames added to the end. Will merge ranges if this causes overlaps.

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod frame_ranges_pad_start(a, pad_frames) → AnimDatabaseFrameRanges

Return a set of frame ranges with the given amount of frames added to the beginning. Will merge ranges if this causes overlaps.

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod frame_ranges_range_at_index(frame_ranges, range_idx) → AnimDatabaseFrameRanges

Returns a single frame range from a set of frame ranges for the given index

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod frame_ranges_statistics(database, frame_ranges) → AnimDatabaseFrameRangesStatistics

Computes various useful statistics for a given set of frame ranges

Parameters:
Returns:

out_statistics (AnimDatabaseFrameRangesStatistics):

Return type:

AnimDatabaseFrameRangesStatistics

classmethod frame_ranges_to_string(frame_ranges) → str

Converts a FrameRanges object to a string.

Parameters:

frame_ranges (AnimDatabaseFrameRanges)

Return type:

str

classmethod frame_ranges_to_string_format(database, frame_ranges, cutoff=11) → str

Converts a FrameRanges object to a string object in full.

Parameters:
Return type:

str

classmethod frame_ranges_total_frame_num(frame_ranges) → int32

Returns the total number of frames in a set of frame ranges

Parameters:

frame_ranges (AnimDatabaseFrameRanges)

Return type:

int32

classmethod frame_ranges_total_range_num(frame_ranges) → int32

Returns the total number of ranges in a set of frame ranges

Parameters:

frame_ranges (AnimDatabaseFrameRanges)

Return type:

int32

classmethod frame_ranges_trim(a, trim_start_frames, trim_end_frames) → AnimDatabaseFrameRanges

Return a set of frame ranges with the given amount of frames trimmed from either end. Ranges shorter than the combined TrimStartFrames + TrimEndFrames will be removed.

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod frame_ranges_trim_end(a, trim_frames) → AnimDatabaseFrameRanges

Return a set of frame ranges with the given amount of frames trimmed from the end. Ranges shorter than the TrimFrames will be removed.

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod frame_ranges_trim_start(a, trim_frames) → AnimDatabaseFrameRanges

Return a set of frame ranges with the given amount of frames trimmed from the beginning. Ranges shorter than the TrimFrames will be removed.

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod frame_ranges_union(a, b) → AnimDatabaseFrameRanges

Returns the union of one or more frame range sets

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod frame_ranges_union_from_array(frame_ranges) → AnimDatabaseFrameRanges

Returns the union of multiple frame ranges

Parameters:

frame_ranges (Array[AnimDatabaseFrameRanges])

Return type:

AnimDatabaseFrameRanges

classmethod frames_frame_ranges_difference(frames, frame_ranges) → AnimDatabaseFrames

Returns the difference of a set of frames and a set of frame ranges

Parameters:
Return type:

AnimDatabaseFrames

classmethod frames_frame_ranges_intersection(frames, frame_ranges) → AnimDatabaseFrames

Returns the intersection of a set of frames and a set of frame ranges

Parameters:
Return type:

AnimDatabaseFrames

classmethod frames_frame_ranges_union(frames, frame_ranges) → AnimDatabaseFrameRanges

Returns the union of a set of frames and a set of frame ranges

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_empty_frame_ranges() → AnimDatabaseFrameRanges

Make an empty set of FrameRanges

Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_after_frames(frame_ranges, frames) → AnimDatabaseFrameRanges

Make a set of FrameRanges for all the frames after a given set of frames

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_anim_notify(database, frame_ranges, notify) → AnimDatabaseFrameRanges

Make a set of single frame FrameRanges from the given anim notify

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_anim_notify_state(database, frame_ranges, state) → AnimDatabaseFrameRanges

Make a set of FrameRanges with ranges specified by the given anim notify state

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_anim_notify_state_not_active(database, frame_ranges, state) → AnimDatabaseFrameRanges

Make a set of FrameRanges with ranges specified by when the given anim notify state is not active

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_anim_notify_states(database, frame_ranges, states) → Array[AnimDatabaseFrameRanges]

Make several FrameRanges with ranges specified by the given anim notify states

Parameters:
Returns:

out_frame_ranges (Array[AnimDatabaseFrameRanges]):

Return type:

Array[AnimDatabaseFrameRanges]

classmethod make_frame_ranges_from_anim_notify_states_intersection(database, frame_ranges, states) → AnimDatabaseFrameRanges

Make a set of FrameRanges with ranges specified by all of the given anim notify states

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_anim_notify_states_union(database, frame_ranges, states) → AnimDatabaseFrameRanges

Make a set of FrameRanges with ranges specified by any of the given anim notify states

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_anim_sequence(database, frame_ranges, anim_sequence) → AnimDatabaseFrameRanges

Make a set of FrameRanges for a given anim sequence in a database

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_anim_sequences(database, frame_ranges, anim_sequences) → AnimDatabaseFrameRanges

Make a set of FrameRanges for a given anim sequence in a database

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_asset_name(database, frame_ranges, asset_name) → AnimDatabaseFrameRanges

Make a set of FrameRanges for all sequences with a matching asset name in a set of frame ranges

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_asset_name_contains(database, frame_ranges, substring) → AnimDatabaseFrameRanges

Make a set of FrameRanges for all sequences with the given string contained in their asset name

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_asset_name_contains_one_of(database, frame_ranges, substrings) → AnimDatabaseFrameRanges

Make a set of FrameRanges for all sequences where the asset name contains any of the given strings

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_asset_name_ends_with(database, frame_ranges, suffix) → AnimDatabaseFrameRanges

Make a set of FrameRanges for all sequences with the given string as a suffix in their asset name

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_asset_name_ends_with_one_of(database, frame_ranges, suffixes) → AnimDatabaseFrameRanges

Make a set of FrameRanges for all sequences where the asset name ends with any of the given suffixes

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_asset_name_starts_with(database, frame_ranges, prefix) → AnimDatabaseFrameRanges

Make a set of FrameRanges for all sequences with the given string as a prefix in their asset name

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_asset_name_starts_with_one_of(database, frame_ranges, prefixes) → AnimDatabaseFrameRanges

Make a set of FrameRanges for all sequences where the asset name starts with any of the given prefixes

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_asset_package_contains(database, frame_ranges, substring) → AnimDatabaseFrameRanges

Make a set of FrameRanges for all sequences where the package name contains the given substring

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_asset_package_contains_one_of(database, frame_ranges, substring) → AnimDatabaseFrameRanges

Make a set of FrameRanges for all sequences where the package name contains any of the given substrings

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_before_frames(frame_ranges, frames) → AnimDatabaseFrameRanges

Make a set of FrameRanges for all the frames before a given set of frames

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_class(database, frame_ranges, class_) → AnimDatabaseFrameRanges

Make a set of FrameRanges using the given UAnimDatabaseFrameRangesFunction class

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_database(database) → AnimDatabaseFrameRanges

Make a set of FrameRanges for all animations in a database

Parameters:

database (AnimDatabase)

Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_force_root_lock_disabled(database, frame_ranges) → AnimDatabaseFrameRanges

Make a set of FrameRanges for just the animations with force root lock disabled in a set of frame ranges

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_force_root_lock_enabled(database, frame_ranges) → AnimDatabaseFrameRanges

Make a set of FrameRanges for just the animations with force root lock enabled in a set of frame ranges

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_frames(frames) → AnimDatabaseFrameRanges

Make a set of single frame FrameRanges from the given frames

Parameters:

frames (AnimDatabaseFrames)

Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_function(database, frame_ranges, function) → AnimDatabaseFrameRanges

Make a set of FrameRanges using the given UAnimDatabaseFrameRangesFunction object

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_looped(database, frame_ranges) → AnimDatabaseFrameRanges

Make a set of FrameRanges for just the animations which are looped in a set of frame ranges

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_mirrored(database, frame_ranges) → AnimDatabaseFrameRanges

Make a set of FrameRanges for just the mirrored animations in a set of frame ranges

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_not_looped(database, frame_ranges) → AnimDatabaseFrameRanges

Make a set of FrameRanges for just the animations which are not looped in a set of frame ranges

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_not_mirrored(database, frame_ranges) → AnimDatabaseFrameRanges

Make a set of FrameRanges for just the non-mirrored animations in a set of frame ranges

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_root_motion_disabled(database, frame_ranges) → AnimDatabaseFrameRanges

Make a set of FrameRanges for just the animations with root motion disabled in a set of frame ranges

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_root_motion_enabled(database, frame_ranges) → AnimDatabaseFrameRanges

Make a set of FrameRanges for just the animations with root motion enabled in a set of frame ranges

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_sequence_index(database, sequence_idx) → AnimDatabaseFrameRanges

Make a set of FrameRanges for a single sequence in a database

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_sequence_range(database, sequence_idx, range_start, range_length) → AnimDatabaseFrameRanges

Make a set of FrameRanges for a single range in a sequence in a database

Parameters:

  • database (AnimDatabase)

  • sequence_idx (int32)

  • range_start (int32)

  • range_length (int32)

Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_sequences(database, anim_sequences) → AnimDatabaseFrameRanges

Make a set of FrameRanges for out of all the given anim sequences

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frame_ranges_from_sync_marker(database, frame_ranges, sync_marker_name) → AnimDatabaseFrameRanges

Make a set of single frame FrameRanges from the given sync marker

Parameters:
Return type:

AnimDatabaseFrameRanges

classmethod make_frames_at_frame_ranges_ends(frame_ranges) → AnimDatabaseFrames

Make a set of Frames from all the end frames of a given FrameRanges set

Parameters:

frame_ranges (AnimDatabaseFrameRanges)

Return type:

AnimDatabaseFrames

classmethod make_frames_at_frame_ranges_starts(frame_ranges) → AnimDatabaseFrames

Make a set of Frames from all the start frames of a given FrameRanges set

Parameters:

frame_ranges (AnimDatabaseFrameRanges)

Return type:

AnimDatabaseFrames

classmethod make_frames_from_frame_ranges_interval(frame_ranges, interval_frames=10) → AnimDatabaseFrames

Make a set of Frames from the given FrameRanges set sampling frames at a regular interval

Parameters:
Return type:

AnimDatabaseFrames