unreal.AnimDataModel
¶
- class unreal.AnimDataModel(outer: Optional[Object] = None, name: Union[Name, str] = 'None')¶
Bases:
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 databone_animation_tracks
(Array[BoneAnimationTrack]): [Read-Only] Bone Animation Tracks: All individual bone animation trackscurve_data
(AnimationCurveData): [Read-Only] Curve Data: Container with all animated curve dataframe_rate
(FrameRate): [Read-Only] Frame Rate: Rate at which the animated data is sampledmodified_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 framesnumber_of_keys
(int32): [Read-Only] Number Of Keys: Total number of sampled animated keysplay_length
(float): [Read-Only] Play Length: Total playable length of the contained animation data
- property animated_bone_attributes: Array[AnimatedBoneAttribute]¶
[Read-Only] Animated Bone Attributes: Container with all animated (bone) attribute data
- Type:
- property bone_animation_tracks: Array[BoneAnimationTrack]¶
[Read-Only] Bone Animation Tracks: All individual bone animation tracks
- Type:
- property curve_data: AnimationCurveData¶
[Read-Only] Curve Data: Container with all animated curve data
- Type:
- property frame_rate: FrameRate¶
[Read-Only] Frame Rate: Rate at which the animated data is sampled
- Type:
- get_animation_sequence() AnimSequence ¶
- Returns:
The outer UAnimSequence object if found, otherwise returns a nullptr
- Return type:
- get_bone_animation_tracks() Array[BoneAnimationTrack] ¶
- Returns:
Array containg all bone animation tracks
- Return type:
- get_bone_track_by_index(track_index) BoneAnimationTrack ¶
- Parameters:
track_index (int32) –
- Returns:
Bone animation track for the provided index
- Return type:
- get_bone_track_by_name(track_name) BoneAnimationTrack ¶
- Parameters:
track_name (Name) –
- Returns:
Bone animation track for the provided (bone) name
- Return type:
- 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() Array[Name] ¶
Populates the provided array with all contained (bone) track names
- 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
- is_valid_bone_track_index(track_index) bool ¶
- Parameters:
track_index (int32) –
- Returns:
Whether or not the provided track index is valid
- Return type:
- property modified_event: AnimDataModelModifiedDynamicEvent¶
[Read-Write] Modified Event Dynamic: Dynamic delegate event allows scripting to register to any broadcasted notify.
- property number_of_frames: int¶
[Read-Only] Number Of Frames: Total number of sampled animated frames
- Type:
(int32)