1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceVectorField

UNiagaraDataInterfaceVectorField

API > API/Plugins > API/Plugins/Niagara

Inheritance Hierarchy

References

   
Module Niagara
Header /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceVectorField.h
Include #include "NiagaraDataInterfaceVectorField.h"

Syntax

UCLASS (EditInlineNew, Category="Vector Field", CollapseCategories,  
       Meta=(DisplayName="Vector Field"), MinimalAPI)  
class UNiagaraDataInterfaceVectorField : public UNiagaraDataInterface

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere bool bTileX  
Public variable UProperty Category, EditAnywhere bool bTileY  
Public variable UProperty Category, EditAnywhere bool bTileZ  
Public variable UProperty Category, EditAnywhere TObjectPtr< UVectorField > Field Vector field to sample from.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function  

BEGIN_SHADER_PARAMETER_STRUCT ( FShaderParameters
)

  
Public function Const FVector  
Public function void

GetFieldBounds ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetFieldDimensions ( FVectorVMExternalFunctionContext& Context
)

 VM functions.
Public function void

GetFieldTilingAxes ( FVectorVMExternalFunctionContext& Context
)

  
Public function Const FVector  
Public function Const FVector  
Public function Const FVector  
Public function void

LoadVectorField ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

SampleVectorField ( FVectorVMExternalFunctionContext& Context
)

  
Public function TilingAxes

SHADER_PARAMETER ( FVector3f,
Dimensions
)

  
Public function TilingAxes MinBounds

SHADER_PARAMETER ( FVector3f,
MaxBounds
)

  
Public function TilingAxes MinBounds Texture  

Overridden from UNiagaraDataInterface

  Type Name Description
Public function Virtual Const bool GPU sim functionality.
Public function Virtual Const bool  
Protected function Virtual Const bool  
Public function Virtual Const bool

Equals ( const UNiagaraDataInterface* Other
)

 Determines if this DataInterface is the same as another.
Public function Virtual void Editor functionality.
Public function Virtual bool

GetFunctionHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo,
const FNiagaraDataInterfaceGeneratedFunction& FunctionInfo,
int FunctionInstanceIndex,
FString& OutHLSL
)

  
Protected function Virtual Const void  
Public function Virtual void  
Public function Virtual void

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

 VM functionality.
Protected function Virtual void  
Public function Virtual Const void Set the shader parameters will only be called if the data interface provided shader parameters.

Overridden from UNiagaraDataInterfaceBase

  Type Name Description
Public function Virtual Const void Override this method to provide parameters to the GPU (SRV / UAV / Constants / etc) The most common usage will be to provide a single structure which is nested with other parameters.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreEditChange ( FProperty* PropertyAboutToChange
)

 This is called when a property is about to be modified externally

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page