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 > UGroomComponent

Light Theme

Dark Theme

UGroomComponent

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

UMeshComponent

UGroomComponent

References

Module	HairStrandsCore
Header	/Engine/Plugins/Experimental/HairStrands/Source/HairStrandsCore/Public/GroomComponent.h
Include	#include "GroomComponent.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(HideCategories=(Object, Physics, Activation, Mobility, "Components|Activation"),
EditInlineNew, Meta=(BlueprintSpawnableComponent), ClassGroup=Rendering)
class UGroomComponent : public UMeshComponent

Variables

	Name	Description
bool	bBindGroomToSkeletalMesh	When activated, the groom will be attached and skinned onto the skeletal mesh, if the groom component is a child of a skeletal/skinned component.
UGroomBindingAs...	BindingAsset	Optional binding asset for binding a groom onto a skeletal mesh.
bool	bInitSimulation	Boolean to check when the simulation should be initialized
bool	bResetSimulation	Boolean to check when the simulation should be reset
UGroomAsset ...	GroomAsset	Groom asset .
TArray< FHairGr...	GroomGroupsDesc	Groom's groups info.
UMaterialInterf...	HairDebugMaterial
UMaterialInterf...	HairDefaultMaterial
TArray< class U...	NiagaraComponents	Niagara components that will be attached to the system
FMatrix	PrevBoneMatrix	Previous bone matrix to compare the difference and decide to reset or not the simulation
USkeletalMesh &...	SourceSkeletalMesh	Skeletal mesh on which the groom has been authored.

Constructors

	Name	Description
	UGroomComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
FHairStrands...	GetGuideStrandsDatas ( uint32 GroupIndex )	Return the guide hairs datas
FHairStrands...	GetGuideStrandsDeformedResource ( uint32 GroupIndex )	Return the guide hairs deformed resources
FHairStrands...	GetGuideStrandsDeformedRootResource ( uint32 GroupIndex )
FHairStrands...	GetGuideStrandsRestResource ( uint32 GroupIndex )	Return the guide hairs rest resources
FHairStrands...	GetGuideStrandsRestRootResource ( uint32 GroupIndex )	Return the guide hairs root resources
void	Invalidate()
void	InvalidateAndRecreate()
void	ReleaseHairSimulation()	Release Niagara components
void	SetBinding ( UGroomBindingAsset* InBinding )
void	SetBinding ( bool bBind )
void	SetGroomAsset ( UGroomAsset* Asset )
void	SetGroomAsset ( UGroomAsset* Asset, UGroomBindingAsset* InBinding )
void	SetHairLengthScale ( float Scale )
void	SetHairRootScale ( float Scale )
void	SetHairWidth ( float HairWidth )
void	SetScatterSceneLighting ( bool Enable )
void	SetStableRasterization ( bool bEnable )
void	UpdateHairGroupsDesc()	Update Group Description
void	UpdateHairSimulation()	Update Niagara components
void	UpdateSimulatedGroups()	Update simulated groups
void	ValidateMaterials ( bool bMapCheck )

Overridden from UPrimitiveComponent

	Name	Description
FPrimitiveSc...	CreateSceneProxy()	Creates a proxy to represent the primitive to the scene manager in the rendering thread.
UMaterialInt...	GetMaterial ( int32 ElementIndex )	Returns the material used by the element at the specified index
int32	GetNumMaterials()	Return number of material elements in this primitive

Overridden from USceneComponent

	Name	Description
FBoxSphereBo...	CalcBounds ( const FTransform& LocalToWorld )	Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
void	OnAttachmentChanged()	Called when AttachParent changes, to allow the scene to update its attachment state.
void	OnChildAttached ( USceneComponent* ChildComponen... )	Used for tracking if a Niagara component is attached or not.
void	OnChildDetached ( USceneComponent* ChildComponen... )	Called after a child scene component is detached from this component.

Overridden from UActorComponent

	Name	Description
void	CheckForErrors()	Function that gets called from within Map_Check to allow this actor component to check itself for any potential errors and register them with map check dialog.
void	OnComponentDestroyed ( bool bDestroyingHierarchy )	Called when a component is destroyed
void	OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
void	OnUnregister()	Called when a component is unregistered.
void	SendRenderTransform_Concurrent()	Called to send a transform update for this component to the rendering thread
void	TickComponent ( float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* T... )	Function called every frame on this ActorComponent.

Overridden from UObject

	Name	Description
bool	CanEditChange ( const FProperty* InProperty )	Called by the editor to query whether a property of this object is allowed to be modified.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PreEditChange ( FProperty* PropertyAboutToChan... )	This is called when a property is about to be modified externally

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

Take our survey

Dismiss