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
- 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_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_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_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_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_slot_material_dependencies() Map[str, str] ¶
Retrieve the correspondence table between slot names and assigned materials for this object.
- get_slot_material_dependency_uid(slot_name) str or None ¶
Retrieve the Material dependency for a given slot of this object.
- get_specialized_type(index) str ¶
Get Specialized Type
- Parameters:
index (int32) –
- Returns:
out_specialized_type (str):
- Return type:
- get_specialized_type_count() int32 ¶
Get the specialized type this scene node represents (for example, Joint or LODGroup).
- Return type:
int32
- remove_slot_material_dependency_uid(slot_name) bool ¶
Remove the Material dependency associated with the given slot name from this object.
- 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).
- set_custom_asset_instance_uid(attribute_value) bool ¶
Add an asset for this scene node to instantiate.
- 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:
- set_custom_geometric_transform(attribute_value) bool ¶
Set the geometric offset. Any mesh attached to this scene node will be offset using this transform.
- 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:
- 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: