unreal.InterchangeAnimSequenceFactoryNode

class unreal.InterchangeAnimSequenceFactoryNode(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: InterchangeFactoryBaseNode

ns UE::Interchange

C++ Source:

• Plugin: Interchange

• Module: InterchangeFactoryNodes

• File: InterchangeAnimSequenceFactoryNode.h

get_animated_attribute_curve_name(index) → str

Get an animated attribute curve name point by 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 how many animated attribute curve names this anim sequence drive (curve are FRichCurve of type float).

Return type:

int32

get_animated_attribute_step_curve_name(index) → str

Get an animated attribute step curve name point by 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 how many animated attribute step curve names this anim sequence drive.

Return type:

int32

get_animated_material_curve_suffixe(index) → str

Get an animated material curve suffixe point by 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 how many animated material curve suffixes this anim sequence drive (curve are FRichCurve of type float).

Return type:

int32

get_animated_morph_target_dependecies_count() → int32

return how many animated moprh target (moprh target are translated into a mesh node and can be animated with a float curve) this anim sequence depends on.

Return type:

int32

get_animated_morph_target_dependencies() → Array[str]

Get all animated moprh target unique id (moprh target are translated into a mesh node and can be animated with a float curve) this anim sequence depends on.

Returns:

out_dependencies (Array[str]):

Return type:

Array[str]

get_animated_morph_target_dependency(index) → str

Get an animated moprh target unique id (moprh target are translated into a mesh node and can be animated with a float curve) point by the specified index.

Parameters:

index (int32) –

Returns:

out_dependency (str):

Return type:

str

get_animation_payload_key_from_morph_target_node_uid(morph_target_node_uid) → str or None

Get Animation Payload Key from Morph Target Node Uid

Parameters:

morph_target_node_uid (str) –

Returns:

out_payload_key (str):

Return type:

str or None

get_animation_payload_key_from_scene_node_uid(scene_node_uid) → str or None

Get Animation Payload Key from Scene Node Uid

Parameters:

scene_node_uid (str) –

Returns:

out_payload_key (str):

Return type:

str 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 will be deleted when doing a re-import.

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 moprh target curves will be deleted when doing a re-import.

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 will be deleted when doing a re-import.

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 value is true, do not import if it doesn’t have any value other than zero. 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 this mean we want to import all user custom attributes we can find on a node.

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. The attribute will be true if we need to import bone tracks. False if we do not import bone tracks.

Note - Return false if the attribute is not set. Return true if the attribute exist and can be query.

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 second. 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 second. 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, Set Material Curve Type for all custom attributes that exists.

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 skeleton factory node unique id. 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 anim must use. The anim sequence factory will use this skeleton instead of the imported one (from GetCustomSkeletonFactoryNodeUid) if this attribute is set and the skeleton pointer is valid. Pipeline set this attribute in case the user want 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, str]

Get Morph Target Node Animation Payload Keys

Returns:

out_morph_target_node_animation_payloads (Map[str, str]):

Return type:

Map[str, str]

get_object_class()

Get the class this node want to create

Return type:

type(Class)

get_scene_node_animation_payload_keys() → Map[str, str]

Get Scene Node Animation Payload Keys

Returns:

out_scene_node_animation_payloads (Map[str, str]):

Return type:

Map[str, str]

initialize_anim_sequence_node(unique_id, display_label) → None

Initialize node data

Parameters:

• unique_id (str) – The uniqueId for this node

• display_label (str) – The name of the node

remove_animated_attribute_curve_name(attribute_curve_name) → bool

Remove one animated attribute curve name.

Parameters:

attribute_curve_name (str) –

Return type:

bool

remove_animated_attribute_step_curve_name(attribute_step_curve_name) → bool

Remove one animated attribute step curve name.

Parameters:

attribute_step_curve_name (str) –

Return type:

bool

remove_animated_material_curve_suffixe(material_curve_suffixe) → bool

Remove one animated material curve suffixe.

Parameters:

material_curve_suffixe (str) –

Return type:

bool

remove_animated_morph_target_dependency_uid(dependency_uid) → bool

Remove one animated moprh target unique id (moprh target are translated into a mesh node and can be animated with a float curve). Return false if we cannot remove the moprh target unique id.

Parameters:

dependency_uid (str) –

Return type:

bool

remove_animation_payload_key_for_morph_target_node_uid(morph_target_node_uid) → bool

Remove Animation Payload Key for Morph Target Node Uid

Parameters:

morph_target_node_uid (str) –

Return type:

bool

remove_animation_payload_key_for_scene_node_uid(scene_node_uid) → bool

Remove Animation Payload Key for Scene Node Uid

Parameters:

scene_node_uid (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 suffixe.

Parameters:

material_curve_suffixe (str) –

Return type:

bool

set_animated_morph_target_dependency_uid(dependency_uid) → bool

Add an animated moprh target unique id (moprh target are translated into a mesh node and can be animated with a float curve).

Parameters:

dependency_uid (str) –

Return type:

bool

set_animation_payload_key_for_morph_target_node_uid(morph_target_node_uid, payload_key) → bool

Set Animation Payload Key for Morph Target Node Uid

Parameters:

• morph_target_node_uid (str) –

• payload_key (str) –

Return type:

bool

set_animation_payload_key_for_scene_node_uid(scene_node_uid, payload_key) → bool

Set Animation Payload Key for Scene Node Uid

Parameters:

• scene_node_uid (str) –

• payload_key (str) –

Return type:

bool

set_custom_delete_existing_custom_attribute_curves(attribute_value) → bool

Set the custom attribute DeleteExistingCustomAttributeCurves. Return false if the attribute cannot be set.

Note - If true, all previous custom attribute curves will be deleted when doing a re-import.

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 cannot be set.

Note - If true, all previous moprh target curves will be deleted when doing a re-import.

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 cannot be set.

Note - If true, all previous non-curve custom attributes will be deleted when doing a re-import.

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 cannot be set.

Note - If value is true, do not import if it doesn’t have any value other than zero. 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 cannot 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, 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 second. Return false if the attribute cannot 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 second. Return false if the attribute cannot 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 cannot 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 cannot be set.

Note - If true, Set Material Curve Type for all custom attributes that exists.

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 cannot be set.

Parameters:

attribute_value (bool) –

Return type:

bool

set_custom_skeleton_factory_node_uid(attribute_value) → bool

Set the skeleton factory node unique id. 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 anim must use. The AnimSequence factory will use this skeleton instead of the imported one (from GetCustomSkeletonFactoryNodeUid) if this attribute is set and the skeleton pointer is valid. Pipeline set this attribute in case the user want to specify an existing skeleton.

Parameters:

attribute_value (SoftObjectPath) –

Return type:

bool