VectorFieldVisualization.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*==============================================================================
    VectorFieldVisualization.h: Visualization of vector fields.
==============================================================================*/
 
#pragma once
 
#include "CoreMinimal.h"
#include "UniformBuffer.h"
#include "VertexFactory.h"
 
class FMaterial;
class FMeshElementCollector;
class FPrimitiveDrawInterface;
class FSceneView;
class FVectorFieldInstance;
 
/*------------------------------------------------------------------------------
    Forward declarations.
------------------------------------------------------------------------------*/
 
class FVectorFieldInstance;
class FVectorFieldVisualizationVertexFactoryShaderParameters;
class FPrimitiveDrawInterface;
class FSceneView;
 
/*------------------------------------------------------------------------------
    Vertex factory for visualizing vector fields.
------------------------------------------------------------------------------*/
 
BEGIN_GLOBAL_SHADER_PARAMETER_STRUCT( FVectorFieldVisualizationParameters, )
    SHADER_PARAMETER( FVector3f, VolumeToWorldHigh )
    SHADER_PARAMETER( FMatrix44f, RelativeVolumeToWorld )
    SHADER_PARAMETER( FMatrix44f, VolumeToWorldNoScale )
    SHADER_PARAMETER( FVector3f, VoxelSize )
    SHADER_PARAMETER( float, Scale )
END_GLOBAL_SHADER_PARAMETER_STRUCT()
typedef TUniformBufferRef<FVectorFieldVisualizationParameters> FVectorFieldVisualizationBufferRef;
 
class FVectorFieldVisualizationVertexFactory : public FVertexFactory
{
    DECLARE_VERTEX_FACTORY_TYPE(FVectorFieldVisualizationVertexFactory);
 
public:
    FVectorFieldVisualizationVertexFactory(ERHIFeatureLevel::Type InFeatureLevel)
        : FVertexFactory(InFeatureLevel)
    {
    }
 
    virtual void InitRHI(FRHICommandListBase& RHICmdList) override;
 
    static bool ShouldCompilePermutation(const FVertexFactoryShaderPermutationParameters& Parameters);
 
    static void ModifyCompilationEnvironment(const FVertexFactoryShaderPermutationParameters& Parameters, FShaderCompilerEnvironment& OutEnvironment);
};
 
/*------------------------------------------------------------------------------
    Drawing interface.
------------------------------------------------------------------------------*/
 
void DrawVectorFieldBounds(
    FPrimitiveDrawInterface* PDI,
    const FSceneView* View,
    FVectorFieldInstance* VectorFieldInstance );
 
void GetVectorFieldMesh(
    FVectorFieldVisualizationVertexFactory* VertexFactory,
    FVectorFieldInstance* VectorFieldInstance,
    int32 ViewIndex,
    FMeshElementCollector& Collector);