unreal.InterchangeVolumeGridNode

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

Bases: InterchangeBaseNode

Represents a single grid (essentially a 3d texture) within a volumetric file

C++ Source:

  • Plugin: Interchange

  • Module: InterchangeNodes

  • File: InterchangeVolumeNode.h

get_custom_element_type() VolumeGridElementType or None

Gets the datatype of the value of each voxel in the grid

Returns:

attribute_value (VolumeGridElementType):

Return type:

VolumeGridElementType or None

get_custom_grid_active_aabb_max() IntVector or None

Gets the max X, Y and Z of the grid’s active axis-aligned bounding box.

Returns:

attribute_value (IntVector):

Return type:

IntVector or None

get_custom_grid_active_aabb_min() IntVector or None

Gets the min X, Y and Z of the grid’s active axis-aligned bounding box.

Returns:

attribute_value (IntVector):

Return type:

IntVector or None

get_custom_grid_active_dimensions() IntVector or None

Gets the size of the grid, in voxels.

Returns:

attribute_value (IntVector):

Return type:

IntVector or None

get_custom_grid_transform() Transform or None

Gets the grid transform contained in the volume file

Returns:

attribute_value (Transform):

Return type:

Transform or None

get_custom_num_components() int32 or None

Gets the number of components of each voxel of the grid (e.g. 3 components for a vector grid)

Returns:

num_components (int32):

Return type:

int32 or None

set_custom_element_type(attribute_value) bool

Sets the datatype of the value of each voxel in the grid

Parameters:

attribute_value (VolumeGridElementType)

Return type:

bool

set_custom_grid_active_aabb_max(attribute_value) bool

Sets the max X, Y and Z of the grid’s active axis-aligned bounding box.

Parameters:

attribute_value (IntVector)

Return type:

bool

set_custom_grid_active_aabb_min(attribute_value) bool

Sets the min X, Y and Z of the grid’s active axis-aligned bounding box.

Parameters:

attribute_value (IntVector)

Return type:

bool

set_custom_grid_active_dimensions(attribute_value) bool

Sets the size of the grid, in voxels.

Parameters:

attribute_value (IntVector)

Return type:

bool

set_custom_grid_transform(attribute_value) bool

Sets the grid transform contained in the volume file

Parameters:

attribute_value (Transform)

Return type:

bool

set_custom_num_components(num_components) bool

Sets the number of components of each voxel of the grid (e.g. 3 components for a vector grid)

Parameters:

num_components (int32)

Return type:

bool