1. Epic GamesDeveloper
  3. UGroomComponent

UGroomComponent

API > API/Plugins > API/Plugins/HairStrandsCore

   
Name UGroomComponent
Type class
Header File /Engine/Plugins/Runtime/HairStrands/Source/HairStrandsCore/Public/GroomComponent.h
Include Path #include "GroomComponent.h"

Syntax

UCLASS (HideCategories=(Object, Physics, Activation, Mobility, "Components|Activation"),  
       EditInlineNew, Meta=(BlueprintSpawnableComponent), ClassGroup=Rendering, MinimalAPI)  
class UGroomComponent :  
    public UMeshComponent ,  
    public ILODSyncInterface ,  
    public INiagaraPhysicsAssetDICollectorInterface

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UGroomComponent ( const FObjectInitializer& ObjectInitializer
)

   GroomComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AngularSpringsSystem TObjectPtr< class UNiagaraSystem >   GroomComponent.h  
AttachmentName FString Optional socket name, where the groom component should be attached at, when parented with a skeletal mesh GroomComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Interp
  • Category="Groom"
BindingAsset TObjectPtr< class UGroomBindingAsset > Optional binding asset for binding a groom onto a skeletal mesh. GroomComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Groom"
bInitSimulation bool Boolean to check when the simulation should be initialized GroomComponent.h  
bResetSimulation bool Boolean to check when the simulation should be reset GroomComponent.h  
bUseCards bool Force the groom to use cards/meshes geometry instead of strands. GroomComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Groom"
Cards_DefaultMaterial TObjectPtr< UMaterialInterface >   GroomComponent.h  
CollisionComponents TArray< TWeakObjectPtr< class USkeletalMeshComponent > > List of collision components to be used GroomComponent.h  
CosseratRodsSystem TObjectPtr< class UNiagaraSystem >   GroomComponent.h  
GroomAsset TObjectPtr< UGroomAsset > Groom asset . GroomComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Groom"
GroomCache TObjectPtr< UGroomCache >   GroomComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="GroomCache"
GroomGroupsDesc TArray< FHairGroupDesc > Groom's groups info. GroomComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Groom"
MeshDeformer TObjectPtr< UMeshDeformer > If set the MeshDeformer will be applied on groom instance for deformation. GroomComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Deformer"
  • Meta=(ToolTip="Mesh deformer that will be applied on groom instance for deformation. Enable the groom asset deformation flags on groups to be able to set it.")
MeshDeformerInstance TObjectPtr< UMeshDeformerInstance > Object containing state for the bound MeshDeformer. GroomComponent.h
  • Transient
  • BlueprintReadOnly
  • Category="Deformer"
MeshDeformerInstanceSettings TObjectPtr< UMeshDeformerInstanceSettings > Object containing instance settings for the bound MeshDeformer. GroomComponent.h
  • VisibleAnywhere
  • BlueprintReadOnly
  • Instanced
  • Category="Deformer"
  • Meta=(DisplayName="Deformer Settings", EditCondition="MeshDeformerInstanceSettings!=nullptr", ShowOnlyInnerProperties)
Meshes_DefaultMaterial TObjectPtr< UMaterialInterface >   GroomComponent.h  
NiagaraComponents TArray< TObjectPtr< class UNiagaraComponent > > Niagara components that will be attached to the system GroomComponent.h
  • Transient
PhysicsAsset TObjectPtr< class UPhysicsAsset > Physics asset to be used for hair simulation GroomComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Simulation"
PrevBoneMatrix FMatrix Previous bone matrix to compare the difference and decide to reset or not the simulation GroomComponent.h  
SimulationSettings FHairSimulationSettings Groom's simulation settings GroomComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Simulation"
SourceSkeletalMesh TObjectPtr< class USkeletalMesh > Kept for debugging mesh transfer. GroomComponent.h  
Strands_DebugMaterial TObjectPtr< UMaterialInterface > Reference of the default/debug materials for each geometric representation GroomComponent.h  
Strands_DefaultMaterial TObjectPtr< UMaterialInterface >   GroomComponent.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
BindingAssetBeingLoaded TObjectPtr< UGroomBindingAsset >   GroomComponent.h
  • Transient
bIsGroomAssetCallbackRegistered bool   GroomComponent.h  
bIsGroomBindingAssetCallbackRegistered bool   GroomComponent.h  
bLooping bool   GroomComponent.h
  • EditAnywhere
  • Category=GroomCache
bManualTick bool   GroomComponent.h
  • EditAnywhere
  • Category=GroomCache
bPreviewMode bool   GroomComponent.h  
bRunning bool   GroomComponent.h
  • EditAnywhere
  • Category=GroomCache
bValidationEnable bool   GroomComponent.h  
DeformedMeshComponent UMeshComponent *   GroomComponent.h  
ElapsedTime float   GroomComponent.h
  • VisibleAnywhere
  • Transient
  • Category=GroomCache
GroomAssetBeingLoaded TObjectPtr< UGroomAsset >   GroomComponent.h
  • Transient
GroomCacheBuffers TSharedPtr< class IGroomCacheBuffers, ESPMode::ThreadSafe >   GroomComponent.h  
GroomSolver TSoftObjectPtr< UMeshComponent > Groom solver pointer GroomComponent.h  
HairGroupInstances TArray< TRefCountPtr< FHairGroupInstance > >   GroomComponent.h  
InitializedResources void *   GroomComponent.h  
LODForcedIndex float   GroomComponent.h  
LODPredictedIndex float   GroomComponent.h  
LODSelectionType EHairLODSelectionType LOD selection. GroomComponent.h  
RegisteredMeshComponent UMeshComponent *   GroomComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddCollisionComponent ( USkeletalMeshComponent* SkeletalMeshComponent
)

 Add a skeletal mesh to the collision components GroomComponent.h
  • BlueprintCallable
  • Category="Simulation"

virtual UPhysicsAsset * BuildAndCollect ( FTransform& BoneTransform,
TArray< TWeakObjectPtr< USkeletalMeshComponent > >& SourceComponents,
TArray< TWeakObjectPtr< UPhysicsAsset > >& PhysicsAssets
) const

   GroomComponent.h  

void BuildSimulationTransform ( FTransform& SimulationTransform
) const

 Build the local simulation transform that could be used in strands simulation GroomComponent.h  

bool ContainsGroupInstance ( FHairGroupInstance* Instance
) const

   GroomComponent.h  

void CreateHairSimulation ( const int32 GroupIndex,
const int32 LODIndex
)

 Create per Group/LOD the Niagara component GroomComponent.h  

float GetAnimationTime()

   GroomComponent.h  

virtual int32 GetBestAvailableLOD()

   GroomComponent.h  

virtual int32 GetDesiredSyncLOD()

 ~ Begin ILODSyncInterface Interface. GroomComponent.h  

int32 GetForcedLOD()

   GroomComponent.h  

virtual int32 GetForceRenderedLOD()

   GroomComponent.h  

virtual int32 GetForceStreamedLOD()

   GroomComponent.h  

UGroomCache * GetGroomCache()

 GroomCache GroomComponent.h  

float GetGroomCacheDuration()

   GroomComponent.h  

UMeshComponent * GetGroomSolver()

 Get the groom solver from the component GroomComponent.h  

uint32 GetGroupCount()

 Hair group instance access GroomComponent.h  

const FHairGroupInstance * GetGroupInstance ( int32 Index
) const

   GroomComponent.h  
  GroomComponent.h  

FHairStrandsDeformedResource * GetGuideStrandsDeformedResource ( uint32 GroupIndex
)

 Return the guide hairs deformed resources GroomComponent.h  

FHairStrandsDeformedRootResource * GetGuideStrandsDeformedRootResource ( uint32 GroupIndex
)

   GroomComponent.h  

FHairStrandsRestResource * GetGuideStrandsRestResource ( uint32 GroupIndex
)

 Return the guide hairs rest resources GroomComponent.h  

FHairStrandsRestRootResource * GetGuideStrandsRestRootResource ( uint32 GroupIndex
)

 Return the guide hairs root resources GroomComponent.h  

bool GetIsHairLengthScaleEnabled()

   GroomComponent.h
  • BlueprintCallable
  • Category="Groom"

bool GetManualTick()

   GroomComponent.h  

UMaterialInterface * GetMaterial ( int32 ElementIndex,
EHairGeometryType GeometryType,
bool bUseDefaultIfIncompatible
) const

   GroomComponent.h  

EHairGeometryType GetMaterialGeometryType ( int32 ElementIndex
) const

   GroomComponent.h  

UNiagaraComponent * GetNiagaraComponent ( const int32 GroupIndex
)

 Given the group index return the matching niagara component GroomComponent.h
  • BlueprintCallable
  • Category="Simulation"

int32 GetNumLODs()

   GroomComponent.h  

virtual int32 GetNumSyncLODs()

   GroomComponent.h  

uint32 GetResourcesSize()

   GroomComponent.h  

void HandleFeatureLevelChanged ( ERHIFeatureLevel::Type InFeatureLevel
)

   GroomComponent.h  

void HandlePlatformPreviewChanged ( ERHIFeatureLevel::Type InFeatureLevel
)

   GroomComponent.h  

void Invalidate()

   GroomComponent.h  

void InvalidateAndRecreate()

   GroomComponent.h  

bool IsDeformationEnable ( int32 GroupIndex
) const

 Check if the deformation is enabled or not (from the rigged guides or from the solver deformer) GroomComponent.h  

bool IsLooping()

   GroomComponent.h  

bool IsSimulationEnable ( int32 GroupIndex,
int32 LODIndex
) const

 Check if the simulation is enabled or not GroomComponent.h  

void PostCompilation()

   GroomComponent.h  
Release Niagara components GroomComponent.h  

void ReleaseHairSimulation ( const int32 GroupIndex
)

   GroomComponent.h  

void ResetAnimationTime()

   GroomComponent.h  

void ResetCollisionComponents()

 Reset the collision components GroomComponent.h
  • BlueprintCallable
  • Category="Simulation"

void ResetSimulation()

 Reset the simulation, if enabled GroomComponent.h
  • BlueprintCallable
  • Category="Simulation"

void SetBinding ( UGroomBindingAsset* InBinding
)

   GroomComponent.h  

void SetBindingAsset ( UGroomBindingAsset* InBinding
)

 Accessor function for changing Groom binding asset from blueprint/sequencer GroomComponent.h
  • BlueprintCallable
  • Category="Groom"

void SetEnableSimulation ( bool bInEnableSimulation
)

 Accessor function for changing the enable simulation flag from blueprint/sequencer GroomComponent.h
  • BlueprintCallable
  • Category="Simulation"

void SetForcedLOD ( int32 LODIndex
)

   GroomComponent.h  

virtual void SetForceRenderedLOD ( int32 LODIndex
)

   GroomComponent.h  

virtual void SetForceStreamedLOD ( int32 LODIndex
)

   GroomComponent.h  

void SetGroomAsset ( UGroomAsset* Asset
)

 Accessor function for changing Groom asset from blueprint/sequencer GroomComponent.h
  • BlueprintCallable
  • Category="Groom"

void SetGroomAsset ( UGroomAsset* Asset,
UGroomBindingAsset* InBinding,
const bool bUpdateSimulation
)

   GroomComponent.h  

void SetGroomCache ( UGroomCache* InGroomCache
)

 Accessor function for changing GroomCache asset from blueprint/sequencer GroomComponent.h
  • BlueprintCallable
  • Category="Groom"

void SetGroomSolver ( UMeshComponent* InGroomSolver
)

 Set the groom solver onto the component GroomComponent.h  

void SetHairLengthScale ( float Scale
)

 Accessor function for changing hair length scale from blueprint/sequencer GroomComponent.h
  • BlueprintCallable
  • Category="Groom"

void SetHairLengthScaleEnable ( bool bEnable
)

   GroomComponent.h
  • BlueprintCallable
  • Category="Groom"

void SetHairRootScale ( float Scale
)

   GroomComponent.h  

void SetHairWidth ( float HairWidth
)

   GroomComponent.h  

void SetManualTick ( bool bInManualTick
)

   GroomComponent.h  

void SetMeshDeformer ( UMeshDeformer* InMeshDeformer
)

 Change the MeshDeformer that is used for this Component. GroomComponent.h
  • BlueprintCallable
  • Category="Components|SkinnedMesh"

void SetPhysicsAsset ( UPhysicsAsset* InPhysicsAsset
)

 Accessor function for changing Groom physics asset from blueprint/sequencer GroomComponent.h
  • BlueprintCallable
  • Category="Simulation"

void SetPreviewMode ( bool bValue
)

 Set the component in preview mode, forcing the loading of certain data. GroomComponent.h  

void SetScatterSceneLighting ( bool Enable
)

   GroomComponent.h  

void SetStableRasterization ( bool bEnable
)

   GroomComponent.h  

void SetUseCards ( bool InbUseCards
)

   GroomComponent.h  

void SetValidation ( bool bEnable
)

   GroomComponent.h  

void SwitchSimulationLOD ( const int32 PreviousLOD,
const int32 CurrentLOD,
const EHairLODSelectionType InLODSelectionType
)

 Enable/Disable hair simulation while transitioning from one LOD to another one GroomComponent.h  

void TickAtThisTime ( const float Time,
bool bInIsRunning,
bool bInBackwards,
bool bInIsLooping
)

   GroomComponent.h  

void UpdateHairGroupsDesc()

 Update Group Description GroomComponent.h  

void UpdateHairGroupsDescAndInvalidateRenderState ( bool bInvalidate
)

   GroomComponent.h  

void UpdateHairSimulation()

 Update Niagara components GroomComponent.h  

void UpdateSimulatedGroups()

 Update simulated groups GroomComponent.h  

void ValidateMaterials ( bool bMapCheck
) const

   GroomComponent.h  

Overridden from UPrimitiveComponent

Name Remarks Include Path Unreal Specifiers

virtual void CollectPSOPrecacheData ( const FPSOPrecacheParams& BasePrecachePSOParams,
FMaterialInterfacePSOPrecacheParamsList& OutParams
)

   GroomComponent.h  

virtual FPrimitiveSceneProxy * CreateSceneProxy()

   GroomComponent.h  

virtual UMaterialInterface * GetMaterial ( int32 ElementIndex
) const

   GroomComponent.h  

virtual int32 GetMaterialIndex ( FName MaterialSlotName
) const

   GroomComponent.h  

virtual TArray< FName > GetMaterialSlotNames()

   GroomComponent.h  

virtual int32 GetNumMaterials()

   GroomComponent.h  

virtual void GetUsedMaterials ( TArray< UMaterialInterface* >& OutMaterials,
bool bGetDebugMaterials
) const

   GroomComponent.h  

virtual bool IsMaterialSlotNameValid ( FName MaterialSlotName
) const

   GroomComponent.h  

Overridden from USceneComponent

Name Remarks Include Path Unreal Specifiers

virtual FBoxSphereBounds CalcBounds ( const FTransform& LocalToWorld
) const

   GroomComponent.h  

virtual void DetachFromComponent ( const FDetachmentTransformRules& DetachmentRules
)

   GroomComponent.h  

virtual void OnAttachmentChanged()

   GroomComponent.h  

virtual void PreFeatureLevelChange ( ERHIFeatureLevel::Type PendingFeatureLevel
)

   GroomComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void CheckForErrors()

   GroomComponent.h  

virtual void CreateRenderState_Concurrent ( FRegisterComponentContext* Context
)

   GroomComponent.h  

virtual void DestroyRenderState_Concurrent()

   GroomComponent.h  

virtual void OnComponentDestroyed ( bool bDestroyingHierarchy
)

   GroomComponent.h  

virtual void OnRegister()

   GroomComponent.h  

virtual void OnUnregister()

   GroomComponent.h  

virtual bool RequiresGameThreadEndOfFrameRecreate()

   GroomComponent.h  

virtual void SendRenderDynamicData_Concurrent()

   GroomComponent.h  

virtual void TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

   GroomComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   GroomComponent.h  

virtual bool CanEditChange ( const FProperty* InProperty
) const

   GroomComponent.h  

virtual void FinishDestroy()

   GroomComponent.h  

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

   GroomComponent.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   GroomComponent.h  

virtual void PostLoad()

   GroomComponent.h  

virtual void PreEditChange ( FProperty* PropertyAboutToChange
)

   GroomComponent.h  

Overridden from IInterface_AsyncCompilation

Name Remarks Include Path Unreal Specifiers

virtual bool IsCompiling()

   GroomComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page