1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceSkeletalMesh

UNiagaraDataInterfaceSkeletalMesh

Data Interface allowing sampling of skeletal meshes.

API > API/Plugins > API/Plugins/Niagara

Data Interface allowing sampling of skeletal meshes.

   
Name UNiagaraDataInterfaceSkeletalMesh
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceSkeletalMesh.h
Include Path #include "NiagaraDataInterfaceSkeletalMesh.h"

Syntax

UCLASS (EditInlineNew, Category="Meshes", Meta=(DisplayName="Skeletal Mesh"), MinimalAPI)  
class UNiagaraDataInterfaceSkeletalMesh : public UNiagaraDataInterface

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraDataInterfaceSkeletalMesh ( const FObjectInitializer& ObjectInitializer
)

   NiagaraDataInterfaceSkeletalMesh.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bExcludeBone uint8   NiagaraDataInterfaceSkeletalMesh.h
  • EditAnywhere
  • Category="Skeleton"
  • Meta=(InlineEditConditionToggle)
bReadDeformedGeometry bool Overrides the project setting and allows you to opt out of reading from deformed geometry. NiagaraDataInterfaceSkeletalMesh.h
  • EditAnywhere
  • Category="Performance"
bRequireCurrentFrameData bool When this option is disabled, we use the previous frame's data for the skeletal mesh and can often issue the simulation early. NiagaraDataInterfaceSkeletalMesh.h
  • EditAnywhere
  • Category="Performance"
ChangeId uint32 Cached change id off of the data interface. NiagaraDataInterfaceSkeletalMesh.h  
DefaultMesh TObjectPtr< USkeletalMesh > Mesh used to sample from when not overridden by a source actor from the scene. NiagaraDataInterfaceSkeletalMesh.h
  • EditAnywhere
  • Category="Mesh"
  • Meta=(DisallowedClasses="/Script/ApexDestruction.DestructibleMesh")
ExcludeBoneName FName Optionally remove a single bone from Random / Random Unfiltered access. NiagaraDataInterfaceSkeletalMesh.h
  • EditAnywhere
  • Category="Skeleton"
  • Meta=(EditCondition="bExcludeBone")
FilteredBones TArray< FName > Set of filtered bones that can be used for sampling. NiagaraDataInterfaceSkeletalMesh.h
  • EditAnywhere
  • Category="Skeleton"
FilteredSockets TArray< FName > Set of filtered sockets that can be used for sampling. NiagaraDataInterfaceSkeletalMesh.h
  • EditAnywhere
  • Category="Skeleton"
MeshUserParameter FNiagaraUserParameterBinding Reference to a user parameter if we're reading one. NiagaraDataInterfaceSkeletalMesh.h
  • EditAnywhere
  • Category="Mesh"
PreviewMesh TSoftObjectPtr< USkeletalMesh > Mesh used to sample from when not overridden by a source actor from the scene. NiagaraDataInterfaceSkeletalMesh.h
  • EditAnywhere
  • Category="Mesh"
  • Meta=(DisallowedClasses="/Script/ApexDestruction.DestructibleMesh")
SamplingRegions TArray< FName > Sampling regions on the mesh from which to sample. Leave this empty to sample from the whole mesh. NiagaraDataInterfaceSkeletalMesh.h
  • EditAnywhere
  • Category="Mesh"
SkinningMode ENDISkeletalMesh_SkinningMode Selects which skinning mode to use, for most cases Skin On The Fly will cover your requirements, see individual tooltips for more information. NiagaraDataInterfaceSkeletalMesh.h
  • EditAnywhere
  • Category="Mesh"
SourceMode ENDISkeletalMesh_SourceMode Controls how to retrieve the Skeletal Mesh Component to attach to. NiagaraDataInterfaceSkeletalMesh.h
  • EditAnywhere
  • Category="Mesh"
UvSetIndex int32   NiagaraDataInterfaceSkeletalMesh.h
  • EditAnywhere
  • Category="Experimental - UV Mapping"
WholeMeshLOD int32 If no regions are specified, we'll sample the whole mesh at this LODIndex. NiagaraDataInterfaceSkeletalMesh.h
  • EditAnywhere
  • Category="Mesh"

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BindSkeletonSamplingFunction ( const FVMExternalFunctionBindingInfo& BindingInfo,
FNDISkeletalMesh_InstanceData* InstData,
FVMExternalFunction& OutFunc
)

   NiagaraDataInterfaceSkeletalMesh.h  

void BindTriangleSamplingFunction ( const FVMExternalFunctionBindingInfo& BindingInfo,
FNDISkeletalMesh_InstanceData* InstData,
FVMExternalFunction& OutFunc
)

   NiagaraDataInterfaceSkeletalMesh.h  

void BindVertexSamplingFunction ( const FVMExternalFunctionBindingInfo& BindingInfo,
FNDISkeletalMesh_InstanceData* InstData,
FVMExternalFunction& OutFunc
)

   NiagaraDataInterfaceSkeletalMesh.h  

int32 CalculateLODIndexAndSamplingRegions ( USkeletalMesh* InMesh,
TArray< int32 >& OutSamplingRegionIndices,
bool& OutAllRegionsAreAreaWeighting
) const

   NiagaraDataInterfaceSkeletalMesh.h  

void GetBoneCount ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void GetFilteredBoneAt ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void GetFilteredBoneCount ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void GetFilteredSocketBoneAt ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void GetFilteredSocketCount ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void GetFilteredSocketOrBoneBoneAt ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void GetFilteredSocketOrBoneCount ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void GetFilteredSocketTransform ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  
  NiagaraDataInterfaceSkeletalMesh.h  

int32 GetFilteredTriangleAt ( FSkeletalMeshAccessorHelper& Accessor,
FNDISkeletalMesh_InstanceData* InstData,
int32 FilteredIndex
)

      

int32 GetFilteredTriangleAt ( FSkeletalMeshAccessorHelper& Accessor,
FNDISkeletalMesh_InstanceData* InstData,
int32 FilteredIndex
)

      

int32 GetFilteredTriangleAt ( FSkeletalMeshAccessorHelper& Accessor,
FNDISkeletalMesh_InstanceData* InstData,
int32 FilteredIndex
)

      

int32 GetFilteredTriangleAt ( FSkeletalMeshAccessorHelper& Accessor,
FNDISkeletalMesh_InstanceData* InstData,
int32 FilteredIndex
)

      

int32 GetFilteredTriangleAt ( FSkeletalMeshAccessorHelper& Accessor,
FNDISkeletalMesh_InstanceData* InstData,
int32 FilteredIndex
)

      

int32 GetFilteredTriangleAt ( FSkeletalMeshAccessorHelper& Accessor,
FNDISkeletalMesh_InstanceData* InstData,
int32 FilteredIndex
)

      
  NiagaraDataInterfaceSkeletalMesh.h  
     
     
     
     
     
     
  NiagaraDataInterfaceSkeletalMesh.h  

int32 GetFilteredVertexAt ( FSkeletalMeshAccessorHelper& Accessor,
FNDISkeletalMesh_InstanceData* InstData,
int32 FilteredIndex
)

      

int32 GetFilteredVertexAt ( FSkeletalMeshAccessorHelper& Accessor,
FNDISkeletalMesh_InstanceData* InstData,
int32 FilteredIndex
)

      

int32 GetFilteredVertexAt ( FSkeletalMeshAccessorHelper& Accessor,
FNDISkeletalMesh_InstanceData* InstData,
int32 FilteredIndex
)

      
     
     
     
  NiagaraDataInterfaceSkeletalMesh.h  

void GetParentBone ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

USkeletalMesh * GetSkeletalMesh ( FNiagaraSystemInstance* SystemInstance,
USceneComponent* AttachComponent,
TWeakObjectPtr< USceneComponent >& SceneComponent,
USkeletalMeshComponent*& FoundSkelComp,
FNDISkeletalMesh_InstanceData* InstData
)

 This overload is for use when initializing per-instance data. NiagaraDataInterfaceSkeletalMesh.h  
Finds the skeletal mesh based on settings of the DI and the hierarchy of the object provided NiagaraDataInterfaceSkeletalMesh.h  

void GetSkeletonSamplingFunctions ( TArray< FNiagaraFunctionSignature >& OutFunctions
) const

 End of Vertex Sampling. NiagaraDataInterfaceSkeletalMesh.h  

void GetSkinnedBoneData ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

AActor * GetSourceActor()

   NiagaraDataInterfaceSkeletalMesh.h  

USkeletalMeshComponent * GetSourceComponent()

   NiagaraDataInterfaceSkeletalMesh.h  
  NiagaraDataInterfaceSkeletalMesh.h  
     
     
  NiagaraDataInterfaceSkeletalMesh.h  

void GetTriangleData ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void GetTriangleIndices ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void GetTriangleSamplingFunctions ( TArray< FNiagaraFunctionSignature >& OutFunctions
) const

 Triangle sampling Triangles are sampled a using MeshTriangleCoordinates which are composed of Triangle index and a bary centric coordinate on that triangle. NiagaraDataInterfaceSkeletalMesh.h  

void GetTriCoordColor ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void GetTriCoordColorFallback ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void GetTriCoordSkinnedData ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void GetTriCoordSkinnedDataFallback ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  
     
  NiagaraDataInterfaceSkeletalMesh.h  

void GetUnfilteredBoneAt ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void GetUnfilteredBoneCount ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void GetVertexColor ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void GetVertexColorFallback ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void GetVertexCount ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void GetVertexData ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  
End of Mesh Sampling. NiagaraDataInterfaceSkeletalMesh.h  

void GetVertexSkinnedData ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  
     
  NiagaraDataInterfaceSkeletalMesh.h  

void IsValidBone ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void IsValidFilteredVertex ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void IsValidTriCoord ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void IsValidVertex ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void RandomBone ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void RandomFilteredBone ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void RandomFilteredSocket ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void RandomFilteredSocketOrBone ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void RandomFilteredVertex ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void RandomTriCoord ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void RandomUnfilteredBone ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void RandomVertex ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

void SetFilteredBonesFromBlueprints ( const TArray< FName >& InFilteredBones
)

   NiagaraDataInterfaceSkeletalMesh.h  

void SetFilteredSocketsFromBlueprints ( const TArray< FName >& InFilteredSockets
)

   NiagaraDataInterfaceSkeletalMesh.h  

void SetSamplingRegionsFromBlueprints ( const TArray< FName >& InSamplingRegions
)

   NiagaraDataInterfaceSkeletalMesh.h  

void SetSourceComponentFromBlueprints ( USkeletalMeshComponent* ComponentToUse
)

 End of Direct Bone + Socket Sampling. NiagaraDataInterfaceSkeletalMesh.h  

void SetWholeMeshLODFromBlueprints ( int32 MeshLODLevel
)

   NiagaraDataInterfaceSkeletalMesh.h  

void VMGetSkinnedTriangleVertexData ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSkeletalMesh.h  

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool AppendCompileHash ( FNiagaraCompileHashVisitor* InVisitor
) const

 Allows the generic class defaults version of this class to specify any dependencies/version/etc that might invalidate the compile. NiagaraDataInterfaceSkeletalMesh.h  

virtual ETickingGroup CalculateTickGroup ( const void* PerInstanceData
) const

   NiagaraDataInterfaceSkeletalMesh.h  

virtual bool CanExecuteOnTarget ( ENiagaraSimTarget Target
) const

   NiagaraDataInterfaceSkeletalMesh.h  

virtual void DestroyPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Destroys the per instance data for this interface. NiagaraDataInterfaceSkeletalMesh.h  

virtual bool Equals ( const UNiagaraDataInterface* Other
) const

 Determines if this DataInterface is the same as another. NiagaraDataInterfaceSkeletalMesh.h  

virtual void GetCommonHLSL ( FString& OutHLSL
)

 Allows data interfaces to provide common functionality that will be shared across interfaces on that type. NiagaraDataInterfaceSkeletalMesh.h  
Query the data interface to give feedback to the end user. NiagaraDataInterfaceSkeletalMesh.h  

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

   NiagaraDataInterfaceSkeletalMesh.h  

virtual void GetParameterDefinitionHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo,
FString& OutHLSL
)

   NiagaraDataInterfaceSkeletalMesh.h  

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

 Returns the delegate for the passed function signature. NiagaraDataInterfaceSkeletalMesh.h  

virtual bool HasPreSimulateTick()

   NiagaraDataInterfaceSkeletalMesh.h  

virtual bool HasTickGroupPrereqs()

   NiagaraDataInterfaceSkeletalMesh.h  

virtual bool InitPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Initializes the per instance data for this interface. NiagaraDataInterfaceSkeletalMesh.h  

virtual void ModifyCompilationEnvironment ( EShaderPlatform ShaderPlatform,
FShaderCompilerEnvironment& OutEnvironment
) const

 Allows data interfaces to influence the compilation of GPU shaders and is only called on the CDO object not the instance. NiagaraDataInterfaceSkeletalMesh.h  

virtual int32 PerInstanceDataSize ()

 Returns the size of the per instance data for this interface. NiagaraDataInterfaceSkeletalMesh.h  

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

 Ticks the per instance data for this interface, if it has any. NiagaraDataInterfaceSkeletalMesh.h  

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

 Subclasses that wish to work with GPU systems/emitters must implement this. NiagaraDataInterfaceSkeletalMesh.h  
Set the shader parameters will only be called if the data interface provided shader parameters. NiagaraDataInterfaceSkeletalMesh.h  

virtual bool UpgradeFunctionCall ( FNiagaraFunctionSignature& FunctionSignature
)

 Allows data interfaces the opportunity to rename / change the function signature and perform an upgrade. NiagaraDataInterfaceSkeletalMesh.h  

virtual void ValidateFunction ( const FNiagaraFunctionSignature& Function,
TArray< FText >& OutValidationErrors
)

 Validates a function being compiled and allows interface classes to post custom compile errors when their API changes. NiagaraDataInterfaceSkeletalMesh.h  

Overridden from UNiagaraDataInterfaceBase

Name Remarks Include Path Unreal Specifiers

virtual void BuildShaderParameters ( FNiagaraShaderParametersBuilder& ShaderParametersBuilder
) const

   NiagaraDataInterfaceSkeletalMesh.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* InProperty
) const

   NiagaraDataInterfaceSkeletalMesh.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   NiagaraDataInterfaceSkeletalMesh.h  

virtual void PostInitProperties()

   NiagaraDataInterfaceSkeletalMesh.h  

virtual void PostLoad()

   NiagaraDataInterfaceSkeletalMesh.h  

Overridden from UObjectBaseUtility

Name Remarks Include Path Unreal Specifiers

virtual bool CanBeInCluster()

   NiagaraDataInterfaceSkeletalMesh.h  

Protected

Name Remarks Include Path Unreal Specifiers

void BindSourceDelegates()

   NiagaraDataInterfaceSkeletalMesh.h  

void OnSourceEndPlay ( AActor* InSource,
EEndPlayReason::Type Reason
)

   NiagaraDataInterfaceSkeletalMesh.h  

void UnbindSourceDelegates()

 Bind/unbind delegates to release references to the source actor & component. NiagaraDataInterfaceSkeletalMesh.h  

void VMGetPreSkinnedLocalBounds ( FVectorVMExternalFunctionContext& Context
)

 Misc Functions. NiagaraDataInterfaceSkeletalMesh.h  

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool CopyToInternal ( UNiagaraDataInterface* Destination
) const

   NiagaraDataInterfaceSkeletalMesh.h  

virtual void GetFunctionsInternal ( TArray< FNiagaraFunctionSignature >& OutFunctions
) const

   NiagaraDataInterfaceSkeletalMesh.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
Source_DEPRECATED TObjectPtr< AActor >   NiagaraDataInterfaceSkeletalMesh.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page