1. Epic GamesDeveloper
  3. UGroomBindingAsset

UGroomBindingAsset

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

Unreal Engine C++ API Reference > Plugins > HairStrandsCore

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;BlueprintType, HideCategories&61;&40;Object&41;&41;  
class UGroomBindingAsset : public UObject

Remarks

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

Variables

  Type Name Description
Public variable bool bIsValid  
Public variable bool bRegisterGroomAssetCallback  
Public variable bool bRegisterSourceMeshCallback  
Public variable bool bRegisterTargetMeshCallback  
Public variable TArray< FString > CachedDerivedDataKey  
Public variable FOnGroomBindingAssetChanged OnGroomBindingAssetChanged Private :
Public variable EQueryStatus QueryStatus  

Functions

  Type Name Description
Public function void  
Public function void

Build ()

 Build/rebuild a binding asset
Public function void  
Public function void

CacheDerivedDatas ( uint32 InGroupIndex,
const FString KeySuffix,
bool& bOutValid,
bool& bOutReloadResource
)

  
Public function FName

GetAssetPathName ( int32 LODIndex
)

 Helper function to return the asset path name, optionally joined with the LOD index if LODIndex > -1.
Public function Static FName  
Public function Static FName  
Public function TArray< FGoomBindingGroupInfo > &  
Public function Static FName  
Public function Static FName  
Public function Const const FHairGroupResources &  
Public function FHairGroupResources &  
Public function Static FName  
Public function Const const TArray< FHairGroupPlatformData > &  
Public function TArray< FHairGroupPlatformData > &  
Public function Static FName  
Public function Static FName  
Public function FOnGroomBindingAssetChanged &  
Public function Static FName  
Public function Static FName  
Public function Static FName  
Public function Static FName  
Public function Const bool Returns true if the target is not null and matches the binding type
Public function void Initialize resources.
Public function void  
Public function void  
Public function Static bool

IsBindingAssetValid ( const UGroomBindingAsset* InBinding,
bool bIsBindingReloading,
bool bIssueWarning
)

  
Public function Static bool

IsCompatible ( const UGeometryCache* InGeometryCache,
const UGroomBindingAsset* InBinding,
bool bIssueWarning
)

  
Public function Static bool

IsCompatible ( const USkeletalMesh* InSkeletalMesh,
const UGroomBindingAsset* InBinding,
bool bIssueWarning
)

  
Public function Static bool

IsCompatible ( const UGroomAsset* InGroom,
const UGroomBindingAsset* InBinding,
bool bIssueWarning
)

  
Public function Const bool

IsValid ()

 Return true if the binding asset is valid, i.e., correctly built and loaded.
Public function void Release the hair strands resource.
Public function bool  
Public function void

Reset ()

  
Public function void

SetHairGroupResources ( FHairGroupResources InHairGroupResources
)

  
Public function void Update resources.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

 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).
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Part of UObject interface
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Called from within SavePackage on the passed in base/root object.
Public function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

 Presave function.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Classes

  Type Name Description
Public struct FHairGroupPlatformData Binding bulk data  
Public struct FHairGroupResource GPU and CPU binding data for both simulation and rendering.  

Enums

  Type Name Description
Public enum EQueryStatus    

Typedefs

Name Description
FHairGroupResources  
FOnGroomBindingAssetChanged Notification when anything changed

Deprecated Functions

  Type Name Description
Public function Virtual void

PostSaveRoot ( bool bCleanupIsRequired
)

 Use version that takes FObjectPostSaveRootContext instead.
Public function Virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid

PreSave ( const ITargetPlatform* TargetPlatform
)

 Use version that takes FObjectPreSaveContext instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page