1. Epic GamesDeveloper
  3. UGroomAsset

UGroomAsset

Implements an asset that can be used to store hair strands

API > API/Plugins > API/Plugins/HairStrandsCore

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;BlueprintType, AutoExpandCategories&61;&40;"HairRendering", "HairPhysics", "HairInterpolation"&41;,  
       HideCategories&61;&40;Object, "Hidden"&41;&41;  
class UGroomAsset :  
    public UObject,  
    public IInterface_AssetUserData

Remarks

Implements an asset that can be used to store hair strands

Variables

  Type Name Description
Public variable UProperty Category instanced, visibleanywhere TObjectPtr< class UAssetImportData > AssetImportData Asset data to be used when re-importing
Public variable UProperty Category, EditAnywhere, AdvancedDisplay instanced TArray< TObjectPtr< UAssetUserData > > AssetUserData Array of user data stored with the asset
Public variable FOnGroomAssetChanged OnGroomAssetChanged Private :
Public variable FOnGroomAssetResourcesChanged OnGroomAssetResourcesChanged  
Public variable FOnGroomAsyncLoadFinished OnGroomAsyncLoadFinished  

Constructors

  Type Name Description
Public function  

UGroomAsset ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const bool  
Public function bool  
Public function bool  
Public function bool

CacheCardsData ( uint32 GroupIndex,
const FString& StrandsKey
)

  
Public function bool

CacheDerivedData ( uint32 GroupIndex
)

 Caches the computed (group) groom data with the given build settings from/to the Derived Data Cache, building it if needed.
Public function bool Caches the computed (group) groom data with the given build settings from/to the Derived Data Cache, building it if needed.
Public function bool

CacheMeshesData ( uint32 GroupIndex
)

  
Public function bool

CacheStrandsData ( uint32 GroupIndex,
FString& OutDerivedDataKey
)

  
Public function Const bool Returns true if the asset has the HairDescription needed to recompute its groom data
Public function TArray< FHairVertexFactoryTypesPerMaterialData >

CollectVertexFactoryTypesPerMaterialData ( EShaderPlatform ShaderPlatform
)

 Used for PSO precaching of used materials and vertex factories
Public function void Commits a HairDescription to buffer for serialization
Public function void  
Public function uint8  
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 Const EGroomBindingType

GetBindingType ( int32 GroupIndex,
int32 LODIndex
)

  
Public function Const const TArray< int32 > &  
Public function Static FName  
Public function FString

GetDerivedDataKey ( bool bUseCacheKey
)

  
Public function FString

GetDerivedDataKeyForCards ( uint32 GroupIt,
const FString& StrandsKey
)

  
Public function FString

GetDerivedDataKeyForMeshes ( uint32 GroupIndex
)

  
Public function FString

GetDerivedDataKeyForStrands ( uint32 GroupIndex
)

  
Public function Const FPerPlatformBool  
Public function Static FName  
Public function TArray< float > &  
Public function Const const TArray< float > &  
Public function Static FName  
Public function Static FName  
Public function Static FName  
Public function Const EGroomGeometryType

GetGeometryType ( int32 GroupIndex,
int32 LODIndex
)

  
Public function bool

GetHairCardsGuidesDatas ( const int32 GroupIndex,
const int32 LODIndex,
FHairStrandsDatas& OutCardsGuidesData
)

  
Public function Const FHairDescription  
Public function const FHairDescriptionGroups &  
Public function Const const TArray< FHairGroupsCardsSourceDescription > &  
Public function Static FName  
Public function TArray< FHairGroupInfoWithVisibility > &  
Public function Const const TArray< FHairGroupInfoWithVisibility > &  
Public function Static FName  
Public function Const const TArray< FHairGroupsInterpolation > &  
Public function Static FName  
Public function Const const TArray< FHairGroupsLOD > &  
Public function Static FName  
Public function Const const TArray< FHairGroupsMaterial > &  
Public function Static FName  
Public function Const const TArray< FHairGroupsMeshesSourceDescription > &  
Public function Static FName  
Public function Const const TArray< FHairGroupsPhysics > &  
Public function Static FName  
Public function TArray< FHairGroupPlatformData > &  
Public function Const const TArray< FHairGroupPlatformData > &  
Public function Static FName  
Public function Const const TArray< FHairGroupsRendering > &  
Public function Static FName  
Public function Static FName  
Public function bool

GetHairStrandsDatas ( const int32 GroupIndex,
FHairStrandsDatas& OutStrandsData,
FHairStrandsDatas& OutGuidesData
)

 Get/Build render & guides data based on the hair description and interpolation settings
Public function Const int32  
Public function Const int32

GetMaterialIndex ( FName MaterialSlotName
)

 Return the material slot index corresponding to the material name
Public function Const TArray< FName >  
Public function Const FPerPlatformInt  
Public function Static FName  
Public function Const int32  
Public function FOnGroomAssetChanged &  
Public function FOnGroomAssetResourcesChanged &  
Public function FOnGroomAsyncLoadFinished &  
Public function Static FName  
Public function Const bool Debug data for derived asset generation (strands textures, ...).
Public function Const bool  
Public function Const bool

HasGeometryType ( uint32 GroupIndex,
EGroomGeometryType Type
)

  
Public function void  
Public function void  
Public function void  
Public function void Initialize/Update/Release resources.
Public function void  
Public function Const bool

IsDeformationEnable ( int32 GroupIndex
)

  
Public function Const bool

IsGlobalInterpolationEnable ( int32 GroupIndex,
int32 LODIndex
)

  
Public function Const bool

IsMaterialSlotNameValid ( FName MaterialSlotName
)

  
Public function Const bool

IsMaterialUsed ( int32 MaterialIndex
)

  
Public function Const bool

IsSimulationEnable ( int32 GroupIndex,
int32 LODIndex
)

  
Public function Const bool  
Public function Const bool

IsValid ()

  
Public function Const bool

IsVisible ( int32 GroupIndex,
int32 LODIndex
)

  
Public function void  
Public function Const bool

NeedsInterpolationData ( int32 GroupIndex
)

  
Public function Const bool  
Public function void

ReleaseCardsResource ( uint32 GroupIndex
)

  
Public function void

ReleaseGuidesResource ( uint32 GroupIndex
)

  
Public function void

ReleaseMeshesResource ( uint32 GroupIndex
)

  
Public function void  
Public function void

ReleaseStrandsResource ( uint32 GroupIndex
)

  
Public function void

SaveProceduralCards ( uint32 CardsGroupIndex
)

 Save out a static mesh based on generated cards.
Public function void  
Public function void

SetEffectiveLODBias ( const TArray< float >& In
)

  
Public function void  
Public function void  
Public function void

SetHairWidth ( float Width
)

  
Public function void  
Public function void

SetNumGroup ( uint32 InGroupCount,
bool bResetGroupData,
bool bResetOtherData
)

  
Public function void

SetScatterSceneLighting ( bool Enable
)

  
Public function void

SetStableRasterization ( bool bEnable
)

 Helper functions for setting options on all hair groups.
Public function void

StripLODs ( const TArray< int32 >& LODsToKeep,
bool bRebuildResources
)

  
Public function void  
Public function void  
Public function void  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual Const void Retrievde the asset tags
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 Part of Uobject interface
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

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

Overridden from IInterface_AssetUserData

  Type Name Description
Public function Virtual void  
Public function Virtual Const const TArray< UAssetUserData * > *  
Public function Virtual UAssetUserData *  
Public function Virtual void  

Enums

  Type Name Description
Public enum EClassDataStripFlag    
Public enum EHairDescriptionType    

Typedefs

Name Description
FOnGroomAssetChanged Notification when anything changed
FOnGroomAssetResourcesChanged  
FOnGroomAsyncLoadFinished  

Deprecated Variables

  Type Name Description
Public variable UProperty TArray< int32 > DeformedGroupSections Please do not access this member directly; use UGroomAsset accessor.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay FPerPlatformBool DisableBelowMinLodStripping Please do not access this member directly; use UGroomAsset accessor.
Public variable UProperty TArray< float > EffectiveLODBias Please do not access this member directly; use UGroomAsset accessor.
Public variable UProperty Category, EditAnywhere, Meta blueprintgetter, blueprintsetter, editfixedsize bool EnableGlobalInterpolation Please do not access this member directly; use UGroomAsset accessor.
Public variable UProperty Category, EditAnywhere, Meta blueprintgetter, blueprintsetter, editfixedsize bool EnableSimulationCache Please do not access this member directly; use UGroomAsset accessor.
Public variable UProperty Category, EditAnywhere, Meta blueprintgetter, blueprintsetter TArray< FHairGroupsCardsSourceDescription > HairGroupsCards Please do not access this member directly; use UGroomAsset accessor.
Public variable UProperty Category, EditAnywhere, Meta Transient editfixedsize TArray< FHairGroupInfoWithVisibility > HairGroupsInfo Please do not access this member directly; use UGroomAsset accessor.
Public variable UProperty Category, EditAnywhere, Meta blueprintgetter, blueprintsetter, editfixedsize TArray< FHairGroupsInterpolation > HairGroupsInterpolation Please do not access this member directly; use UGroomAsset accessor.
Public variable UProperty Category, EditAnywhere, Meta blueprintgetter, blueprintsetter, editfixedsize TArray< FHairGroupsLOD > HairGroupsLOD Please do not access this member directly; use UGroomAsset accessor.
Public variable UProperty Category, EditAnywhere, Meta blueprintgetter, blueprintsetter TArray< FHairGroupsMaterial > HairGroupsMaterials Please do not access this member directly; use UGroomAsset accessor.
Public variable UProperty Category, EditAnywhere, Meta blueprintgetter, blueprintsetter TArray< FHairGroupsMeshesSourceDescription > HairGroupsMeshes Please do not access this member directly; use UGroomAsset accessor.
Public variable UProperty Category, EditAnywhere, Meta blueprintgetter, blueprintsetter, editfixedsize TArray< FHairGroupsPhysics > HairGroupsPhysics Please do not access this member directly; use UGroomAsset accessor.
Public variable TArray< FHairGroupPlatformData > HairGroupsPlatformData Please do not access this member directly; use UGroomAsset accessor.
Public variable UProperty Category, EditAnywhere, Meta blueprintgetter, blueprintsetter, editfixedsize TArray< FHairGroupsRendering > HairGroupsRendering Please do not access this member directly; use UGroomAsset accessor.
Public variable UProperty Category, EditAnywhere, Meta blueprintgetter, blueprintsetter, editfixedsize EGroomInterpolationType HairInterpolationType Please do not access this member directly; use UGroomAsset accessor.
Public variable UProperty Category, EditAnywhere, Meta FPerPlatformInt MinLOD Please do not access this member directly; use UGroomAsset accessor.
Public variable UProperty Category blueprintgetter, blueprintsetter, visibleanywhere TObjectPtr< USkeletalMesh > RiggedSkeletalMesh Please do not access this member directly; use UGroomAsset accessor.

Deprecated Functions

  Type Name Description
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