UHoudiniCSV

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

HoudiniNiagara

Header

/Engine/Plugins/FX/HoudiniNiagara/Source/HoudiniNiagara/Public/HoudiniCSV.h

Include

#include "HoudiniCSV.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType)
class UHoudiniCSV : public UObject

Variables

Name Description

Public variable UProperty Category, EditAnywhere instanced

UAssetImportDat...

 

AssetImportData

Importing data and options used for this asset

Public variable UProperty Category visibleanywhere

TArray< FString...

 

ColumnTitleArray

The final column titles used by the asset after parsing.

Public variable UProperty Category visibleanywhere

FString

 

FileName

MEMBER VARIABLES.

Public variable UProperty Category visibleanywhere

int32

 

NumberOfColumns

The number of value TYPES stored in the CSV file.

Public variable UProperty Category visibleanywhere

int32

 

NumberOfPoints

The number of points found in the CSV file.

Public variable UProperty Category visibleanywhere

int32

 

NumberOfRows

The number of values stored in the CSV file (excluding the title row)

Public variable UProperty Category, EditAnywhere

FString

 

SourceTitleRow

The source title row, describing the content of each column and used to locate specific values in the CSV file.

Constructors

Name Description

Public function

UHoudiniCSV

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

int32

 

GetAttributeColumnIndex

(
    const EHoudiniAttributes& Attr
)

Return the column index for a specific attribute.

Public function Const UFunction BlueprintCallable, Category

bool

 

GetColorValue

(
    const int32& rowIndex,
    FLinearColor& value
)

Returns a Color for a given point in the CSV file.

Public function Const UFunction BlueprintCallable, Category

bool

 

GetColumnIndexFromString

(
    const FString& ColumnTitle,
    int32& ColumnIndex
)

Returns the column index for a given string.

Public function Const UFunction BlueprintCallable, Category

bool

 

GetFloatValue

(
    const int32& rowIndex,
    const int32& colIndex,
    float& value
)

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

Public function Const UFunction BlueprintCallable, Category

bool

 

GetFloatValueForString

(
    const int32& rowIndex,
    const FString& ColumnTitle,
    float& value
)

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

Public function Const UFunction BlueprintCallable, Category

bool

 

GetImpulseValue

(
    const int32& rowIndex,
    float& value
)

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

Public function Const UFunction BlueprintCallable, Category

bool

 

GetLastPointIDToSpawnAtTime

(
    const float& time,
    int32& lastIndex
)

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 )

Public function Const UFunction BlueprintCallable, Category

bool

 

GetLastRowIndexAtTime

(
    const float& desiredTime,
    int32& lastRowIndex
)

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

Public function Const

int32

 

GetMaxNumberOfPointValueIndexes()

Returns the maximum number of indexes per point, used for flattening the buffer for HLSL conversion.

Public function Const UFunction BlueprintCallable, Category

bool

 

GetNormalValue

(
    const int32& rowIndex,
    FVector& value
)

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

Public function Const UFunction BlueprintCallable, Category

int32

 

GetNumberOfColumns()

Returns the number of columns found in the CSV file.

Public function Const UFunction BlueprintCallable, Category

int32

 

GetNumberOfPoints()

Returns the number of points found in the CSV file.

Public function Const UFunction BlueprintCallable, Category

int32

 

GetNumberOfRows()

Returns the number of rows found in the CSV file.

Public function Const UFunction BlueprintCallable, Category

bool

 

GetPointIDsToSpawnAtTime

(
    const float& desiredTime,
    int32& MinID,
    int32& MaxID,
    int32& Count,
    int32& LastSpawnedPointID,
    float& LastSpawnTime
)

Public function Const UFunction BlueprintCallable, Category

bool

 

GetPointLife

(
    const int32& PointID,
    float& Value
)

Return a given point's life value at spawn.

Public function Const UFunction BlueprintCallable, Category

bool

 

GetPointLifeAtTime

(
    const int32& PointID,
    const float& DesiredTime,
    float& Value
)

Return a point's life for a given time value.

Public function Const UFunction BlueprintCallable, Category

bool

 

GetPointPositionAtTime

(
    const int32& PointID,
    const float& desiredTime,
    FVector& Vector
)

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

Public function Const UFunction BlueprintCallable, Category

bool

 

GetPointType

(
    const int32& PointID,
    int32& Value
)

Return a point's type at spawn.

Public function Const UFunction BlueprintCallable, Category

bool

 

GetPointValueAtTime

(
    const int32& PointID,
    const int32& ColumnIndex,
    const float& desiredTime,
    float& Value
)

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

Public function Const UFunction BlueprintCallable, Category

bool

 

GetPointVectorValueAtTime

(
    const int32& PointID,
    const int32& ColumnIndex,
    const float& desiredTime,
    FVector& Vector,
    const bool& DoSwap,
    const bool& DoScale
)

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

Public function Const UFunction BlueprintCallable, Category

bool

 

GetPositionValue

(
    const int32& rowIndex,
    FVector& value
)

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

Public function Const UFunction BlueprintCallable, Category

bool

 

GetRowIndexesForPointAtTime

(
    const int32& PointID,
    const float& desiredTime,
    int32& PrevIndex,
    int32& NextIndex,
    float& PrevWeight
)

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

Public function Const UFunction BlueprintCallable, Category

bool

 

GetTimeValue

(
    const int32& rowIndex,
    float& value
)

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

Public function Const UFunction BlueprintCallable, Category

bool

 

GetVectorValue

(
    const int32& rowIndex,
    const int32& colIndex,
    FVector& value,
    const bool& DoSwap,
    const bool& DoScale
)

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

Public function Const UFunction BlueprintCallable, Category

bool

 

GetVelocityValue

(
    const int32& rowIndex,
    FVector& value
)

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

Public function Const

bool

 

IsValidAttributeColumnIndex

(
    const EHoudiniAttributes& Attr
)

Returns if the specific attribute has a valid column index.

Protected function

bool

 

ParseCSVTitleRow

(
    const FString& TitleRow,
    const FString& FirstValueRow,
    bool& HasPackedVectors
)

Parses the CSV title row to update the column indexes of special values we're interested in Also look for packed vectors in the first row and update the indexes accordingly

Public function

void

 

SetFileName

(
    const FString& TheFilename
)

Public function

bool

 

UpdateFromFile

(
    const FString& TheFileName
)

MEMBER FUNCTIONS.

Public function

bool

 

UpdateFromStringArray

(
    TArray< FString >& StringArray
)

Overridden from UObject

Name Description

Public function Virtual Const

void

 

GetAssetRegistryTags

(
    TArray< FAssetRegistryTag >& OutTa...
)

Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss