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] Whether to automatically add curve metadata to an animation’s skeleton. If this 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] Which animation range to import. The one defined at Exported, at Animated time or define a range manually

  • 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 true, all previous node attributes imported as Animation Curves will be deleted when doing a re-import.

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

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

  • do_not_import_curve_with_zero (bool): [Read-Write] When importing custom attribute or morphtarget as curve, do not import if it doesn’t have any value other than zero. This is to avoid adding extra curves to evaluate

  • frame_import_range (Int32Interval): [Read-Write] Frame range used when Set Range is used in Animation Length

  • import_animations (bool): [Read-Write] If enable, import all animation assets find in the sources.

  • 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 true, import node attributes as either Animation Curves or Animation Attributes

  • material_curve_suffixes (Array[str]): [Read-Write] Set Material Curve Type for the custom attribute with the following suffixes. This doesn’t matter if Set Material Curve Type is true

  • remove_curve_redundant_keys (bool): [Read-Write] When importing custom attribute as curve, remove redundant keys

  • set_material_drive_parameter_on_custom_attribute (bool): [Read-Write] Set Material Curve Type for all custom attributes that exists

  • 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] Whether to automatically add curve metadata to an animation’s skeleton. If this 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

[Read-Write] Which animation range to import. The one defined at Exported, at Animated time or define a range manually

Type:

(InterchangeAnimationRange)

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 true, all previous node attributes imported as Animation Curves will be deleted when doing a re-import.

Type:

(bool)

property delete_existing_morph_target_curves: bool

[Read-Write] If true, all previous morph target curves will be deleted when doing a re-import

Type:

(bool)

property delete_existing_non_curve_custom_attributes: bool

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

Type:

(bool)

property do_not_import_curve_with_zero: bool

[Read-Write] When importing custom attribute or morphtarget as curve, do not import if it doesn’t have any value other than zero. This is to avoid adding extra curves to evaluate

Type:

(bool)

property frame_import_range: Int32Interval

[Read-Write] Frame range used when Set Range is used in Animation Length

Type:

(Int32Interval)

property import_animations: bool

[Read-Write] If enable, import all animation assets find in the sources.

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 true, import node attributes as either Animation Curves or Animation Attributes

Type:

(bool)

property material_curve_suffixes: None

[Read-Write] Set Material Curve Type for the custom attribute with the following suffixes. This doesn’t matter if Set Material Curve Type is true

Type:

(Array[str])

property remove_curve_redundant_keys: bool

[Read-Write] When importing custom attribute as curve, remove redundant keys

Type:

(bool)

property set_material_drive_parameter_on_custom_attribute: bool

[Read-Write] Set Material Curve Type for all custom attributes that exists

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)