Navigation
API > API/Plugins > API/Plugins/Niagara
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UNiagaraMergeable
- UNiagaraDataInterfaceBase
- UNiagaraDataInterface
- UNiagaraDataInterfacePhysicsAsset
References
| Module | Niagara |
| Header | /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraDataInterfacePhysicsAsset.h |
| Include | #include "NiagaraDataInterfacePhysicsAsset.h" |
Syntax
UCLASS&40;EditInlineNew, Category&61;"Physics", CollapseCategories, Meta&61;&40;DisplayName&61;"Physics Asset"&41;,
MinimalAPI&41;
class UNiagaraDataInterfacePhysicsAsset : public UNiagaraDataInterface
Remarks
Data Interface for interacting with PhysicsAssets
Variables
| Type | Name | Description | |
|---|---|---|---|
| TObjectPtr< UPhysicsAsset > | DefaultSource | Skeletal Mesh from which the Physics Asset will be found. | |
| FNiagaraUserParameterBinding | MeshUserParameter | Reference to a user parameter if we're reading one. | |
| TArray< TWeakObjectPtr< class UPhysicsAsset > > | PhysicsAssets | The source asset from which to sample | |
| TSoftObjectPtr< AActor > | SoftSourceActor | The source actor from which to sample | |
| TArray< TWeakObjectPtr< class USkeletalMeshComponent > > | SourceComponents | The source component from which to sample |
Constructors
| Type | Name | Description | |
|---|---|---|---|
UNiagaraDataInterfacePhysicsAsset
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | ExtractSourceComponent
(
FNiagaraSystemInstance* SystemInstance, |
Extract the source component | |
| void | GetClosestDistance
(
FVectorVMExternalFunctionContext& Context |
Get the closest distance | |
| void | GetClosestElement
(
FVectorVMExternalFunctionContext& Context |
Get the closest element | |
| void | GetClosestPoint
(
FVectorVMExternalFunctionContext& Context |
Get the closest point | |
| void | GetElementDistance
(
FVectorVMExternalFunctionContext& Context |
Get the element distance | |
| void | GetElementPoint
(
FVectorVMExternalFunctionContext& Context |
Get the element point | |
| void | GetNumBoxes
(
FVectorVMExternalFunctionContext& Context |
Get the number of boxes | |
| void | GetNumCapsules
(
FVectorVMExternalFunctionContext& Context |
Get the number of capsules | |
| void | GetNumSpheres
(
FVectorVMExternalFunctionContext& Context |
Get the number of spheres | |
| void | GetProjectionPoint
(
FVectorVMExternalFunctionContext& Context |
Get the projection point | |
| void | GetTexturePoint
(
FVectorVMExternalFunctionContext& Context |
Get the closest texture point |
Overridden from UNiagaraDataInterface
| Type | Name | Description | |
|---|---|---|---|
| bool | AppendCompileHash
(
FNiagaraCompileHashVisitor* InVisitor |
GPU simulation functionality | |
| ETickingGroup | CalculateTickGroup
(
const void* PerInstanceData |
||
| bool | CanExecuteOnTarget
(
ENiagaraSimTarget Target |
||
| bool | CopyToInternal
(
UNiagaraDataInterface* Destination |
Copy one niagara DI to this | |
| void | DestroyPerInstanceData
(
void* PerInstanceData, |
Destroys the per instance data for this interface. | |
| bool | Equals
(
const UNiagaraDataInterface* Other |
Determines if this DataInterface is the same as another. | |
| void | GetCommonHLSL
(
FString& OutHLSL |
Allows data interfaces to provide common functionality that will be shared across interfaces on that type. | |
| bool | GetFunctionHLSL
(
const FNiagaraDataInterfaceGPUParamInfo& ParamInfo, |
||
| void | GetFunctions
(
TArray< FNiagaraFunctionSignature >& OutFunctions |
UNiagaraDataInterface Interface | |
| void | GetParameterDefinitionHLSL
(
const FNiagaraDataInterfaceGPUParamInfo& ParamInfo, |
||
| void | GetVMExternalFunction
(
const FVMExternalFunctionBindingInfo& BindingInfo, |
Returns the delegate for the passed function signature. | |
| bool | |||
| bool | |||
| bool | InitPerInstanceData
(
void* PerInstanceData, |
Initializes the per instance data for this interface. | |
| int32 | Returns the size of the per instance data for this interface. | ||
| bool | PerInstanceTick
(
void* PerInstanceData, |
Ticks the per instance data for this interface, if it has any. | |
| void | ProvidePerInstanceDataForRenderThread
(
void* DataForRenderThread, |
Subclasses that wish to work with GPU systems/emitters must implement this. | |
| void | SetShaderParameters
(
const FNiagaraDataInterfaceSetShaderParametersContext& Context |
Set the shader parameters will only be called if the data interface provided shader parameters. |
Overridden from UNiagaraDataInterfaceBase
| Type | Name | Description | |
|---|---|---|---|
| void | BuildShaderParameters
(
FNiagaraShaderParametersBuilder& ShaderParametersBuilder |
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 | |
|---|---|---|---|
| void | UObject Interface | ||
| void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |
Deprecated Variables
| Type | Name | Description | |
|---|---|---|---|
| TObjectPtr< AActor > | SourceActor_DEPRECATED |