unreal.InterchangeGenericAnimationPipeline

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

Bases: InterchangePipelineBase

Interchange Generic Animation Pipeline

C++ Source:

  • Plugin: Interchange

  • Module: InterchangePipelines

  • File: InterchangeGenericAnimationPipeline.h

Editor Properties: (see get_editor_property/set_editor_property)

  • add_curve_metadata_to_skeleton (bool): [Read-Write] Determines whether to automatically add curve metadata to an animation’s skeleton. If this setting is disabled, curve metadata will be added to skeletal meshes for morph targets, but no metadata entry will be created for general curves.

  • animation_range (InterchangeAnimationRange): [Read-Write] Determines which animation range to import: the range defined at export, the range of frames with animation, or a manually defined range.

  • custom_bone_animation_sample_rate (int32): [Read-Write] Sample fbx animation data at the specified sample rate, 0 find automaticaly the best sample rate

  • delete_existing_custom_attribute_curves (bool): [Read-Write] If enabled, all previous node attributes imported as Animation Curves will be deleted when doing a reimport.

  • delete_existing_morph_target_curves (bool): [Read-Write] If enabled, all previous morph target curves will be deleted when doing a reimport.

  • delete_existing_non_curve_custom_attributes (bool): [Read-Write] If enabled, all previous node attributes imported as Animation Attributes will be deleted when doing a reimport.

  • do_not_import_curve_with_zero (bool): [Read-Write] When importing a custom attribute or morph target as a curve, only import if it has a value other than zero. This avoids adding extra curves to evaluate.

  • frame_import_range (Int32Interval): [Read-Write] The frame range used when the Animation Length setting is set to Set Range.

  • import_animations (bool): [Read-Write] If enabled, import all animation assets found in the source.

  • import_bone_tracks (bool): [Read-Write] Import bone transform tracks. If false, this will discard any bone transform tracks.

  • import_custom_attribute (bool): [Read-Write] If enabled, import node attributes as either Animation Curves or Animation Attributes.

  • material_curve_suffixes (Array[str]): [Read-Write] Set the Material Curve Type for custom attributes that have the specified suffixes. This setting is not used if the Set Material Curve Type setting is enabled.

  • remove_curve_redundant_keys (bool): [Read-Write] When importing custom attributes as curves, remove redundant keys.

  • set_material_drive_parameter_on_custom_attribute (bool): [Read-Write] Set the material curve type for all custom attributes.

  • snap_to_closest_frame_boundary (bool): [Read-Write] If enabled, snaps the animation to the closest frame boundary using the import sampling rate.

  • use30_hz_to_bake_bone_animation (bool): [Read-Write] If enabled, samples all animation curves to 30 FPS

property add_curve_metadata_to_skeleton: bool

[Read-Write] Determines whether to automatically add curve metadata to an animation’s skeleton. If this setting is disabled, curve metadata will be added to skeletal meshes for morph targets, but no metadata entry will be created for general curves.

Type:

(bool)

property animation_range: InterchangeAnimationRange

the range defined at export, the range of frames with animation, or a manually defined range.

Type:

(InterchangeAnimationRange)

Type:

[Read-Write] Determines which animation range to import

property custom_bone_animation_sample_rate: int

[Read-Write] Sample fbx animation data at the specified sample rate, 0 find automaticaly the best sample rate

Type:

(int32)

property delete_existing_custom_attribute_curves: bool

[Read-Write] If enabled, all previous node attributes imported as Animation Curves will be deleted when doing a reimport.

Type:

(bool)

property delete_existing_morph_target_curves: bool

[Read-Write] If enabled, all previous morph target curves will be deleted when doing a reimport.

Type:

(bool)

property delete_existing_non_curve_custom_attributes: bool

[Read-Write] If enabled, all previous node attributes imported as Animation Attributes will be deleted when doing a reimport.

Type:

(bool)

property do_not_import_curve_with_zero: bool

[Read-Write] When importing a custom attribute or morph target as a curve, only import if it has a value other than zero. This avoids adding extra curves to evaluate.

Type:

(bool)

property frame_import_range: Int32Interval

[Read-Write] The frame range used when the Animation Length setting is set to Set Range.

Type:

(Int32Interval)

property import_animations: bool

[Read-Write] If enabled, import all animation assets found in the source.

Type:

(bool)

property import_bone_tracks: bool

[Read-Write] Import bone transform tracks. If false, this will discard any bone transform tracks.

Type:

(bool)

property import_custom_attribute: bool

[Read-Write] If enabled, import node attributes as either Animation Curves or Animation Attributes.

Type:

(bool)

property material_curve_suffixes: None

[Read-Write] Set the Material Curve Type for custom attributes that have the specified suffixes. This setting is not used if the Set Material Curve Type setting is enabled.

Type:

(Array[str])

property remove_curve_redundant_keys: bool

[Read-Write] When importing custom attributes as curves, remove redundant keys.

Type:

(bool)

property set_material_drive_parameter_on_custom_attribute: bool

[Read-Write] Set the material curve type for all custom attributes.

Type:

(bool)

property snap_to_closest_frame_boundary: bool

[Read-Write] If enabled, snaps the animation to the closest frame boundary using the import sampling rate.

Type:

(bool)

property use30_hz_to_bake_bone_animation: bool

[Read-Write] If enabled, samples all animation curves to 30 FPS

Type:

(bool)