1. Epic GamesDeveloper
  3. HairStrandsDataflow

HairStrandsDataflow

API > API/Plugins

   
Name HairStrandsDataflow
Type Runtime
Part of Plugins Groom
Location /Engine/Plugins/Runtime/HairStrands/Source/HairStrandsDataflow/
Module Build Rules HairStrandsDataflow.Build.cs

Classes

Name Remarks
FHairStrandsDataflowModule Hair dataflow construction module public interface

Structs

Name Remarks
FAttachCurveRootsDataflowNode Attach the curve roots by setting their kinematic weights to 1.0f
FBuildCurveLODsDataflowNode Builds the curves LODs
FBuildCurveWeightsDataflowNode Build a weight map that will be identical on every curves
FBuildSplineSkinWeightsDataflowNode Build spline skinning data from skeletal mesh
FCollectionSplineAttributes  
FGenerateCurveGeometryDataflowNode Build the curve geometry from a collection containing curves
FGetCurveAttributesDataflowNode Get the kinematic weights attributes names
FGetGroomAssetDataflowNode_v2 Get the groom asset
FGroomAssetTerminalDataflowNode_v2  
FGroomAssetToCollectionDataflowNode Transform a groom asset to a collection
FLinearToSplineSkinWeightsDataflowNode Convert linear skinning data to spline skinning data
FResampleCurvePointsDataflowNode Resample the curves with a fixed number of points
FSmoothCurvePointsDataflowNode Smooth the curves for more stable deformation
FSplineToLinearSkinWeightsDataflowNode Convert spline skinning data to linear data
FTransferGeometrySkinWeightsDataflowNode Build the curves skinning by transferring the indices weights from a skelmesh geometry

Enums

Public

Name Remarks
EGroomAttributeType Enum to pick groom attribute type
EGroomCollectionType  
EGroomNumPoints Enum to pick the number of points per guide

Constants

Name Type Remarks Include Path
NumOtherInputs int32   GroomAssetTerminalNode.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AttributeKey FCollectionAttributeKey Get the kinematic weights attributes names Attribute key to build GetGroomAttributesNodes.h
  • Meta=(DisplayName="Attribute Key", DataflowOutput)
AttributeKeys TArray< FCollectionAttributeKey > List of attribute keys that will be used to save matching attributes in the collection. GroomAssetTerminalNode.h  
AttributeNames TArray< FName >   GroomAssetTerminalNode.h
  • EditAnywhere
  • Category=Attributes
  • EditFixedSize
AttributeType EGroomAttributeType Type of attribute to use GetGroomAttributesNodes.h
  • EditAnywhere
  • Category="Groom"
  • Meta=(DisplayName="Attribute Type")
BoneIndicesKey FCollectionAttributeKey Linear skinning bone indices key BuildGroomSplineSkinningNode.h
  • Meta=(DataflowOutput)
BoneWeightsKey FCollectionAttributeKey Linear skinning bone weights key BuildGroomSplineSkinningNode.h
  • Meta=(DataflowOutput)
Collection FManagedArrayCollection   GroomAssetTerminalNode.h
  • Meta=(DataflowInput, DataflowOutput, DisplayName="Collection", DataflowPassthrough="Collection")
Collection FManagedArrayCollection Resample the groom guides with a fixed number of points (in physics strands size) Managed array collection to be used to store datas ResampleGuidesPointsNode.h
  • Meta=(DataflowInput, DataflowOutput, DisplayName="Collection", DataflowPassthrough="Collection")
Collection FManagedArrayCollection Managed array collection to be used to store datas BuildGroomSplineSkinningNode.h
  • Meta=(DataflowInput, DataflowOutput, DataflowPassthrough="Collection")
Collection FManagedArrayCollection Smooth the guides for more stable simulation Managed array collection to be used to store data SmoothGuidesCurvesNode.h
  • Meta=(DataflowInput, DataflowOutput, DisplayName="Collection", DataflowPassthrough="Collection")
Collection FManagedArrayCollection Managed array collection used to store the guides GetGroomAssetNode.h
  • Meta=(DataflowOutput, DisplayName="Collection")
Collection FManagedArrayCollection Build the guides curves from the strands Managed array collection to be used to store datas GenerateGuidesCurvesNode.h
  • Meta=(DataflowInput, DataflowOutput, DisplayName="Collection", DataflowPassthrough="Collection")
Collection FManagedArrayCollection Builds the guides LODs Managed array collection to be used to store data BuildGuidesLODsNode.h
  • Meta=(DataflowInput, DataflowOutput, DisplayName="Collection", DataflowPassthrough="Collection")
Collection FManagedArrayCollection Attach the guides roots by setting their kinematic weights to 1.0f Managed array collection to be used to store datas AttachGuidesRootsNode.h
  • Meta=(DataflowInput, DataflowOutput, DisplayName="Collection", DataflowPassthrough="Collection")
CurveLodsKey FCollectionAttributeKey Curve lods indices key to be used in other nodes if necessary BuildGuidesLODsNode.h
  • Meta=(DisplayName="Curve Lods", DataflowOutput)
CurveParentsKey FCollectionAttributeKey Curve parent indices key to be used in other nodes if necessary BuildGuidesLODsNode.h
  • Meta=(DisplayName="Curve Parents", DataflowOutput)
CurvesType EGroomCollectionType Type of curves to use (guides/strands) GetGroomAttributesNodes.h
  • EditAnywhere
  • Category="Groom"
  • Meta=(DisplayName="Curves Type")
CurvesType EGroomCollectionType Type of curves to use to fill the groom collection (guides/strands) GetGroomAssetNode.h
  • EditAnywhere
  • Category="Groom"
  • Meta=(DisplayName="Display Curves")
CurvesType EGroomCollectionType Type of curves to build skinning for (guides/strands) BuildGroomSplineSkinningNode.h
  • EditAnywhere
  • Category="Groom Groups"
GroomAsset TObjectPtr< const UGroomAsset > Get the groom asset Input asset to read the guides from GetGroomAssetNode.h
  • EditAnywhere
  • Category="Groom"
  • Meta=(DisplayName="GroomAsset")
GroupIndex int32 Groom group index to build skinning weights for. BuildGroomSplineSkinningNode.h
  • EditAnywhere
  • Category="Groom Groups"
GroupIndex int32 Group index on which the roots will be attached. AttachGuidesRootsNode.h
  • EditAnywhere
  • Category="Groups"
  • Meta=(DisplayName="Group Index")
GuidesCount int32 Max number of guides GenerateGuidesCurvesNode.h
  • EditAnywhere
  • Category="Geometry"
  • Meta=(DisplayName="Guides Count")
KinematicWeightsKey FCollectionAttributeKey Point Kinematic weights key to be used in other nodes if necessary AttachGuidesRootsNode.h
  • Meta=(DisplayName="Kinematic Weights", DataflowOutput)
LODIndex int32 LOD used to build skinning weights BuildGroomSplineSkinningNode.h
  • EditAnywhere
  • Category="Skeletal Mesh"
  • Meta=(DisplayName="LOD Index")
PointsCount EGroomNumPoints Max number of points ResampleGuidesPointsNode.h
  • EditAnywhere
  • Category="Geometry"
  • Meta=(DisplayName="Points Count")
RootBones TArray< FString > Root bones to be used for spline skinning. BuildGroomSplineSkinningNode.h
  • EditAnywhere
  • Category="Skeletal Mesh"
SamplesPerSegment int32 Number of spline samples per bone segment. BuildGroomSplineSkinningNode.h
  • EditAnywhere
  • Category="Skeletal Mesh"
SkeletalMesh TObjectPtr< USkeletalMesh > SkeletalMesh used for spline skinning. Will be stored onto the groom asset BuildGroomSplineSkinningNode.h
  • EditAnywhere
  • Category="Skeletal Mesh"
  • Meta=(DataFlowInput)
SmoothingFactor float Smoothing factor between 0 and 1 SmoothGuidesCurvesNode.h
  • EditAnywhere
  • Category="Geometry"
  • Meta=(DisplayName="Smoothing Factor", ClampMin="0", ClampMax="1", UIMin="0", UIMax="1")
SplineBoneKey FCollectionAttributeKey Spline Bones key containing root and end spline bone. BuildGroomSplineSkinningNode.h
  • Meta=(DataflowOutput)
SplineBonesKey FCollectionAttributeKey Spline bones key. Used for storing root and end spline bone for each vertex. BuildGroomSplineSkinningNode.h
  • Meta=(DataflowInput)
SplineBonesName FString Spline bones attribute name. BuildGroomSplineSkinningNode.h
  • EditAnywhere
  • Category="Vertex Attributes"
  • Meta=(DisplayName="Spline Bones")
SplineBonesParamName FString Spline bones attribute name. Used for storing root and end spline bone for each vertex. BuildGroomSplineSkinningNode.h
  • EditAnywhere
  • Category="Vertex Attributes"
SplineParamKey FCollectionAttributeKey Spline Skinning Parameter key    

Spline skinning parameter key | BuildGroomSplineSkinningNode.h |

  • Meta=(DisplayName="Spline Parameter Key", DataflowOutput)
|
SplineParamName FString Spline skinning parameter attribute name

Spline skinning parameter attribute name. | BuildGroomSplineSkinningNode.h |

  • EditAnywhere
  • Category="Vertex Attributes"
  • Meta=(DisplayName="Spline Parameter")
|

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void Evaluate ( UE::Dataflow::FContext& Context,
const FDataflowOutput* Out
) const

 Build spline skinning data from skeletal mesh BuildGroomSplineSkinningNode.h  

virtual void Evaluate ( UE::Dataflow::FContext& Context,
const FDataflowOutput* Out
) const

   GroomAssetTerminalNode.h  

virtual void SetAssetValue ( TObjectPtr< UObject > Asset,
UE::Dataflow::FContext& Context
) const

   GroomAssetTerminalNode.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page