1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceSkeletalMesh

UNiagaraDataInterfaceSkeletalMesh

Data Interface allowing sampling of skeletal meshes.

Unreal Engine C++ API Reference > Plugins > Niagara

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;EditInlineNew, Category&61;"Meshes", Meta&61;&40;DisplayName&61;"Skeletal Mesh"&41;, MinimalAPI&41;  
class UNiagaraDataInterfaceSkeletalMesh : public UNiagaraDataInterface

Remarks

Data Interface allowing sampling of skeletal meshes.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bExcludeBone  
Public variable UProperty Category, EditAnywhere bool bRequireCurrentFrameData When this option is disabled, we use the previous frame's data for the skeletal mesh and can often issue the simulation early.
Public variable uint32 ChangeId Cached change id off of the data interface.
Protected variable UProperty Category, EditAnywhere TArray< FName > ComponentTags If defined, the supplied tags will be used to identify a valid component
Public variable UProperty Category, EditAnywhere, Meta FName ExcludeBoneName Optionally remove a single bone from Random / Random Unfiltered access.
Public variable UProperty Category, EditAnywhere TArray< FName > FilteredBones Set of filtered bones that can be used for sampling.
Public variable UProperty Category, EditAnywhere TArray< FName > FilteredSockets Set of filtered sockets that can be used for sampling.
Public variable UProperty Category, EditAnywhere FNiagaraUserParameterBinding MeshUserParameter Reference to a user parameter if we're reading one.
Public variable UProperty Category, EditAnywhere, Meta TSoftObjectPtr< USkeletalMesh > PreviewMesh Mesh used to sample from when not overridden by a source actor from the scene.
Public variable UProperty Category, EditAnywhere TArray< FName > SamplingRegions Sampling regions on the mesh from which to sample. Leave this empty to sample from the whole mesh.
Public variable UProperty Category, EditAnywhere ENDISkeletalMesh_SkinningMode SkinningMode Selects which skinning mode to use, for most cases Skin On The Fly will cover your requirements, see individual tooltips for more information.
Protected variable UProperty Category, EditAnywhere, Meta TSoftObjectPtr< AActor > SoftSourceActor The source actor from which to sample.
Protected variable UProperty Transient TObjectPtr< USkeletalMeshComponent > SourceComponent The source component from which to sample.
Public variable UProperty Category, EditAnywhere ENDISkeletalMesh_SourceMode SourceMode Controls how to retrieve the Skeletal Mesh Component to attach to.
Public variable UProperty Category, EditAnywhere int32 UvSetIndex  
Public variable UProperty Category, EditAnywhere int32 WholeMeshLOD If no regions are specified, we'll sample the whole mesh at this LODIndex.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

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

  
Protected function void  
Public function void

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

  
Public function void

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

  
Public function Const int32

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

  
Public function void

GetBoneCount ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetFilteredBoneAt ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetFilteredBoneCount ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetFilteredSocketBoneAt ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetFilteredSocketCount ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetFilteredSocketOrBoneBoneAt ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetFilteredSocketOrBoneCount ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetFilteredSocketTransform ( FVectorVMExternalFunctionContext& Context
)

  
Public function int32  
Public function int32  
Public function int32  
Public function int32  
Public function int32  
Public function int32  
Public function void

GetFilteredTriangleAt ( FVectorVMExternalFunctionContext& Context
)

  
Public function int32  
Public function int32  
Public function int32  
Public function int32  
Public function int32  
Public function void

GetFilteredTriangleCount ( FVectorVMExternalFunctionContext& Context
)

  
Public function int32  
Public function int32

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

  
Public function void

GetFilteredVertexAt ( FVectorVMExternalFunctionContext& Context
)

  
Public function int32

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

  
Public function int32

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

  
Public function int32  
Public function int32  
Public function int32  
Public function void

GetFilteredVertexCount ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetParentBone ( FVectorVMExternalFunctionContext& Context
)

  
Public function USkeletalMesh *

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

 This overload is for use when initializing per-instance data.
Public function USkeletalMesh * Finds the skeletal mesh based on settings of the DI and the hierarchy of the object provided
Public function void End of Vertex Sampling.
Public function void

GetSkinnedBoneData ( FVectorVMExternalFunctionContext& Context
)

  
Public function Const AActor *  
Public function Const USkeletalMeshComponent *  
Public function void

GetTriangleCoordAtUV ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetTriangleCoordAtUV ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetTriangleCoordInAabb ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetTriangleCoordInAabb ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetTriangleData ( FVectorVMExternalFunctionContext& Context
)

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

GetTriCoordColor ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetTriCoordColorFallback ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetTriCoordSkinnedData ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetTriCoordSkinnedDataFallback ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetTriCoordUV ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetTriCoordUV ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetTriCoordVertices ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetUnfilteredBoneAt ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetUnfilteredBoneCount ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetVertexColor ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetVertexColorFallback ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetVertexCount ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetVertexData ( FVectorVMExternalFunctionContext& Context
)

  
Public function void End of Mesh Sampling.
Public function void

GetVertexSkinnedData ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetVertexUV ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetVertexUV ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

IsValidBone ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

IsValidFilteredVertex ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

IsValidTriCoord ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

IsValidVertex ( FVectorVMExternalFunctionContext& Context
)

  
Protected function UFunction void  
Public function void

RandomBone ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

RandomFilteredBone ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

RandomFilteredSocket ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

RandomFilteredSocketOrBone ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

RandomFilteredVertex ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

RandomTriCoord ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

RandomUnfilteredBone ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

RandomVertex ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

SetFilteredBonesFromBlueprints ( const TArray< FName >& InFilteredBones
)

  
Public function void

SetFilteredSocketsFromBlueprints ( const TArray< FName >& InFilteredSockets
)

  
Public function void

SetSamplingRegionsFromBlueprints ( const TArray< FName >& InSamplingRegions
)

  
Public function void End of Direct Bone + Socket Sampling.
Public function void

SetWholeMeshLODFromBlueprints ( int32 MeshLODLevel
)

  
Protected function void Bind/unbind delegates to release references to the source actor & component.
Protected function void

VMGetPreSkinnedLocalBounds ( FVectorVMExternalFunctionContext& Context
)

 Misc Functions.

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 ETickingGroup

CalculateTickGroup ( const void* PerInstanceData
)

  
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 void

DrawDebugHud ( FNDIDrawDebugHudContext& DebugHudContext
)

 Override this function to provide additional context to the debug HUD.
Public function Virtual Const bool

Equals ( const UNiagaraDataInterface* Other
)

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

GetCommonHLSL ( FString& OutHLSL
)

 Allows data interfaces to provide common functionality that will be shared across interfaces on that type.
Public function Virtual void Query the data interface to give feedback to the end user.
Public function Virtual bool

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

  
Public function Virtual void Gets all the available functions for this data interface.
Public function Virtual void  
Public function Virtual void

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

 Returns the delegate for the passed function signature.
Public function Virtual Const bool  
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 void

ModifyCompilationEnvironment ( EShaderPlatform ShaderPlatform,
FShaderCompilerEnvironment& OutEnvironment
)

 Allows data interfaces to influence the compilation of GPU shaders and is only called on the CDO object not the instance.
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.
Public function 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.

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 Const bool

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.
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.

Overridden from UObjectBaseUtility

  Type Name Description
Public function Virtual Const bool Called during cluster construction if the object can be added to a cluster

Deprecated Variables

  Type Name Description
Protected variable UProperty TObjectPtr< AActor > Source_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page