unreal.InterchangeTexture2DFactoryNode

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

Bases: InterchangeTextureFactoryNode

ns UE::Interchange

C++ Source:

  • Plugin: Interchange

  • Module: InterchangeFactoryNodes

  • File: InterchangeTexture2DFactoryNode.h

get_custom_address_x() → TextureAddress or None

Return false if the Attribute was not set previously.

Returns:

attribute_value (TextureAddress):

Return type:

TextureAddress or None

get_custom_address_y() → TextureAddress or None

Return false if the Attribute was not set previously.

Returns:

attribute_value (TextureAddress):

Return type:

TextureAddress or None

get_source_block(block_index) → str or None

Get a source block from the texture.

Parameters:

block_index (int32) – The UDIM Index of the block.

Returns:

True if the source file for the block was found.

out_source_file (str): The source file for that block if found.

Return type:

str or None

get_source_block_by_coordinates(x, y) → str or None

Get a source block from the texture.

Parameters:

  • x (int32) – The X coordinate of the block.

  • y (int32) – The Y coordinate of the block.

Returns:

True if the source file for the block was found.

out_source_file (str): The source file for that block if found.

Return type:

str or None

get_source_blocks() → Map[int32, str]

Get the source blocks for the texture. If the map is empty, the texture is imported as a normal texture using the payload key.

Return type:

Map[int32, str]

set_custom_address_x(attribute_value, add_apply_delegate=True) → bool

Set Custom Address X

Parameters:
Return type:

bool

set_custom_address_y(attribute_value, add_apply_delegate=True) → bool

Set Custom Address Y

Parameters:
Return type:

bool

set_source_block(block_index, source_file) → None

Set a source block for the texture.

Parameters:

  • block_index (int32) – The UDIM index of the block.

  • source_file (str) – The source file for that block. The textures must be of the same format and use the same pixel format. The first block in the map is used to determine the accepted texture format and pixel format.

set_source_block_by_coordinates(x, y, source_file) → None

Set a source block for the texture.

Parameters:

  • x (int32) – The X coordinate of the block.

  • y (int32) – The Y coordinate of the block.

  • source_file (str) – The source file for that block. The textures must be of the same format and use the same pixel format. The first block in the map is used to determine the accepted texture format and pixel format.

set_source_blocks(source_blocks) → None

Set the source blocks for the texture. Using this suggests to the pipeline to consider this texture as a UDIM. The pipeline can choose whether to pass these blocks to the texture factory node.

Parameters:

source_blocks (Map[int32, str]) – The blocks and their source image that compose the whole texture. The textures must be of the same format and use the same pixel format. The first block in the map is used to determine the accepted texture format and pixel format.