NiagaraDataInterfaceSTWaveformDisplay.h

// Copyright (c) 2025 Aaron Trotter (ShaderTech). All Rights Reserved.
 
#pragma once
 
#include "NiagaraDataInterface.h"
#include "Main/ST_AudioVisSettings.h"
#include "NiagaraDataInterfaceSTWaveformDisplay.generated.h"
 
enum class ENiagaraSimTarget : uint8;
struct FNiagaraDataInterfaceGeneratedFunction;
struct FNiagaraFunctionSignature;
struct FVMExternalFunctionBindingInfo;

UCLASS(EditInlineNew, Category = "ShaderTech|AudioVisualisation", meta = (DisplayName = "Waveform Display Query"))
class ST_AUDIOVISUALISATION_API UNiagaraDataInterfaceSTWaveformDisplay : public UNiagaraDataInterface
{
    GENERATED_UCLASS_BODY()
 
    
    BEGIN_SHADER_PARAMETER_STRUCT(FShaderParameters, )
        SHADER_PARAMETER(FVector4f, ColourSolid)   
        SHADER_PARAMETER(FVector4f, ColourRange1)  
        SHADER_PARAMETER(FVector4f, ColourRange2)  
    END_SHADER_PARAMETER_STRUCT()
 
public:
    UPROPERTY(EditAnywhere, Category = "Audio", meta = (ToolTip = "Which measurement display properties we should use"))
    EAudioMeasurement Measurement = EAudioMeasurement::Frequency;
 
    // UObject Interface
    virtual void PostInitProperties() override;
    // UObject Interface End

    virtual bool CopyToInternal(UNiagaraDataInterface* Destination) const override;
 
    // UNiagaraDataInterface Interface
    virtual void GetFunctions(TArray<FNiagaraFunctionSignature>& OutFunctions) override;

    virtual void GetVMExternalFunction(const FVMExternalFunctionBindingInfo& BindingInfo, void* InstanceData, FVMExternalFunction& OutFunc) override;

    virtual bool CanExecuteOnTarget(ENiagaraSimTarget Target) const override { return true; }
 
#if WITH_EDITORONLY_DATA
    virtual bool AppendCompileHash(FNiagaraCompileHashVisitor* InVisitor) const override;

    virtual bool GetFunctionHLSL(const FNiagaraDataInterfaceGPUParamInfo& ParamInfo, const FNiagaraDataInterfaceGeneratedFunction& FunctionInfo, int FunctionInstanceIndex, FString& OutHLSL) override;

    virtual void GetParameterDefinitionHLSL(const FNiagaraDataInterfaceGPUParamInfo& ParamInfo, FString& OutHLSL) override;
#endif

    virtual void BuildShaderParameters(FNiagaraShaderParametersBuilder& ShaderParametersBuilder) const override;

    virtual void SetShaderParameters(const FNiagaraDataInterfaceSetShaderParametersContext& Context) const override;

    virtual bool InitPerInstanceData(void* PerInstanceData, FNiagaraSystemInstance* SystemInstance) override;

    virtual void DestroyPerInstanceData(void* PerInstanceData, FNiagaraSystemInstance* SystemInstance) override;

    virtual int32 PerInstanceDataSize() const override;

    virtual bool HasPreSimulateTick() const override { return true; }

    virtual bool PerInstanceTick(void* PerInstanceData, FNiagaraSystemInstance* SystemInstance, float DeltaSeconds) override;

    virtual void ProvidePerInstanceDataForRenderThread(void* DataForRenderThread, void* PerInstanceData, const FNiagaraSystemInstanceID& SystemInstance) override;
    // UNiagaraDataInterface Interface

    void GetSolidColourVM(FVectorVMExternalFunctionContext& Context);

    void GetRandomColourInRangeVM(FVectorVMExternalFunctionContext& Context);

    void GetRandomColourVM(FVectorVMExternalFunctionContext& Context);

    void GetRandomColourHSVVM(FVectorVMExternalFunctionContext& Context);

    void GetMappedColourInWheelVM(FVectorVMExternalFunctionContext& Context);

    void GetMappedColourInRangeVM(FVectorVMExternalFunctionContext& Context);
 
private:
    static const FName NAME_GetSolidColour;

    static const FName NAME_GetRandomColourInRange;

    static const FName NAME_GetRandomColour;

    static const FName NAME_GetRandomColourHSV;

    static const FName NAME_GetMappedColourInWheel;

    static const FName NAME_GetMappedColourInRange;
};