1. Epic GamesDeveloper
  3. FDataflowCollectionEditSkinWeightsNode

FDataflowCollectionEditSkinWeightsNode

Edit skin weights vertex properties.

API > API/Plugins > API/Plugins/DataflowNodes

Edit skin weights vertex properties.

   
Name FDataflowCollectionEditSkinWeightsNode
Type struct
Header File /Engine/Plugins/Experimental/Dataflow/Source/DataflowNodes/Public/Dataflow/DataflowCollectionEditSkinWeightsNode.h
Include Path #include "Dataflow/DataflowCollectionEditSkinWeightsNode.h"

Syntax

USTRUCT (Meta=(Experimental, DataflowCollection))  
struct FDataflowCollectionEditSkinWeightsNode : public FDataflowPrimitiveNode

Inheritance Hierarchy

Classes

Name Remarks
FEditNodeToolChange  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bCompressSkinWeights bool Boolean to use a compressed format (FVector4f, FIntVector) to store the skin weights Dataflow/DataflowCollectionEditSkinWeightsNode.h
  • EditAnywhere
  • Category="Skeleton Binding"
BoneIndicesKey FCollectionAttributeKey Bone indices key to be used in other nodes if necessary Dataflow/DataflowCollectionEditSkinWeightsNode.h
  • Meta=(DisplayName="Bone Indices", DataflowInput, DataflowOutput, DataflowPassthrough="BoneIndicesKey")
BoneIndicesName FString The name to be set as a weight map attribute. Dataflow/DataflowCollectionEditSkinWeightsNode.h
  • EditAnywhere
  • Category="Vertex Attributes"
  • Meta=(DisplayName="Bone Indices")
BoneWeightsKey FCollectionAttributeKey Bone weights key to be used in other nodes if necessary Dataflow/DataflowCollectionEditSkinWeightsNode.h
  • Meta=(DisplayName="Bone Weights", DataflowInput, DataflowOutput, DataflowPassthrough="BoneWeightsKey")
BoneWeightsName FString The name to be set as a weight map attribute. Dataflow/DataflowCollectionEditSkinWeightsNode.h
  • EditAnywhere
  • Category="Vertex Attributes"
  • Meta=(DisplayName="Bone Weights")
Collection DATAFLOW_NODE_DEFINE_INTERNAL(FDataflowCollectionEditSkinWeightsNode, "EditSkinWeights", "Collection", "Edit skin weights and save it to collection") public FManagedArrayCollection   Dataflow/DataflowCollectionEditSkinWeightsNode.h
  • Meta=(DataflowInput, DataflowOutput, DataflowPassthrough="Collection")
OnBoneSelectionChanged FDataflowBoneSelectionChangedNotifyDelegate Delegate to transfer the bone selection to the tool Dataflow/DataflowCollectionEditSkinWeightsNode.h  
SkeletalMesh TObjectPtr< USkeletalMesh > Skeletal mesh to extract the skeleton from for the skinning Dataflow/DataflowCollectionEditSkinWeightsNode.h
  • EditAnywhere
  • Category="Skeleton Binding"
  • Meta=(DataflowInput)
SkinWeightsRefSkeletonHash int32 Hash of the ref skeleton the stored skin weight are based on This allow invalidating the SkinWeights when the ref skeleton does not match anymore instead of having broken weights Dataflow/DataflowCollectionEditSkinWeightsNode.h  
VertexGroup FScalarVertexPropertyGroup Target group in which the attributes are stored Dataflow/DataflowCollectionEditSkinWeightsNode.h
  • EditAnywhere
  • Category="Vertex Attributes"
  • Meta=(DisplayName="Vertex Group")
VertexSkinWeights FDataflowVertexSkinWeightData   Dataflow/DataflowCollectionEditSkinWeightsNode.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bValidSkeletalMeshes bool Valid skeletal mesh boolean to trigger the construction Dataflow/DataflowCollectionEditSkinWeightsNode.h  
DynamicMeshes TArray< TObjectPtr< UDynamicMesh > > Transient dynamic meshes built from dataflow render collection Dataflow/DataflowCollectionEditSkinWeightsNode.h
  • Transient
SkeletalMeshes TArray< TObjectPtr< USkeletalMesh > > Transient skeletal mesh built from dataflow render collection Dataflow/DataflowCollectionEditSkinWeightsNode.h
  • Transient
SkeletonObject TRefCountPtr< FDataflowDebugDrawSkeletonObject > Not ideal but for now this is the only way we can update the displayed skeleton todo(dataflow) : find a better way to handle skeleton drawing and manipulation post 5.7 Dataflow/DataflowCollectionEditSkinWeightsNode.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ExtractVertexWeights ( UE::Dataflow::FContext& Context,
const TArray< TArray< int32 > >& SetupIndices,
const TArray< TArray< float > >& SetupWeights,
TArrayView< TArray< int32 > > FinalIndices,
TArrayView< TArray< float > > FinalWeights
) const

 Extract the vertex weights back from the property ones Dataflow/DataflowCollectionEditSkinWeightsNode.h  

FCollectionAttributeKey GetBoneIndicesKey ( UE::Dataflow::FContext& Context
) const

 Get the weights attribute key to retrieve/set the weight values Dataflow/DataflowCollectionEditSkinWeightsNode.h  

FCollectionAttributeKey GetBoneWeightsKey ( UE::Dataflow::FContext& Context
) const

 Get the weights attribute key to retrieve/set the weight values Dataflow/DataflowCollectionEditSkinWeightsNode.h  
  Dataflow/DataflowCollectionEditSkinWeightsNode.h  

int32 GetSkeletalMeshOffset ( const TObjectPtr< USkeletalMesh >& SkeletalMesh
) const

 Return the collection offset given a skeletal mesh Dataflow/DataflowCollectionEditSkinWeightsNode.h  

TUniquePtr< class FToolCommandChange > MakeEditNodeToolChange()

   Dataflow/DataflowCollectionEditSkinWeightsNode.h  

void ReportVertexWeights ( UE::Dataflow::FContext& Context,
const TArray< TArray< int32 > >& SetupIndices,
const TArray< TArray< float > >& SetupWeights,
const TArray< TArray< int32 > >& FinalIndices,
const TArray< TArray< float > >& FinalWeights
)

 Report the vertex weights back onto the property ones Dataflow/DataflowCollectionEditSkinWeightsNode.h  

void ValidateSkeletalMeshes()

 Validate the skeletal mesh construction Dataflow/DataflowCollectionEditSkinWeightsNode.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool FillAttributeWeights ( const FManagedArrayCollection& SelectedCollection,
const FCollectionAttributeKey& IndicesAttributeKey,
const FCollectionAttributeKey& WeightsAttributeKey,
TArray< TArray< int32 > >& AttributeIndices,
TArray< TArray< float > >& AttributeWeights
)

 Fill the weight attribute values from the collection Dataflow/DataflowCollectionEditSkinWeightsNode.h  

static bool GetAttributeWeights ( FManagedArrayCollection& SelectedCollection,
const FCollectionAttributeKey& InBoneIndicesKey,
const FCollectionAttributeKey& InBoneWeightsKey,
TArray< TArray< int32 > >& AttributeIndices,
TArray< TArray< float > >& AttributeWeights,
const bool bCanCompressSkinWeights
)

 Get the weight attribute values and add them if not there Dataflow/DataflowCollectionEditSkinWeightsNode.h  

static bool SetAttributeWeights ( FManagedArrayCollection& SelectedCollection,
const FCollectionAttributeKey& InBoneIndicesKey,
const FCollectionAttributeKey& InBoneWeightsKey,
const TArray< TArray< int32 > >& AttributeIndices,
const TArray< TArray< float > >& AttributeWeights
)

 Set back the attribute values into the collection Dataflow/DataflowCollectionEditSkinWeightsNode.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
SkinWeights_DEPRECATED TArray< FDataflowSkinWeightData > List of skin weights Dataflow/DataflowCollectionEditSkinWeightsNode.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Use VertexSkinWeights instead")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page