unreal.AnimDatabaseFramesLibrary

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

Bases: BlueprintFunctionLibrary

Anim Database Frames Library

C++ Source:

  • Plugin: AnimDatabase

  • Module: AnimDatabase

  • File: AnimDatabaseFrameRanges.h

classmethod frames_after(database, frames, frames_after, shift_behavior=AnimDatabaseFrameShiftBehavior.REMOVE) → AnimDatabaseFrames

Make a set of Frames at a given number of frames after another set of frames. Will use ShiftBehavior to decided if to clamp or discard frames that fall out of the valid sequence range.

Parameters:
Return type:

AnimDatabaseFrames

classmethod frames_before(database, frames, frames_before, shift_behavior=AnimDatabaseFrameShiftBehavior.REMOVE) → AnimDatabaseFrames

Make a set of Frames at a given number of frames before another set of frames. Will use ShiftBehavior to decided if to clamp or discard frames that fall out of the valid sequence range.

Parameters:
Return type:

AnimDatabaseFrames

classmethod frames_difference(a, b) → AnimDatabaseFrames

Computes the difference of two sets of Frames

Parameters:
Return type:

AnimDatabaseFrames

classmethod frames_difference_from_array(frames) → AnimDatabaseFrames

Computes the difference of an array of Frames objects

Parameters:

frames (Array[AnimDatabaseFrames])

Return type:

AnimDatabaseFrames

classmethod frames_equal(a, b) → bool

Checks if two sets of Frames are equal

Parameters:
Return type:

bool

classmethod frames_intersection(a, b) → AnimDatabaseFrames

Computes the intersection of two sets of Frames

Parameters:
Return type:

AnimDatabaseFrames

classmethod frames_intersection_from_array(frames) → AnimDatabaseFrames

Computes the intersection of an array of Frames objects

Parameters:

frames (Array[AnimDatabaseFrames])

Return type:

AnimDatabaseFrames

classmethod frames_is_empty(frames) → bool

Check if the given set is empty

Parameters:

frames (AnimDatabaseFrames)

Return type:

bool

classmethod frames_none() → AnimDatabaseFrames

Makes an empty set of frames. (This is the same as MakeEmptyFrames).

Return type:

AnimDatabaseFrames

classmethod frames_to_string(frames) → str

Converts a Frames object to a string.

Parameters:

frames (AnimDatabaseFrames)

Return type:

str

classmethod frames_to_string_format(database, frames, cutoff=11) → str

Converts a Frames object to a string object in full.

Parameters:
Return type:

str

classmethod frames_union(a, b) → AnimDatabaseFrames

Computes the union of two sets of Frames

Parameters:
Return type:

AnimDatabaseFrames

classmethod frames_union_from_array(frames) → AnimDatabaseFrames

Computes the union of an array of Frames objects

Parameters:

frames (Array[AnimDatabaseFrames])

Return type:

AnimDatabaseFrames

classmethod make_empty_frames() → AnimDatabaseFrames

Make an empty set of Frames

Return type:

AnimDatabaseFrames

classmethod make_frames_from_anim_notifies_on_track(database, frame_ranges, track_name) → AnimDatabaseFrames

Make a set of Frames from the times given by all the instances of AnimNotifies in the database that are on a track with the given name

Parameters:
Return type:

AnimDatabaseFrames

classmethod make_frames_from_anim_notify(database, frame_ranges, notify) → AnimDatabaseFrames

Make a set of Frames from the times given by all the instances of the given AnimNotify class in the database

Parameters:
Return type:

AnimDatabaseFrames

classmethod make_frames_from_anim_notify_state_end(database, frame_ranges, state) → AnimDatabaseFrames

Make a set of Frames from the end times of all the instances of the given UAnimNotifyState class in the database

Parameters:
Return type:

AnimDatabaseFrames

classmethod make_frames_from_anim_notify_state_start(database, frame_ranges, state) → AnimDatabaseFrames

Make a set of Frames from the start times of all the instances of the given UAnimNotifyState class in the database

Parameters:
Return type:

AnimDatabaseFrames

classmethod make_frames_from_anim_notify_union(database, frame_ranges, notifies) → AnimDatabaseFrames

Make a set of Frames from all of the given anim notifies

Parameters:
Return type:

AnimDatabaseFrames

classmethod make_frames_from_class(database, frame_ranges, class_) → AnimDatabaseFrames

Make a set of Frames using the given class

Parameters:
Return type:

AnimDatabaseFrames

classmethod make_frames_from_function(database, frame_ranges, function) → AnimDatabaseFrames

Make a set of Frames using the given function

Parameters:
Return type:

AnimDatabaseFrames

classmethod make_frames_from_sequence_and_time(database, sequence_idx, time) → AnimDatabaseFrames

Make a set of Frames consisting of a single frame from the given Sequence Index in the Database, at the given time

Parameters:
Return type:

AnimDatabaseFrames

classmethod make_frames_from_sync_marker(database, frame_ranges, sync_marker_name) → AnimDatabaseFrames

Make a set of Frames from the times given by all the instances of the given SyncMarker in the database

Parameters:
Return type:

AnimDatabaseFrames