unreal.HoudiniCSV

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

Bases: unreal.Object

Houdini CSV

C++ Source:

  • Plugin: HoudiniNiagara
  • Module: HoudiniNiagara
  • File: HoudiniCSV.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_import_data (AssetImportData): [Read-Write] Importing data and options used for this asset
  • column_title_array (Array(str)): [Read-Only] The final column titles used by the asset after parsing. Describes the content of each column. Packed vector values are expended, so additional column might have been inserted. Use the indexes in this array to access your data.
  • file_name (str): [Read-Only] MEMBER VARIABLES
  • number_of_columns (int32): [Read-Only] The number of value TYPES stored in the CSV file
  • number_of_points (int32): [Read-Only] The number of points found in the CSV file
  • number_of_rows (int32): [Read-Only] The number of values stored in the CSV file (excluding the title row)
  • source_title_row (str): [Read-Write] The source title row, describing the content of each column and used to locate specific values in the CSV file. Editing this will trigger a re-import of the CSV file.
get_color_value(row_index) → LinearColor or None

Returns a Color for a given point in the CSV file

Parameters:row_index (int32) –
Returns:value (LinearColor):
Return type:LinearColor or None
get_column_index_from_string(column_title) → int32 or None

Returns the column index for a given string

Parameters:column_title (str) –
Returns:column_index (int32):
Return type:int32 or None
get_float_value(row_index, col_index) → float or None

Returns the float value at a given point in the CSV file

Parameters:
  • row_index (int32) –
  • col_index (int32) –
Returns:

value (float):

Return type:

float or None

get_float_value_for_string(row_index, column_title) → float or None

Returns the float value at a given point in the CSV file

Parameters:
  • row_index (int32) –
  • column_title (str) –
Returns:

value (float):

Return type:

float or None

get_impulse_value(row_index) → float or None

Returns an Impulse float value for a given point in the CSV file

Parameters:row_index (int32) –
Returns:value (float):
Return type:float or None
get_last_point_id_to_spawn_at_time(time) → int32 or None

Get the last pointID of the points to be spawned at time t Invalid Index are used to indicate edge cases: -1 will be returned if there is no points to spawn ( t is smaller than the first point time ) NumberOfRows will be returned if all points in the CSV have been spawned ( t is higher than the last point time )

Parameters:time (float) –
Returns:last_index (int32):
Return type:int32 or None
get_last_row_index_at_time(desired_time) → int32 or None

Get the last row index for a given time value (the row with a time smaller or equal to desiredTime) If the CSV file doesn’t have time informations, returns false and set LastRowIndex to the last row in the file If desiredTime is smaller than the time value in the first row, LastRowIndex will be set to -1 If desiredTime is higher than the last time value in the last row of the csv file, LastIndex will be set to the last row’s index

Parameters:desired_time (float) –
Returns:last_row_index (int32):
Return type:int32 or None
get_normal_value(row_index) → Vector or None

Returns a Normal Vector3 for a given point in the CSV file (converted to unreal’s coordinate system)

Parameters:row_index (int32) –
Returns:value (Vector):
Return type:Vector or None
get_number_of_columns() → int32

Returns the number of columns found in the CSV file

Returns:
Return type:int32
get_number_of_points() → int32

Returns the number of points found in the CSV file

Returns:
Return type:int32
get_number_of_rows() → int32

Returns the number of rows found in the CSV file

Returns:
Return type:int32
get_point_i_ds_to_spawn_at_time(desired_time) → (min_id=int32, max_id=int32, count=int32, last_spawned_point_id=int32, last_spawn_time=float) or None

Get Point IDs to Spawn at Time

Parameters:desired_time (float) –
Returns:min_id (int32):

max_id (int32):

count (int32):

last_spawned_point_id (int32):

last_spawn_time (float):

Return type:tuple or None
get_point_life(point_id) → float or None

Return a given point’s life value at spawn

Parameters:point_id (int32) –
Returns:value (float):
Return type:float or None
get_point_life_at_time(point_id, desired_time) → float or None

Return a point’s life for a given time value

Parameters:
  • point_id (int32) –
  • desired_time (float) –
Returns:

value (float):

Return type:

float or None

get_point_position_at_time(point_id, desired_time) → Vector or None

Returns the Position Value for a given point at a given time value (linearly interpolated)

Parameters:
  • point_id (int32) –
  • desired_time (float) –
Returns:

vector (Vector):

Return type:

Vector or None

get_point_type(point_id) → int32 or None

Return a point’s type at spawn

Parameters:point_id (int32) –
Returns:value (int32):
Return type:int32 or None
get_point_value_at_time(point_id, column_index, desired_time) → float or None

Returns the value for a point at a given time value (linearly interpolated)

Parameters:
  • point_id (int32) –
  • column_index (int32) –
  • desired_time (float) –
Returns:

value (float):

Return type:

float or None

get_point_vector_value_at_time(point_id, column_index, desired_time, do_swap, do_scale) → Vector or None

Returns the Vector Value for a given point at a given time value (linearly interpolated)

Parameters:
  • point_id (int32) –
  • column_index (int32) –
  • desired_time (float) –
  • do_swap (bool) –
  • do_scale (bool) –
Returns:

vector (Vector):

Return type:

Vector or None

get_position_value(row_index) → Vector or None

Returns a Position Vector3 for a given point in the CSV file (converted to unreal’s coordinate system)

Parameters:row_index (int32) –
Returns:value (Vector):
Return type:Vector or None
get_row_indexes_for_point_at_time(point_id, desired_time) → (prev_index=int32, next_index=int32, prev_weight=float) or None

Returns the previous and next indexes for reading the values of a specified point at a given time

Parameters:
  • point_id (int32) –
  • desired_time (float) –
Returns:

prev_index (int32):

next_index (int32):

prev_weight (float):

Return type:

tuple or None

get_time_value(row_index) → float or None

Returns a time value for a given point in the CSV file

Parameters:row_index (int32) –
Returns:value (float):
Return type:float or None
get_vector_value(row_index, col_index, do_swap=True, do_scale=True) → Vector or None

// Returns the string value at a given point in the CSV file bool GetCSVStringValue( const int32& rowIndex, const int32& colIndex, FString& value ); // Returns the string value at a given point in the CSV file bool GetCSVStringValue( const int32& rowIndex, const FString& ColumnTitle, FString& value ); // Returns a Vector3 for a given point in the CSV file

Parameters:
  • row_index (int32) –
  • col_index (int32) –
  • do_swap (bool) –
  • do_scale (bool) –
Returns:

value (Vector):

Return type:

Vector or None

get_velocity_value(row_index) → Vector or None

Returns a Velocity Vector3 for a given point in the CSV file

Parameters:row_index (int32) –
Returns:value (Vector):
Return type:Vector or None