unreal.AnimDataModel

class unreal.AnimDataModel(outer=None, name='None')

Bases: unreal.Object

The Model represents the source data for animations. It contains both bone animation data as well as animated curves. They are currently only a sub-object of a AnimSequenceBase instance. The instance derives all runtime data from the source data.

C++ Source:

• Module: Engine

• File: AnimDataModel.h

Editor Properties: (see get_editor_property/set_editor_property)

• animated_bone_attributes (Array(AnimatedBoneAttribute)): [Read-Only] Animated Bone Attributes: Container with all animated (bone) attribute data

• bone_animation_tracks (Array(BoneAnimationTrack)): [Read-Only] Bone Animation Tracks: All individual bone animation tracks

• curve_data (AnimationCurveData): [Read-Only] Curve Data: Container with all animated curve data

• frame_rate (FrameRate): [Read-Only] Frame Rate: Rate at which the animated data is sampled

• modified_event (AnimDataModelModifiedDynamicEvent): [Read-Write] Modified Event Dynamic: Dynamic delegate event allows scripting to register to any broadcasted notify.

• number_of_frames (int32): [Read-Only] Number Of Frames: Total number of sampled animated frames

• number_of_keys (int32): [Read-Only] Number Of Keys: Total number of sampled animated keys

• play_length (float): [Read-Only] Play Length: Total playable length of the contained animation data

• raw_animation_track_names (Array(Name)): [Read-Only] Raw Animation Track Names

• raw_animation_track_skeleton_mappings (Array(TrackToSkeletonMap)): [Read-Only] Raw Animation Track Skeleton Mappings

• raw_animation_tracks (Array(RawAnimSequenceTrack)): [Read-Only] Raw Animation Tracks: Transient data, kept around for backward-compatibility

• raw_curve_tracks (RawCurveTracks): [Read-Only] Raw Curve Tracks

property animated_bone_attributes

[Read-Only] Animated Bone Attributes: Container with all animated (bone) attribute data

Type

(Array(AnimatedBoneAttribute))

property bone_animation_tracks

[Read-Only] Bone Animation Tracks: All individual bone animation tracks

Type

(Array(BoneAnimationTrack))

property curve_data

[Read-Only] Curve Data: Container with all animated curve data

Type

(AnimationCurveData)

property frame_rate

[Read-Only] Frame Rate: Rate at which the animated data is sampled

Type

(FrameRate)

get_animation_sequence() → AnimSequence

Returns

The outer UAnimSequence object if found, otherwise returns a nullptr

Return type

AnimSequence

get_bone_animation_tracks()

Returns

Array containg all bone animation tracks

Return type

Array(BoneAnimationTrack)

get_bone_track_by_index(track_index) → BoneAnimationTrack

Parameters

track_index (int32) –

Returns

Bone animation track for the provided index

Return type

BoneAnimationTrack

get_bone_track_by_name(track_name) → BoneAnimationTrack

Parameters

track_name (Name) –

Returns

Bone animation track for the provided (bone) name

Return type

BoneAnimationTrack

get_bone_track_index(track) → int32

Parameters

track (BoneAnimationTrack) –

Returns

Internal track index for the provided bone animation track if found, otherwise returns INDEX_NONE

Return type

int32

get_bone_track_index_by_name(track_name) → int32

Parameters

track_name (Name) –

Returns

Internal track index for the provided (bone) name if found, otherwise returns INDEX_NONE

Return type

int32

get_bone_track_names()

Populates the provided array with all contained (bone) track names

Returns

out_names (Array(Name)): [out] Array containing all bone track names

Return type

Array(Name)

get_frame_rate() → FrameRate

Returns

Frame rate at which the animation data is key-ed

Return type

FrameRate

get_num_bone_tracks() → int32

Returns

Total number of bone animation tracks

Return type

int32

get_number_of_float_curves() → int32

Returns

Total number of stored float curves

Return type

int32

get_number_of_frames() → int32

Returns

Total number of frames of animation data stored

Return type

int32

get_number_of_keys() → int32

Returns

Total number of animation data keys stored

Return type

int32

get_number_of_transform_curves() → int32

Returns

Total number of stored FTransform curves

Return type

int32

get_play_length() → float

Returns

Total length of play-able animation data

Return type

float

is_valid_bone_track_index(track_index) → bool

Parameters

track_index (int32) –

Returns

Whether or not the provided track index is valid

Return type

bool

property modified_event

[Read-Write] Modified Event Dynamic: Dynamic delegate event allows scripting to register to any broadcasted notify.

Type

(AnimDataModelModifiedDynamicEvent)

property number_of_frames

[Read-Only] Number Of Frames: Total number of sampled animated frames

Type

(int32)

property number_of_keys

[Read-Only] Number Of Keys: Total number of sampled animated keys

Type

(int32)

property play_length

[Read-Only] Play Length: Total playable length of the contained animation data

Type

(float)