Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > HairStrandsCore > UGroomBindingAsset

Light Theme

Dark Theme

UGroomBindingAsset

Implements an asset that can be used to store binding information between a groom and a skeletal mesh

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UGroomBindingAsset

References

Module	HairStrandsCore
Header	/Engine/Plugins/Runtime/HairStrands/Source/HairStrandsCore/Public/GroomBindingAsset.h
Include	#include "GroomBindingAsset.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, HideCategories=(Object))
class UGroomBindingAsset : public UObject

Remarks

Implements an asset that can be used to store binding information between a groom and a skeletal mesh

Variables

	Name	Description
bool	bIsValid
bool	bRegisterGroomAssetCallback
bool	bRegisterSourceMeshCallback
bool	bRegisterTargetMeshCallback
FString	CachedDerivedDataKey
UGroomAsset ...	Groom	Groom to bind.
EGroomBindingMe...	GroomBindingType	Type of mesh to create groom binding for
TArray< FGoomBi...	GroupInfos
FHairGroupDatas	HairGroupDatas
FHairGroupResou...	HairGroupResources
TQueue< FHairGr...	HairGroupResourcesToDelete	Queue of resources which needs to be deleted.
int32	MatchingSection	Number of points used for the rbf interpolation
int32	NumInterpolationPoints	Number of points used for the rbf interpolation
FOnGroomBinding...	OnGroomBindingAssetChanged	Private :
EQueryStatus	QueryStatus
UGeometryCache ...	SourceGeometryCache
USkeletalMesh &...	SourceSkeletalMesh	Skeletal mesh on which the groom has been authored.
UGeometryCache ...	TargetGeometryCache
USkeletalMesh &...	TargetSkeletalMesh	Skeletal mesh on which the groom is attached to.

Functions

	Name	Description
void	Build()	Build/rebuild a binding asset
void	CacheDerivedDatas()
FOnGroomBind...	GetOnGroomBindingAssetChanged()
bool	HasValidTarget()	Returns true if the target is not null and matches the binding type
void	InitResource()	Initialize resources.
void	InvalidateBinding ( USkeletalMesh* )
void	InvalidateBinding()
bool	IsBindingAssetValid ( const UGroomBindingAsset* InBi..., bool bIsBindingReloading, bool bIssueWarning )
bool	IsCompatible ( const USkeletalMesh* InSkeleta..., const UGroomBindingAsset* InBi..., bool bIssueWarning )
bool	IsCompatible ( const UGroomAsset* InGroom, const UGroomBindingAsset* InBi..., bool bIssueWarning )
bool	IsCompatible ( const UGeometryCache* InGeomet..., const UGroomBindingAsset* InBi..., bool bIssueWarning )
bool	IsValid()	Return true if the binding asset is valid, i.e., correctly built and loaded.
void	ReleaseResource()	Release the hair strands resource.
void	Reset()
void	UpdateResource()	Update resources.

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	GetResourceSizeEx ( FResourceSizeEx& CumulativeResourc... )	Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Part of UObject interface
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PostSaveRoot ( bool bCleanupIsRequired )	Called from within SavePackage on the passed in base/root object.
void	PreSave ( const ITargetPlatform* TargetP... )	Presave function.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Classes

	Name	Description
	FHairGroupData
	FHairGroupResource	GPU and CPU binding data for both simulation and rendering.

Enums

	Name	Description
	EQueryStatus

Typedefs

Name	Description
FHairGroupDatas
FHairGroupResources
FOnGroomBindingAssetChanged	Notification when anything changed

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss