1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceLandscape

UNiagaraDataInterfaceLandscape

Data Interface allowing sampling of a Landscape

API > API/Plugins > API/Plugins/Niagara

Inheritance Hierarchy

References

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

Syntax

UCLASS (EditInlineNew, Category="Landscape", CollapseCategories,  
       Meta=(DisplayName="Landscape Sample"), MinimalAPI)  
class UNiagaraDataInterfaceLandscape :  
    public UNiagaraDataInterface ,  
    public INiagaraSimCacheCustomStorageInterface

Remarks

Data Interface allowing sampling of a Landscape

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere bool bVirtualTexturesSupported Can be used to ignore virtual textures even if they are defined for the landscape.
Public variable UProperty Category, EditAnywhere TArray< TObjectPtr< UPhysicalMaterial > > PhysicalMaterials  
Public variable UProperty Category, EditAnywhere TObjectPtr< AActor > SourceLandscape  
Public variable UProperty Category, EditAnywhere ENDILandscape_SourceMode SourceMode  

Constructors

  Type Name Description
Public function  

UNiagaraDataInterfaceLandscape ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function Const void

ApplyLandscape ( const FNiagaraSystemInstance& SystemInstance,
FNDILandscapeData_GameThread& InstanceData
)

  
Protected function Const ALandscape *

GetLandscape ( const FNiagaraSystemInstance& SystemInstance,
FNDILandscapeData_GameThread& Hint
)

  

Overridden from UNiagaraDataInterface

  Type Name Description
Public function Virtual Const bool Allows the generic class defaults version of this class to specify any dependencies/version/etc that might invalidate the compile.
Public function Virtual Const bool  
Protected function Virtual Const bool  
Public function Virtual void

DestroyPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Destroys the per instance data for this interface.
Public function Virtual Const bool

Equals ( const UNiagaraDataInterface* Other
)

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

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

  
Protected function Virtual Const void  
Public function Virtual void GPU sim functionality.
Public function Virtual Const bool  
Public function Virtual bool

InitPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Initializes the per instance data for this interface.
Public function Virtual Const int32 Returns the size of the per instance data for this interface.
Public function Virtual bool

PerInstanceTick ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance,
float DeltaSeconds
)

 Ticks the per instance data for this interface, if it has any.
Public function Virtual void

ProvidePerInstanceDataForRenderThread ( void* DataForRenderThread,
void* PerInstanceData,
const FNiagaraSystemInstanceID& SystemInstance
)

 Subclasses that wish to work with GPU systems/emitters must implement this.
Public function Virtual Const void Set the shader parameters will only be called if the data interface provided shader parameters.
Public function Virtual bool Allows data interfaces the opportunity to rename / change the function signature and perform an upgrade.

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 Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Overridden from INiagaraSimCacheCustomStorageInterface

  Type Name Description
Public function Virtual Const UObject *

SimCacheBeginWrite ( UObject* SimCache,
FNiagaraSystemInstance* NiagaraSystemInstance,
const void* OptionalPerInstanceData,
FNiagaraSimCacheFeedbackContext& FeedbackContext
)

 Called when we begin to write data into a simulation cache.
Public function Virtual bool

SimCacheReadFrame ( UObject* StorageObject,
int FrameA,
int FrameB,
float Interp,
FNiagaraSystemInstance* SystemInstance,
void* OptionalPerInstanceData
)

 Virtual bool SimCacheEndWrite(UObject* StorageObject) const override;
Public function Virtual Const bool

SimCacheWriteFrame ( UObject* StorageObject,
int FrameIndex,
FNiagaraSystemInstance* SystemInstance,
const void* OptionalPerInstanceData,
FNiagaraSimCacheFeedbackContext& FeedbackContext
)

 Called when we are ready to write data into the simulation cache.

Constants

Name Description
GetBaseColorName  
GetHeightName  
GetPhysicalMaterialIndexName  
GetWorldNormalName  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page