1. Epic GamesDeveloper
  3. UNiagaraDataInterfacePhysicsField

UNiagaraDataInterfacePhysicsField

Data Interface for the strand base

API > API/Plugins > API/Plugins/ChaosNiagara

Inheritance Hierarchy

References

   
Module ChaosNiagara
Header /Engine/Plugins/Experimental/ChaosNiagara/Source/ChaosNiagara/Classes/NiagaraDataInterfacePhysicsField.h
Include #include "NiagaraDataInterfacePhysicsField.h"

Syntax

UCLASS (EditInlineNew, Category="Chaos", Meta=(DisplayName="Physics Field"))  
class UNiagaraDataInterfacePhysicsField : public UNiagaraDataInterface

Remarks

Data Interface for the strand base

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

GetPhysicsFieldBounds ( FVectorVMExternalFunctionContext& Context
)

 Get the field bounds
Public function void

GetPhysicsFieldResolution ( FVectorVMExternalFunctionContext& Context
)

 Get the field resolution
Public function void

SamplePhysicsIntegerField ( FVectorVMExternalFunctionContext& Context
)

 Sample the integer field
Public function void

SamplePhysicsScalarField ( FVectorVMExternalFunctionContext& Context
)

 Sample the scalar field
Public function void

SamplePhysicsVectorField ( FVectorVMExternalFunctionContext& Context
)

 Sample the vector field

Overridden from UNiagaraDataInterface

  Type Name Description
Public function Virtual Const bool GPU simulation functionality
Public function Virtual Const bool  
Protected function Virtual Const bool Copy one niagara DI to this
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  
Public function Virtual void

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

 UNiagaraDataInterface Interface
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

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

  
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 UObject Interface

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page