unreal.InterchangeSceneNode

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

Bases: InterchangeBaseNode

The scene node represents a transform node in the scene. Scene nodes can have user-defined attributes. Use UInterchangeUserDefinedAttributesAPI to get and set user-defined attribute data.

C++ Source:

• Plugin: Interchange

• Module: InterchangeNodes

• File: InterchangeSceneNode.h

add_component_uid(component_uid) → bool

Add Component Uid

Parameters:

component_uid (str)

Return type:

bool

add_specialized_type(specialized_type) → bool

Add Specialized Type

Parameters:

specialized_type (str)

Return type:

bool

get_animation_curve_type_for_curve_name(curve_name) → InterchangeAnimationPayLoadType or None

Gets the Animation Curve Type for the given CurveName.

Parameters:

curve_name (str)

Returns:

out_curve_animation_type (InterchangeAnimationPayLoadType):

Return type:

InterchangeAnimationPayLoadType or None

get_component_uids() → Array[str]

Get Component Uids

Returns:

out_component_uids (Array[str]):

Return type:

Array[str]

get_custom_actor_visibility() → bool or None

Gets whether actors spawned from this node should be visible

Returns:

out_is_visible (bool):

Return type:

bool or None

get_custom_animation_asset_uid_to_play() → str or None

Get the Animation Asset To Play by this Scene Node.

Returns:

attribute_value (str):

Return type:

str or None

get_custom_asset_instance_uid() → str or None

Get which asset, if any, a scene node is instantiating. Return false if the Attribute was not set previously.

Returns:

attribute_value (str):

Return type:

str or None

get_custom_bind_pose_global_transform(base_node_container, global_offset_transform, force_recache=False) → Transform or None

Get the global transform of the bind pose scene node. This value is computed from the local transforms of all parent bind poses.

Parameters:

• base_node_container (InterchangeBaseNodeContainer)

• global_offset_transform (Transform)

• force_recache (bool)

Returns:

attribute_value (Transform):

Return type:

Transform or None

get_custom_bind_pose_local_transform() → Transform or None

Get the local transform of the bind pose scene node.

Returns:

attribute_value (Transform):

Return type:

Transform or None

get_custom_component_visibility() → bool or None

Gets whether components spawned from this node should be visible

Returns:

out_is_visible (bool):

Return type:

bool or None

get_custom_geometric_transform() → Transform or None

Get the geometric offset. Any mesh attached to this scene node will be offset using this transform.

Returns:

attribute_value (Transform):

Return type:

Transform or None

get_custom_global_matrix_for_t0_rebinding() → Matrix or None

Gets the Global Transformation Matrix used for T0 rebinding.

Returns:

attribute_value (Matrix):

Return type:

Matrix or None

get_custom_global_transform(base_node_container, global_offset_transform, force_recache=False) → Transform or None

Get the default scene node global transform. This value is computed from the local transforms of all parent scene nodes.

Parameters:

• base_node_container (InterchangeBaseNodeContainer)

• global_offset_transform (Transform)

• force_recache (bool)

Returns:

attribute_value (Transform):

Return type:

Transform or None

get_custom_has_bind_pose() → bool or None

Gets if the joint has BindPose (if the setter was used, otherwise returns with false and T0 evaluation presumes bHasBindPose==true).

Returns:

has_bind_pose (bool):

Return type:

bool or None

get_custom_is_scene_root() → bool or None

Gets IsSceneRoot, which indicates if the SceneNode is a Scene Root Node.

Returns:

is_scene_root (bool):

Return type:

bool or None

get_custom_local_transform() → Transform or None

Get the default scene node local transform. The default transform is the local transform of the node (no bind pose, no time evaluation).

Returns:

attribute_value (Transform):

Return type:

Transform or None

get_custom_pivot_node_transform() → Transform or None

Get the node pivot geometric offset.

Returns:

attribute_value (Transform):

Return type:

Transform or None

get_custom_time_zero_global_transform(base_node_container, global_offset_transform, force_recache=False) → Transform or None

Get the global transform of the time-zero scene node. This value is computed from the local transforms of all parent time-zero scene nodes.

Parameters:

• base_node_container (InterchangeBaseNodeContainer)

• global_offset_transform (Transform)

• force_recache (bool)

Returns:

attribute_value (Transform):

Return type:

Transform or None

get_custom_time_zero_local_transform() → Transform or None

Get the local transform of the time-zero scene node.

Returns:

attribute_value (Transform):

Return type:

Transform or None

get_global_bind_pose_reference_for_mesh_uid(mesh_uid) → Matrix or None

Get the Global Bind Pose Reference for given MeshUID.

Parameters:

mesh_uid (str)

Returns:

global_bind_pose_reference (Matrix):

Return type:

Matrix or None

get_morph_target_curve_weights() → Map[str, float]

Get MorphTargets and their weights.

Returns:

out_morph_target_curve_weights (Map[str, float]):

Return type:

Map[str, float]

get_slot_material_dependencies() → Map[str, str]

Retrieve the correspondence table between slot names and assigned materials for this object.

Returns:

out_material_dependencies (Map[str, str]):

Return type:

Map[str, str]

get_slot_material_dependency_uid(slot_name) → str or None

Retrieve the Material dependency for a given slot of this object.

Parameters:

slot_name (str)

Returns:

out_material_dependency (str):

Return type:

str or None

get_specialized_type(index) → str

Get Specialized Type

Parameters:

index (int32)

Returns:

out_specialized_type (str):

Return type:

str

get_specialized_type_count() → int32

Get the specialized type this scene node represents (for example, Joint or LODGroup).

Return type:

int32

get_specialized_types() → Array[str]

Get Specialized Types

Returns:

out_specialized_types (Array[str]):

Return type:

Array[str]

is_specialized_type_contains(specialized_type) → bool

Is Specialized Type Contains

Parameters:

specialized_type (str)

Return type:

bool

remove_slot_material_dependency_uid(slot_name) → bool

Remove the Material dependency associated with the given slot name from this object.

Parameters:

slot_name (str)

Return type:

bool

remove_specialized_type(specialized_type) → bool

Remove Specialized Type

Parameters:

specialized_type (str)

Return type:

bool

set_animation_curve_type_for_curve_name(curve_name, animation_curve_type) → bool

Sets the Animation Curve Type for the given CurveName (StepCurve or Curve). (Mostly used for tracking Custom Attributes’ Animation Types)

Parameters:

• curve_name (str)

• animation_curve_type (InterchangeAnimationPayLoadType)

Return type:

bool

set_custom_actor_visibility(is_visible) → bool

Sets whether actors spawned from this node should be visible

Parameters:

is_visible (bool)

Return type:

bool

set_custom_animation_asset_uid_to_play(attribute_value) → bool

Set the Animation Asset To Play by this Scene Node. Only relevant for SkeletalMeshActors (that is, SceneNodes that are instantiating Skeletal Meshes).

Parameters:

attribute_value (str)

Return type:

bool

set_custom_asset_instance_uid(attribute_value) → bool

Add an asset for this scene node to instantiate.

Parameters:

attribute_value (str)

Return type:

bool

set_custom_bind_pose_local_transform(base_node_container, attribute_value, reset_cache=True) → bool

Set the local transform of the bind pose scene node.

Parameters:

• base_node_container (InterchangeBaseNodeContainer)

• attribute_value (Transform)

• reset_cache (bool)

Return type:

bool

set_custom_component_visibility(is_visible) → bool

Sets whether components spawned from this node should be visible

Parameters:

is_visible (bool)

Return type:

bool

set_custom_geometric_transform(attribute_value) → bool

Set the geometric offset. Any mesh attached to this scene node will be offset using this transform.

Parameters:

attribute_value (Transform)

Return type:

bool

set_custom_global_matrix_for_t0_rebinding(attribute_value) → bool

Sets the Global Transformation Matrix used for T0 rebinding.

Parameters:

attribute_value (Matrix)

Return type:

bool

set_custom_has_bind_pose(has_bind_pose) → bool

Sets if Joint has Bind Pose. Automatic T0 usage will be configured in case if the Skeleton contanis at least 1 Joint without BindPose.

Parameters:

has_bind_pose (bool)

Return type:

bool

set_custom_is_scene_root(is_scene_root) → bool

Sets IsSceneRootNode, which indicates if the SceneNode is a Scene Root Node.

Parameters:

is_scene_root (bool)

Return type:

bool

set_custom_local_transform(base_node_container, attribute_value, reset_cache=True) → bool

Set the default scene node local transform. The default transform is the local transform of the node (no bind pose, no time evaluation).

Parameters:

• base_node_container (InterchangeBaseNodeContainer)

• attribute_value (Transform)

• reset_cache (bool)

Return type:

bool

set_custom_pivot_node_transform(attribute_value) → bool

Set the node pivot geometric offset.

Parameters:

attribute_value (Transform)

Return type:

bool

set_custom_time_zero_local_transform(base_node_container, attribute_value, reset_cache=True) → bool

Set the local transform of the time-zero scene node.

Parameters:

• base_node_container (InterchangeBaseNodeContainer)

• attribute_value (Transform)

• reset_cache (bool)

Return type:

bool

set_global_bind_pose_reference_for_mesh_ui_ds(global_bind_pose_reference_for_mesh_ui_ds) → None

Set the Global Bind Pose Referenced for MeshUIDs.

Parameters:

global_bind_pose_reference_for_mesh_ui_ds (Map[str, Matrix])

set_morph_target_curve_weight(morph_target_name, weight) → bool

Set MorphTarget with given weight.

Parameters:

• morph_target_name (str)

• weight (float)

Return type:

bool

set_slot_material_dependency_uid(slot_name, material_dependency_uid) → bool

Add the specified Material dependency to a specific slot name of this object.

Parameters:

• slot_name (str)

• material_dependency_uid (str)

Return type:

bool