unreal.InterchangeAnimSequenceFactoryNode

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

Bases: InterchangeFactoryBaseNode

Interchange Anim Sequence Factory Node

C++ Source:

• Plugin: Interchange

• Module: InterchangeFactoryNodes

• File: InterchangeAnimSequenceFactoryNode.h

get_animated_attribute_curve_name(index) → str

Get the animated attribute curve name at the specified index.

Parameters:

index (int32) –

Returns:

out_attribute_curve_name (str):

Return type:

str

get_animated_attribute_curve_names() → Array[str]

Get all animated attribute curve names.

Returns:

out_attribute_curve_names (Array[str]):

Return type:

Array[str]

get_animated_attribute_curve_names_count() → int32

Return the number of animated attribute curve names this anim sequence drives. Curves are FRichCurve of type float.

Return type:

int32

get_animated_attribute_step_curve_name(index) → str

Get the animated attribute step curve name at the specified index.

Parameters:

index (int32) –

Returns:

out_attribute_step_curve_name (str):

Return type:

str

get_animated_attribute_step_curve_names() → Array[str]

Get all animated attribute step curve names.

Returns:

out_attribute_step_curve_names (Array[str]):

Return type:

Array[str]

get_animated_attribute_step_curve_names_count() → int32

Return the number of animated attribute step curve names this anim sequence drives.

Return type:

int32

get_animated_material_curve_suffixe(index) → str

Get the animated material curve suffix with the specified index.

Parameters:

index (int32) –

Returns:

out_material_curve_suffixe (str):

Return type:

str

get_animated_material_curve_suffixes() → Array[str]

Get all animated material curve suffixes.

Returns:

out_material_curve_suffixes (Array[str]):

Return type:

Array[str]

get_animated_material_curve_suffixes_count() → int32

Return the number of animated material curve suffixes this anim sequence drives. Curves are FRichCurve of type float.

Return type:

int32

get_custom_add_curve_metadata_to_skeleton() → bool or None

Get the custom attribute AddCurveMetadataToSkeleton. Return false if the attribute is not set.

Note - 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.

Returns:

attribute_value (bool):

Return type:

bool or None

get_custom_delete_existing_custom_attribute_curves() → bool or None

Get the custom attribute DeleteExistingCustomAttributeCurves. Return false if the attribute is not set.

Note - If true, all previous custom attribute curves are deleted if you reimport.

Returns:

attribute_value (bool):

Return type:

bool or None

get_custom_delete_existing_morph_target_curves() → bool or None

Get the custom attribute DeleteExistingMorphTargetCurves. Return false if the attribute is not set.

Note: If true, all previous morph target curves are deleted if you reimport.

Returns:

attribute_value (bool):

Return type:

bool or None

get_custom_delete_existing_non_curve_custom_attributes() → bool or None

Get the custom attribute DeleteExistingNonCurveCustomAttributes. Return false if the attribute is not set.

Note - If true, all previous non-curve custom attributes are deleted if you reimport.

Returns:

attribute_value (bool):

Return type:

bool or None

get_custom_do_not_import_curve_with_zero() → bool or None

Get the custom attribute DoNotImportCurveWithZero. Return false if the attribute is not set.

Note - If this attribute is enabled, only curves that have a value other than zero will be imported. This is to avoid adding extra curves to evaluate.

Returns:

attribute_value (bool):

Return type:

bool or None

get_custom_import_attribute_curves() → bool or None

Get the import attribute curves state. If true, all user custom attributes on nodes are imported.

Return false if the attribute is not set.

Returns:

attribute_value (bool):

Return type:

bool or None

get_custom_import_bone_tracks() → bool or None

Get the import bone tracks state. If the attribute is true, bone tracks are imported. If the attribute is false, bone tracks are not imported.

Return false if the attribute is not set. Return true if the attribute exists and can be queried.

Returns:

attribute_value (bool):

Return type:

bool or None

get_custom_import_bone_tracks_range_start() → double or None

Get the import bone tracks start time in seconds. Return false if the attribute is not set.

Returns:

attribute_value (double):

Return type:

double or None

get_custom_import_bone_tracks_range_stop() → double or None

Get the import bone tracks end time in seconds. Return false if the attribute is not set.

Returns:

attribute_value (double):

Return type:

double or None

get_custom_import_bone_tracks_sample_rate() → double or None

Get the import bone tracks sample rate. Return false if the attribute is not set.

Returns:

attribute_value (double):

Return type:

double or None

get_custom_material_drive_parameter_on_custom_attribute() → bool or None

Get the custom attribute MaterialDriveParameterOnCustomAttribute. Return false if the attribute is not set.

Note: If true, sets Material Curve Type for all custom attributes.

Returns:

attribute_value (bool):

Return type:

bool or None

get_custom_remove_curve_redundant_keys() → bool or None

Get the custom attribute RemoveCurveRedundantKeys. Return false if the attribute is not set.

Returns:

attribute_value (bool):

Return type:

bool or None

get_custom_skeleton_factory_node_uid() → str or None

Get the unique ID of the skeleton factory node. Return false if the attribute is not set.

Returns:

attribute_value (str):

Return type:

str or None

get_custom_skeleton_soft_object_path() → SoftObjectPath or None

Query the optional existing USkeleton this animation must use. If this attribute is set and the skeleton is valid, the AnimSequence factory uses this skeleton instead of the one imported from GetCustomSkeletonFactoryNodeUid. Pipelines set this attribute when the user wants to specify an existing skeleton. Return false if the attribute was not set.

Returns:

attribute_value (SoftObjectPath):

Return type:

SoftObjectPath or None

get_morph_target_node_animation_payload_keys() → Map[str, InterchangeAnimationPayLoadKey]

Get Morph Target Node Animation Payload Keys

Returns:

out_morph_target_node_animation_payloads (Map[str, InterchangeAnimationPayLoadKey]):

Return type:

Map[str, InterchangeAnimationPayLoadKey]

get_object_class()

Get the class this node creates.

Return type:

type(Class)

get_scene_node_animation_payload_keys() → Map[str, InterchangeAnimationPayLoadKey]

Get Scene Node Animation Payload Keys

Returns:

out_scene_node_animation_payload_keys (Map[str, InterchangeAnimationPayLoadKey]):

Return type:

Map[str, InterchangeAnimationPayLoadKey]

initialize_anim_sequence_node(unique_id, display_label) → None

Initialize node data.

Parameters:

• unique_id (str) – The unique ID for this node.

• display_label (str) – The name of the node.

remove_animated_attribute_curve_name(attribute_curve_name) → bool

Remove the specified animated attribute curve name.

Parameters:

attribute_curve_name (str) –

Return type:

bool

remove_animated_attribute_step_curve_name(attribute_step_curve_name) → bool

Remove the specified animated attribute step curve name.

Parameters:

attribute_step_curve_name (str) –

Return type:

bool

remove_animated_material_curve_suffixe(material_curve_suffixe) → bool

Remove the specified animated material curve suffix.

Parameters:

material_curve_suffixe (str) –

Return type:

bool

set_animated_attribute_curve_name(attribute_curve_name) → bool

Add an animated attribute curve name.

Parameters:

attribute_curve_name (str) –

Return type:

bool

set_animated_attribute_step_curve_name(attribute_step_curve_name) → bool

Add an animated attribute step curve name.

Parameters:

attribute_step_curve_name (str) –

Return type:

bool

set_animated_material_curve_suffixe(material_curve_suffixe) → bool

Add an animated material curve suffix.

Parameters:

material_curve_suffixe (str) –

Return type:

bool

set_animation_payload_keys_for_morph_target_node_uids(morph_target_animation_payload_key_uids, morph_target_animation_payload_key_types) → None

Set Animation Payload Keys for Morph Target Node Uids

Parameters:

• morph_target_animation_payload_key_uids (Map[str, str]) –

• morph_target_animation_payload_key_types (Map[str, uint8]) –

set_animation_payload_keys_for_scene_node_uids(scene_node_animation_payload_key_uids, scene_node_animation_payload_key_types) → None

Set Animation Payload Keys for Scene Node Uids

Parameters:

• scene_node_animation_payload_key_uids (Map[str, str]) –

• scene_node_animation_payload_key_types (Map[str, uint8]) –

set_custom_add_curve_metadata_to_skeleton(attribute_value) → bool

Set the custom attribute AddCurveMetadataToSkeleton. Return false if the attribute could not be set.

Note - 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.

Parameters:

attribute_value (bool) –

Return type:

bool

set_custom_delete_existing_custom_attribute_curves(attribute_value) → bool

Set the custom attribute DeleteExistingCustomAttributeCurves. Return false if the attribute could not be set.

Note - If true, all previous custom attribute curves are deleted if you reimport.

Parameters:

attribute_value (bool) –

Return type:

bool

set_custom_delete_existing_morph_target_curves(attribute_value) → bool

Set the custom attribute DeleteExistingMorphTargetCurves. Return false if the attribute could not be set.

Note: If true, all previous morph target curves are deleted if you reimport.

Parameters:

attribute_value (bool) –

Return type:

bool

set_custom_delete_existing_non_curve_custom_attributes(attribute_value) → bool

Set the custom attribute DeleteExistingNonCurveCustomAttributes. Return false if the attribute could not be set.

Note - If true, all previous non-curve custom attributes are deleted if you reimport.

Parameters:

attribute_value (bool) –

Return type:

bool

set_custom_do_not_import_curve_with_zero(attribute_value) → bool

Set the custom attribute DoNotImportCurveWithZero. Return false if the attribute could not be set.

Note - If this attribute is enabled, only curves that have a value other than zero will be imported. This is to avoid adding extra curves to evaluate.

Parameters:

attribute_value (bool) –

Return type:

bool

set_custom_import_attribute_curves(attribute_value) → bool

Set the import attribute curves state. Return false if the attribute could not be set.

Parameters:

attribute_value (bool) –

Return type:

bool

set_custom_import_bone_tracks(attribute_value) → bool

Set the import bone tracks state. Pass true to import bone tracks, or false to not import bone tracks.

Parameters:

attribute_value (bool) –

Return type:

bool

set_custom_import_bone_tracks_range_start(attribute_value) → bool

Set the import bone tracks start time in seconds. Return false if the attribute could not be set.

Parameters:

attribute_value (double) –

Return type:

bool

set_custom_import_bone_tracks_range_stop(attribute_value) → bool

Set the import bone tracks end time in seconds. Return false if the attribute could not be set.

Parameters:

attribute_value (double) –

Return type:

bool

set_custom_import_bone_tracks_sample_rate(attribute_value) → bool

Set the import bone tracks sample rate. Return false if the attribute could not be set.

Parameters:

attribute_value (double) –

Return type:

bool

set_custom_material_drive_parameter_on_custom_attribute(attribute_value) → bool

Set the custom attribute MaterialDriveParameterOnCustomAttribute. Return false if the attribute could not be set.

Note: If true, sets Material Curve Type for all custom attributes.

Parameters:

attribute_value (bool) –

Return type:

bool

set_custom_remove_curve_redundant_keys(attribute_value) → bool

Set the custom attribute RemoveCurveRedundantKeys. Return false if the attribute could not be set.

Parameters:

attribute_value (bool) –

Return type:

bool

set_custom_skeleton_factory_node_uid(attribute_value) → bool

Set the unique ID of the skeleton factory node. Return false if the attribute cannot be set.

Parameters:

attribute_value (str) –

Return type:

bool

set_custom_skeleton_soft_object_path(attribute_value) → bool

Set the optional existing USkeleton this animation must use. If this attribute is set and the skeleton is valid, the AnimSequence factory uses this skeleton instead of the one imported from GetCustomSkeletonFactoryNodeUid. Pipelines set this attribute when the user wants to specify an existing skeleton.

Parameters:

attribute_value (SoftObjectPath) –

Return type:

bool