unreal.InterchangeVolumeNode

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

Bases: InterchangeBaseNode

Represents a file that contains volume data in the form of (potentially multiple) grids, which are represented as UInterchangeVolumeGridNode dependencies

C++ Source:

• Plugin: Interchange

• Module: InterchangeNodes

• File: InterchangeVolumeNode.h

add_custom_frame_index_in_animation(index) → bool

Adds a frame index for which this volume is displayed within the animation that it belongs to, if any

Parameters:

index (int32)

Return type:

bool

add_custom_grid_dependency(dependency_uid) → bool

Sets the Node ID of an UInterchangeVolumeGridNode dependency

Parameters:

dependency_uid (str)

Return type:

bool

get_custom_animation_id() → str or None

Gets an identifier that is shared by all volume nodes that correspond to the same animation (i.e. every volume node within the animation will have the same AnimationID)

Returns:

attribute_value (str):

Return type:

str or None

get_custom_file_name() → str or None

Gets the filename of the file with volume data (e.g. “C:/MyFolder/File.vdb”).

This is stored on the translated node as well as the source data, as a volume import may discover other additional files in order to handle animated volume imports.

Returns:

attribute_value (str):

Return type:

str or None

get_custom_frame_index_in_animation(index_index) → int32

Gets one of the frame indices for which this volume is displayed within the animation that it belongs to, if any

Parameters:

index_index (int32)

Returns:

out_index (int32):

Return type:

int32

get_custom_frame_indices_in_animation() → Array[int32]

Get the frame indices for which this volume is displayed within the animation that it belongs to, if any (e.g. if this had [2, 3] then frames 2 and 3 of the animation with AnimationID should display this volume)

Returns:

out_animation_indices (Array[int32]):

Return type:

Array[int32]

get_custom_grid_dependecies() → Array[str]

Gets the Node IDs of UInterchangeVolumeGridNodes declared as dependencies by this volume node

Returns:

out_dependencies (Array[str]):

Return type:

Array[str]

get_custom_grid_dependecies_count() → int32

Gets the number of UInterchangeVolumeGridNodes declared as dependencies by this volume node (in other words, returns the number of volume grids contained in this file)

Return type:

int32

get_custom_grid_dependency(index) → str

Gets the Node ID of an UInterchangeVolumeGridNode dependency

Parameters:

index (int32)

Returns:

out_dependency (str):

Return type:

str

remove_custom_frame_index_in_animation(index) → bool

Removes a frame index for which this volume is displayed within the animation that it belongs to, if any

Parameters:

index (int32)

Return type:

bool

remove_custom_grid_dependency(dependency_uid) → bool

Removes the Node ID of an UInterchangeVolumeGridNode dependency

Parameters:

dependency_uid (str)

Return type:

bool

set_custom_animation_id(attribute_value) → bool

Sets an identifier that is shared by all volume nodes that correspond to the same animation (i.e. every volume node within the animation will have the same AnimationID)

Parameters:

attribute_value (str)

Return type:

bool

set_custom_file_name(attribute_value) → bool

Sets the filename of the file with volume data (e.g. “C:/MyFolder/File.vdb”).

This is stored on the translated node as well as the source data, as a volume import may discover other additional files in order to handle animated volume imports.

Parameters:

attribute_value (str)

Return type:

bool