unreal.NiagaraDataInterfaceGrid3DCollection

class unreal.NiagaraDataInterfaceGrid3DCollection(outer=None, name='None')

Bases: unreal.NiagaraDataInterfaceGrid3D

Niagara Data Interface Grid 3DCollection

C++ Source:

  • Plugin: Niagara

  • Module: Niagara

  • File: NiagaraDataInterfaceGrid3DCollection.h

Editor Properties: (see get_editor_property/set_editor_property)

  • cell_size (float): [Read-Write] Cell Size: World space size of a cell

  • num_attributes (int32): [Read-Write] Num Attributes: Number of attributes stored on the grid

  • num_cells (IntVector): [Read-Write] Num Cells: Number of cells

  • num_cells_max_axis (int32): [Read-Write] Num Cells Max Axis: Number of cells on the longest axis

  • override_buffer_format (NiagaraGpuBufferFormat): [Read-Write] Override Buffer Format: When enabled overrides the format used to store data inside the grid, otherwise uses the project default setting. Lower bit depth formats will save memory and performance at the cost of precision.

  • override_format (bool): [Read-Write] Override Format

  • preview_attribute (Name): [Read-Write] Preview Attribute: When enabled allows you to preview the grid in a debug display

  • preview_grid (bool): [Read-Write] Preview Grid

  • render_target_user_parameter (NiagaraUserParameterBinding): [Read-Write] Render Target User Parameter: Reference to a user parameter if we’re reading one.

  • set_resolution_method (SetResolutionMethod): [Read-Write] Set Resolution Method: Method for setting the grid resolution

  • world_b_box_size (Vector): [Read-Write] World BBox Size: World size of the grid

fill_raw_volume_texture(component, dest) (tiles_x=int32, tiles_y=int32, tile_z=int32) or None

Fill Raw Volume Texture deprecated: This function has been replaced by object user variables on the emitter to specify render targets to fill with data.

Parameters
Returns

tiles_x (int32):

tiles_y (int32):

tile_z (int32):

Return type

tuple or None

fill_volume_texture(component, dest, attribute_index) bool

Fills a texture render target 2d with the current data from the simulation #todo(dmp): this will eventually go away when we formalize how data makes it out of Niagara #todo(dmp): reimplement for 3d deprecated: This function has been replaced by object user variables on the emitter to specify render targets to fill with data.

Parameters
Return type

bool

get_raw_texture_size(component) -> (size_x=int32, size_y=int32, size_z=int32)

Get Raw Texture Size

Parameters

component (NiagaraComponent) –

Returns

size_x (int32):

size_y (int32):

size_z (int32):

Return type

tuple

get_texture_size(component) -> (size_x=int32, size_y=int32, size_z=int32)

Get Texture Size

Parameters

component (NiagaraComponent) –

Returns

size_x (int32):

size_y (int32):

size_z (int32):

Return type

tuple