1. Epic GamesDeveloper
  3. FDynamicMeshAttributeSet

FDynamicMeshAttributeSet

[FDynamicMeshAttributeSet](API\Runtime\GeometryCore\DynamicMesh\FDynamicMeshAttributeSet) manages a set of extended attributes for a [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3).

API > API/Runtime > API/Runtime/GeometryCore > API/Runtime/GeometryCore/DynamicMesh

Inheritance Hierarchy

References

   
Module GeometryCore
Header /Engine/Source/Runtime/GeometryCore/Public/DynamicMesh/DynamicMeshAttributeSet.h
Include #include "DynamicMesh/DynamicMeshAttributeSet.h"

Syntax

class FDynamicMeshAttributeSet : public UE::Geometry::TDynamicAttributeSetBase< FDynamicMesh3 >

Remarks

FDynamicMeshAttributeSet manages a set of extended attributes for a FDynamicMesh3. This includes UV and Normal overlays, etc.

Currently the default is to always have one UV layer and one Normal layer, but the number of layers can be requested on construction.

Variables

  Type Name Description
Protected variable TUniquePtr< FDynamicMeshBoneColorAttribute > BoneColorAttrib  
Protected variable TUniquePtr< FDynamicMeshBoneNameAttribute > BoneNameAttrib Bone attributes.
Protected variable TUniquePtr< FDynamicMeshBoneParentIndexAttribute > BoneParentIndexAttrib  
Protected variable TUniquePtr< FDynamicMeshBonePoseAttribute > BonePoseAttrib  
Protected variable TUniquePtr< FDynamicMeshColorOverlay > ColorLayer  
Protected variable GenericAttributesMap GenericAttributes  
Protected variable TUniquePtr< FDynamicMeshMaterialAttribute > MaterialIDAttrib  
Protected variable TIndirectArray< FDynamicMeshNormalOverlay > NormalLayers  
Protected variable FDynamicMesh3 * ParentMesh Parent mesh of this attribute set
Protected variable TIndirectArray< FDynamicMeshPolygroupAttribute > PolygroupLayers  
Protected variable SkinWeightAttributesMap SkinWeightAttributes  
Protected variable TIndirectArray< FDynamicMeshUVOverlay > UVLayers  
Protected variable TIndirectArray< FDynamicMeshWeightAttribute > WeightLayers  

Constructors

  Type Name Description
Public function    
Public function  

FDynamicMeshAttributeSet ( FDynamicMesh3* Mesh,
int32 NumUVLayers,
int32 NumNormalLayers
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function bool Append bone attributes from another set.
Public function void

AttachAttribute ( FName AttribName,
FDynamicMeshAttributeBase* Attribute
)

 Attach a new attribute (and transfer ownership of it to the attribute set)
Public function void Skin weights Create a new skin weights attribute with a given skin weights profile name.
Public function Const bool The attribute is valid if either all attributes are empty or if the bone name attribute is not empty then all the other attributes must be either empty or their size is equal to the bone name attribute size.
Public function void

CompactCopy ( const FCompactMaps& CompactMaps,
const FDynamicMeshAttributeSet& Copy
)

 Performs a CompactCopy of the attached overlays/attributes.
Public function void

CompactInPlace ( const FCompactMaps& CompactMaps
)

 Compacts the attribute set in place Called by the parent mesh CompactInPlace function
Public function void

Copy ( const FDynamicMeshAttributeSet& Copy
)

  
Public function void Bone Attributes
Public function void Disable all bone attributes.
Public function void  
Public function void  
Public function void Disable Tangents overlays
Public function void

EnableBones ( const int InBonesNum
)

 Enable all bone attributes and intialize their size to the given bone number.
Public function void

EnableMatchingAttributes ( const FDynamicMeshAttributeSet& ToMatch,
bool bClearExisting,
bool bDiscardExtraAttributes
)

 Enable the matching attributes and overlay layers as the ToMatch set, but do not copy any data across.
Public function void

EnableMatchingBoneAttributes ( const FDynamicMeshAttributeSet& ToMatch,
bool bClearExisting,
bool bDiscardExtraAttributes
)

  
Public function void  
Public function void  
Public function void Enable Tangents overlays (Tangent = Normal layer 1, Bitangent = Normal layer 2)
Public function FDynamicMeshAttributeBase *

GetAttachedAttribute ( FName AttribName
)

  
Public function Const const FDynamicMeshAttributeBase *

GetAttachedAttribute ( FName AttribName
)

  
Public function Const const TMap< FName, TUniquePtr< FDynamicMeshAttributeBase > > &  
Public function FDynamicMeshBoneColorAttribute *  
Public function Const const FDynamicMeshBoneColorAttribute *  
Public function Const const FDynamicMeshBoneNameAttribute *  
Public function FDynamicMeshBoneNameAttribute *  
Public function FDynamicMeshBoneParentIndexAttribute *  
Public function Const const FDynamicMeshBoneParentIndexAttribute *  
Public function FDynamicMeshBonePoseAttribute *  
Public function Const const FDynamicMeshBonePoseAttribute *  
Public function FDynamicMeshMaterialAttribute *  
Public function Const const FDynamicMeshMaterialAttribute *  
Public function FDynamicMeshNormalOverlay *

GetNormalLayer ( int Index
)

  
Public function Const const FDynamicMeshNormalOverlay *

GetNormalLayer ( int Index
)

  
Public function Const int32 Get number of bones.
Public function Const const FDynamicMesh3 *  
Public function FDynamicMesh3 *  
Public function FDynamicMeshPolygroupAttribute *

GetPolygroupLayer ( int Index
)

  
Public function Const const FDynamicMeshPolygroupAttribute *

GetPolygroupLayer ( int Index
)

  
Public function Const FDynamicMeshVertexSkinWeightsAttribute *

GetSkinWeightsAttribute ( FName InProfileName
)

 Returns a pointer to a skin weight attribute of the given profile name.
Public function Const const TMap< FName, TUniquePtr< FDynamicMeshVertexSkinWeightsAttribute > > & Returns a map of all skin weight attributes.
Public function Const const FDynamicMeshUVOverlay *

GetUVLayer ( int Index
)

  
Public function FDynamicMeshUVOverlay *

GetUVLayer ( int Index
)

  
Public function Const const FDynamicMeshWeightAttribute *

GetWeightLayer ( int Index
)

  
Public function FDynamicMeshWeightAttribute *

GetWeightLayer ( int Index
)

  
Public function Const bool

HasAttachedAttribute ( FName AttribName
)

  
Public function Const bool  
Public function Const bool Per-Triangle Material ID
Public function Const bool  
Public function Const bool

HasSkinWeightsAttribute ( FName InProfileName
)

 Returns true if the list of skin weight attributes includes the given profile name.
Public function Const bool  
Protected function void

Initialize ( int MaxVertexID,
int MaxTriangleID
)

 Initialize the existing attribute layers with the given vertex and triangle sizes
Public function bool Returns true if the attached overlays/attributes are compact
Public function Virtual Const bool

IsMaterialBoundaryEdge ( int EdgeID
)

  
Public function Const bool

IsSameAs ( const FDynamicMeshAttributeSet& Other,
bool bIgnoreDataLayout
)

 Returns true if this AttributeSet is the same as Other.
Public function Const bool Only compares bone names and parent indices.
Public function Virtual Const bool

IsSeamEdge ( int EdgeID,
bool& bIsUVSeamOut,
bool& bIsNormalSeamOut,
bool& bIsColorSeamOut,
bool& bIsTangentSeamOut
)

  
Public function Virtual Const bool

IsSeamEdge ( int EdgeID
)

  
Public function Virtual Const bool

IsSeamEndEdge ( int EdgeID
)

  
Public function Virtual Const bool

IsSeamVertex ( int VertexID,
bool bBoundaryIsSeam
)

  
Public function Const int  
Public function Virtual Const int Normal Layers
Public function Virtual Const int32 Polygroup layers
Public function Virtual Const int UV Layers
Public function Virtual Const int32 Weight layers
Public function Const const FDynamicMeshNormalOverlay *  
Public function FDynamicMeshNormalOverlay *  
Public function Const const FDynamicMeshColorOverlay *  
Public function FDynamicMeshColorOverlay *  
Public function Const const FDynamicMeshNormalOverlay *  
Public function FDynamicMeshNormalOverlay *  
Public function Const const FDynamicMeshNormalOverlay *  
Public function FDynamicMeshNormalOverlay *  
Public function Const const FDynamicMeshUVOverlay *  
Public function FDynamicMeshUVOverlay *  
Public function void

RemoveAttribute ( FName AttribName
)

  
Public function void

RemoveSkinWeightsAttribute ( FName InProfileName
)

 Remove a skin weights attribute matching the given profile name.
Public function Virtual void

RemoveWeightLayer ( int32 Index
)

 Remove a weight layer at the specified index
Public function void

Serialize ( FArchive& Ar,
const FCompactMaps* CompactMaps,
bool bUseCompression
)

 Serialize to and from an archive.
Public function Virtual void

SetNumNormalLayers ( int Num
)

 Set number of Normals (3-vector float overlay) layers
Public function Virtual void

SetNumPolygroupLayers ( int32 Num
)

 Set the number of Polygroup layers
Public function Virtual void

SetNumUVLayers ( int Num
)

 Set number of UV (2-vector float overlay) layers
Public function Virtual void

SetNumWeightLayers ( int32 Num
)

 Set the number of weight layers
Public function void

SplitAllBowties ( bool bParallel
)

 Split all bowtie vertices in all layers

Overridden from TDynamicAttributeSetBase

  Type Name Description
Protected function Virtual Const bool

CheckValidity ( bool bAllowNonmanifold,
EValidityCheckFailMode FailMode
)

 Check validity of attributes
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void

OnNewTriangle ( int TriangleID,
bool bInserted
)

 These functions are called by the FDynamicMesh3 to update the various attributes when the parent mesh topology has been modified.
Protected function Virtual void

OnNewVertex ( int VertexID,
bool bInserted
)

  
Protected function Virtual void  
Protected function Virtual void

OnRemoveTriangle ( int TriangleID
)

  
Protected function Virtual void

OnRemoveVertex ( int VertexID
)

  
Protected function Virtual void

OnReverseTriOrientation ( int TriangleID
)

  
Protected function Virtual void Mesh-specific on* functions; may be split out
Protected function Virtual void

OnSplitVertex ( const DynamicMeshInfo::FVertexSplitInfo& SplitInfo,
const TArrayView< const int >& TrianglesToUpdate
)

  

Typedefs

Name Description
GenericAttributesMap  
SkinWeightAttributesMap  

Deprecated Functions

  Type Name Description
Public function Virtual Const bool

IsSeamEdge ( int EdgeID,
bool& bIsUVSeamOut,
bool& bIsNormalSeamOut,
bool& bIsColorSeamOut
)

 Please instead call the 4 argument version of IsSeamEdge, which distinguishes between tangent and normal seam edges.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page