unreal.InterchangeStaticMeshFactoryNode

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

Bases: InterchangeMeshFactoryNode

namespace UE

C++ Source:

  • Plugin: Interchange

  • Module: InterchangeFactoryNodes

  • File: InterchangeStaticMeshFactoryNode.h

add_socket_uid(socket_uid) → bool

Add Socket Uid

Parameters:

socket_uid (str)

Return type:

bool

add_socket_uids(socket_uids) → bool

Add Socket Uids

Parameters:

socket_uids (Array[str])

Return type:

bool

get_custom_auto_compute_lod_screen_sizes() → bool or None

Get whether the static mesh factory should auto compute LOD Screen Sizes. Return false if the attribute was not set.

Returns:

attribute_value (bool):

Return type:

bool or None

get_custom_build_nanite() → bool or None

Get whether the static mesh factory should set the Nanite build setting. Return false if the attribute was not set.

Returns:

attribute_value (bool):

Return type:

bool or None

get_custom_build_reversed_index_buffer() → bool or None

Get whether the static mesh should build a reversed index buffer.

Returns:

attribute_value (bool):

Return type:

bool or None

get_custom_build_scale3d() → Vector or None

Get the local scale that is applied when building the static mesh.

Returns:

attribute_value (Vector):

Return type:

Vector or None

get_custom_distance_field_replacement_mesh() → SoftObjectPath or None

Get the static mesh asset whose distance field will be used as the distance field for the imported mesh.

Returns:

attribute_value (SoftObjectPath):

Return type:

SoftObjectPath or None

get_custom_distance_field_resolution_scale() → float or None

Get the scale to apply to the mesh when allocating the distance field volume texture. The default scale is 1, which assumes that the mesh will be placed unscaled in the world.

Returns:

attribute_value (float):

Return type:

float or None

get_custom_dst_lightmap_index() → int32 or None

Get the index of the UV that is used to store generated lightmaps for the static mesh.

Returns:

attribute_value (int32):

Return type:

int32 or None

get_custom_generate_distance_field_as_if_two_sided() → bool or None

Get whether to generate the distance field by treating every triangle hit as a front face. This prevents the distance field from being discarded due to the mesh being open, but also lowers distance field ambient occlusion quality.

Returns:

attribute_value (bool):

Return type:

bool or None

get_custom_generate_lightmap_u_vs() → bool or None

Get whether the static mesh should generate lightmap UVs.

Returns:

attribute_value (bool):

Return type:

bool or None

get_custom_max_lumen_mesh_cards() → int32 or None

Get the maximum number of Lumen mesh cards to generate for this mesh. More cards means that the surface will have better coverage, but will result in increased runtime overhead. Set this to 0 to disable mesh card generation for this mesh. The default is 12.

Returns:

attribute_value (int32):

Return type:

int32 or None

get_custom_min_lightmap_resolution() → int32 or None

Get the amount of padding used to pack UVs for the static mesh.

Returns:

attribute_value (int32):

Return type:

int32 or None

get_custom_src_lightmap_index() → int32 or None

Get the index of the UV that is used as the source for generating lightmaps for the static mesh.

Returns:

attribute_value (int32):

Return type:

int32 or None

get_custom_substitute_uid() → str or None

Gets the Substitute UID, said UID can be used to acquire an identical FactoryNode. (for more see SetCustomSubstituteUID)

Returns:

attribute_value (str):

Return type:

str or None

get_custom_support_face_remap() → bool or None

Get whether the static mesh is set up for use with physical material masks.

Returns:

attribute_value (bool):

Return type:

bool or None

get_lod_screen_size_count() → int32

Returns the number of LOD Screen Sizes the static mesh has.

Return type:

int32

get_lod_screen_sizes() → Array[float]

Returns All the LOD Screen Sizes set for the static mesh.

Returns:

out_lod_screen_sizes (Array[float]):

Return type:

Array[float]

get_socket_uid_count() → int32

Return the number of socket UIDs this static mesh has.

Return type:

int32

get_socket_uids() → Array[str]

Get Socket Uids

Returns:

out_socket_uids (Array[str]):

Return type:

Array[str]

initialize_static_mesh_node(unique_id, display_label, asset_class, node_container) → None

Initialize node data. Also adds it to NodeContainer.

Parameters:

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

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

  • asset_class (str) – The class the StaticMesh factory will create for this node.

  • node_container (InterchangeBaseNodeContainer)

remove_socket_ud(socket_uid) → bool

Remove Socket Ud

Parameters:

socket_uid (str)

Return type:

bool

set_custom_auto_compute_lod_screen_sizes(attribute_value) → bool

Set whether the static mesh factory should auto compute LOD Screen Sizes. Return false if the attribute was not set.

Parameters:

attribute_value (bool)

Return type:

bool

set_custom_build_nanite(attribute_value, add_apply_delegate=True) → bool

Set whether the static mesh factory should set the Nanite build setting. Return false if the attribute was not set.

Parameters:

  • attribute_value (bool)

  • add_apply_delegate (bool)

Return type:

bool

set_custom_build_reversed_index_buffer(attribute_value, add_apply_delegate=True) → bool

Set whether the static mesh should build a reversed index buffer.

Parameters:

  • attribute_value (bool)

  • add_apply_delegate (bool)

Return type:

bool

set_custom_build_scale3d(attribute_value, add_apply_delegate=True) → bool

Set the local scale that is applied when building the static mesh.

Parameters:

  • attribute_value (Vector)

  • add_apply_delegate (bool)

Return type:

bool

set_custom_distance_field_replacement_mesh(attribute_value, add_apply_delegate=True) → bool

Set the static mesh asset whose distance field will be used as the distance field for the imported mesh.

Parameters:
Return type:

bool

set_custom_distance_field_resolution_scale(attribute_value, add_apply_delegate=True) → bool

Set the scale to apply to the mesh when allocating the distance field volume texture. The default scale is 1, which assumes that the mesh will be placed unscaled in the world.

Parameters:

  • attribute_value (float)

  • add_apply_delegate (bool)

Return type:

bool

set_custom_dst_lightmap_index(attribute_value, add_apply_delegate=True) → bool

Set the index of the UV that is used to store generated lightmaps for the static mesh.

Parameters:

  • attribute_value (int32)

  • add_apply_delegate (bool)

Return type:

bool

set_custom_generate_distance_field_as_if_two_sided(attribute_value, add_apply_delegate=True) → bool

Set whether to generate the distance field by treating every triangle hit as a front face. This prevents the distance field from being discarded due to the mesh being open, but also lowers distance field ambient occlusion quality.

Parameters:

  • attribute_value (bool)

  • add_apply_delegate (bool)

Return type:

bool

set_custom_generate_lightmap_u_vs(attribute_value, add_apply_delegate=True) → bool

Set whether the static mesh should generate lightmap UVs.

Parameters:

  • attribute_value (bool)

  • add_apply_delegate (bool)

Return type:

bool

set_custom_max_lumen_mesh_cards(attribute_value, add_apply_delegate=True) → bool

Set the maximum number of Lumen mesh cards to generate for this mesh. More cards means that the surface will have better coverage, but will result in increased runtime overhead. Set this to 0 to disable mesh card generation for this mesh. The default is 12.

Parameters:

  • attribute_value (int32)

  • add_apply_delegate (bool)

Return type:

bool

set_custom_min_lightmap_resolution(attribute_value, add_apply_delegate=True) → bool

Set the amount of padding used to pack UVs for the static mesh.

Parameters:

  • attribute_value (int32)

  • add_apply_delegate (bool)

Return type:

bool

set_custom_src_lightmap_index(attribute_value, add_apply_delegate=True) → bool

Set the index of the UV that is used as the source for generating lightmaps for the static mesh.

Parameters:

  • attribute_value (int32)

  • add_apply_delegate (bool)

Return type:

bool

set_custom_substitute_uid(attribute_value) → bool

Currently specifically used for LOD group nodes. If an LOD Group is identified as identical to another one (when bakeMesh is turned off),

then said LOD Group’s asset won’t be created and the substitute UID will be set to the FactoryNode that’s identical to the one at hand.

Parameters:

attribute_value (str)

Return type:

bool

set_custom_support_face_remap(attribute_value, add_apply_delegate=True) → bool

Set whether the static mesh is set up for use with physical material masks.

Parameters:

  • attribute_value (bool)

  • add_apply_delegate (bool)

Return type:

bool

set_lod_screen_sizes(lod_screen_sizes) → bool

Sets the LOD Screen Sizes for the static mesh.

Parameters:

lod_screen_sizes (Array[float])

Return type:

bool