1. Epic GamesDeveloper
  3. UGroomComponent

UGroomComponent

Unreal Engine C++ API Reference > Plugins > HairStrandsCore

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;HideCategories&61;&40;Object, Physics, Activation, Mobility, "Components&124;Activation"&41;,  
       EditInlineNew, Meta&61;&40;BlueprintSpawnableComponent&41;, ClassGroup&61;Rendering&41;  
class UGroomComponent :  
    public UMeshComponent,  
    public ILODSyncInterface,  
    public INiagaraPhysicsAssetDICollectorInterface

Variables

  Type Name Description
Public variable UProperty TObjectPtr< class UNiagaraSystem > AngularSpringsSystem  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Interp BlueprintReadWrite FString AttachmentName Optional socket name, where the groom component should be attached at, when parented with a skeletal mesh
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly TObjectPtr< class UGroomBindingAsset > BindingAsset Optional binding asset for binding a groom onto a skeletal mesh.
Public variable bool bInitSimulation Boolean to check when the simulation should be initialized
Public variable bool bResetSimulation Boolean to check when the simulation should be reset
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bUseCards Force the groom to use cards/meshes geometry instead of strands.
Public variable UProperty TObjectPtr< UMaterialInterface > Cards_DefaultMaterial  
Public variable TArray< TWeakObjectPtr< class USkeletalMeshComponent > > CollisionComponents List of collision components to be used
Public variable UProperty TObjectPtr< class UNiagaraSystem > CosseratRodsSystem  
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite TObjectPtr< UGroomAsset > GroomAsset Groom asset .
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite TObjectPtr< UGroomCache > GroomCache  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TArray< FHairGroupDesc > GroomGroupsDesc Groom's groups info.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< UMeshDeformer > MeshDeformer If set the MeshDeformer will be applied on groom instance for deformation.
Public variable UProperty Category BlueprintReadOnly Transient TObjectPtr< UMeshDeformerInstance > MeshDeformerInstance Object containing state for the bound MeshDeformer.
Public variable UProperty Category, Meta BlueprintReadOnly instanced, visibleanywhere TObjectPtr< UMeshDeformerInstanceSettings > MeshDeformerInstanceSettings Object containing instance settings for the bound MeshDeformer.
Public variable UProperty TObjectPtr< UMaterialInterface > Meshes_DefaultMaterial  
Public variable UProperty Transient TArray< TObjectPtr< class UNiagaraComponent > > NiagaraComponents Niagara components that will be attached to the system
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TObjectPtr< class UPhysicsAsset > PhysicsAsset Physics asset to be used for hair simulation
Public variable FMatrix PrevBoneMatrix Previous bone matrix to compare the difference and decide to reset or not the simulation
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite FHairSimulationSettings SimulationSettings Groom's simulation settings
Public variable UProperty TObjectPtr< class USkeletalMesh > SourceSkeletalMesh Kept for debugging mesh transfer.
Public variable UProperty TObjectPtr< UMaterialInterface > Strands_DebugMaterial Reference of the default/debug materials for each geometric representation
Public variable UProperty TObjectPtr< UMaterialInterface > Strands_DefaultMaterial  

Constructors

  Type Name Description
Public function  

UGroomComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void

AddCollisionComponent ( USkeletalMeshComponent* SkeletalMeshComponent
)

 Add a skeletal mesh to the collision components
Public function Const void

BuildSimulationTransform ( FTransform& SimulationTransform
)

 Build the local simulation transform that could be used in strands simulation
Public function Const bool  
Public function void

CreateHairSimulation ( const int32 GroupIndex,
const int32 LODIndex
)

 Create per Group/LOD the Niagara component
Public function Const float  
Public function Const int32  
Public function Const UGroomCache * GroomCache
Public function Const float  
Public function Const uint32 Hair group instance access
Public function Const const FHairGroupInstance *

GetGroupInstance ( int32 Index
)

  
Public function FHairGroupInstance *

GetGroupInstance ( int32 Index
)

  
Public function FHairStrandsDeformedResource *

GetGuideStrandsDeformedResource ( uint32 GroupIndex
)

 Return the guide hairs deformed resources
Public function FHairStrandsDeformedRootResource *

GetGuideStrandsDeformedRootResource ( uint32 GroupIndex
)

  
Public function FHairStrandsRestResource *

GetGuideStrandsRestResource ( uint32 GroupIndex
)

 Return the guide hairs rest resources
Public function FHairStrandsRestRootResource *

GetGuideStrandsRestRootResource ( uint32 GroupIndex
)

 Return the guide hairs root resources
Public function UFunction BlueprintCallable, Category bool  
Public function Const bool  
Public function Const UMaterialInterface *

GetMaterial ( int32 ElementIndex,
EHairGeometryType GeometryType,
bool bUseDefaultIfIncompatible
)

  
Public function Const EHairGeometryType

GetMaterialGeometryType ( int32 ElementIndex
)

  
Public function UFunction BlueprintCallable, Category UNiagaraComponent *

GetNiagaraComponent ( const int32 GroupIndex
)

 Given the group index return the matching niagara component
Public function Const int32  
Public function Const uint32  
Public function void  
Public function void  
Public function Const bool  
Public function Const bool

IsSimulationEnable ( int32 GroupIndex,
int32 LODIndex
)

 Check if the simulation is enabled or not
Public function void

ReleaseHairSimulation ( const int32 GroupIndex
)

 Release Niagara components
Public function void Release Niagara components
Public function void  
Public function UFunction BlueprintCallable, Category void Reset the collision components
Public function UFunction BlueprintCallable, Category void Reset the simulation, if enabled
Public function void  
Public function UFunction BlueprintCallable, Category void Accessor function for changing Groom binding asset from blueprint/sequencer
Public function UFunction BlueprintCallable, Category void

SetEnableSimulation ( bool bInEnableSimulation
)

 Accessor function for changing the enable simulation flag from blueprint/sequencer
Public function void

SetForcedLOD ( int32 LODIndex
)

  
Public function UFunction BlueprintCallable, Category void Accessor function for changing Groom asset from blueprint/sequencer
Public function void

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

  
Public function void

SetGroomCache ( UGroomCache* InGroomCache
)

  
Public function UFunction BlueprintCallable, Category void

SetHairLengthScale ( float Scale
)

 Accessor function for changing hair length scale from blueprint/sequencer
Public function UFunction BlueprintCallable, Category void

SetHairLengthScaleEnable ( bool bEnable
)

  
Public function void

SetHairRootScale ( float Scale
)

  
Public function void

SetHairWidth ( float HairWidth
)

  
Public function void

SetManualTick ( bool bInManualTick
)

  
Public function UFunction BlueprintCallable, Category void

SetMeshDeformer ( UMeshDeformer* InMeshDeformer
)

 Change the MeshDeformer that is used for this Component.
Public function UFunction BlueprintCallable, Category void

SetPhysicsAsset ( UPhysicsAsset* InPhysicsAsset
)

 Accessor function for changing Groom physics asset from blueprint/sequencer
Public function void

SetPreviewMode ( bool bValue
)

 Set the component in preview mode, forcing the loading of certain data.
Public function void

SetScatterSceneLighting ( bool Enable
)

  
Public function void

SetStableRasterization ( bool bEnable
)

  
Public function void

SetUseCards ( bool InbUseCards
)

  
Public function void

SetValidation ( bool bEnable
)

  
Public function void

SwitchSimulationLOD ( const int32 PreviousLOD,
const int32 CurrentLOD
)

 Enable/Disable hair simulation while transitioning from one LOD to another one
Public function void

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

  
Public function void Update Group Description
Public function void Update Group Description
Public function void Update Niagara components
Public function void Update simulated groups
Public function Const void

ValidateMaterials ( bool bMapCheck
)

  

Overridden from UMeshComponent

  Type Name Description
Public function Virtual Const int32

GetMaterialIndex ( FName MaterialSlotName
)

  
Public function Virtual Const TArray< FName >  
Public function Virtual Const bool

IsMaterialSlotNameValid ( FName MaterialSlotName
)

  

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual void

CollectPSOPrecacheData ( const FPSOPrecacheParams& BasePrecachePSOParams,
FComponentPSOPrecacheParamsList& OutParams
)

  
Public function Virtual FPrimitiveSceneProxy * Creates a proxy to represent the primitive to the scene manager in the rendering thread.
Public function Virtual Const UMaterialInterface *

GetMaterial ( int32 ElementIndex
)

 Returns the material used by the element at the specified index
Public function Virtual Const int32 Return number of material elements in this primitive
Public function Virtual Const void

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

 Retrieves the materials used in this component

Overridden from USceneComponent

  Type Name Description
Public function Virtual Const FBoxSphereBounds

CalcBounds ( const FTransform& LocalToWorld
)

 Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
Public function Virtual void

DetachFromComponent ( const FDetachmentTransformRules& DetachmentRules
)

 Detach this component from whatever it is attached to.
Public function Virtual void Called when AttachParent changes, to allow the scene to update its attachment state.
Protected function Virtual void

OnChildAttached ( USceneComponent* ChildComponent
)

 Used for tracking if a Niagara component is attached or not.
Protected function Virtual void

OnChildDetached ( USceneComponent* ChildComponent
)

 Called after a child scene component is detached from this component.

Overridden from UActorComponent

  Type Name Description
Public function Virtual void 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.
Public function Virtual void Used to create any rendering thread information for this component
Public function Virtual void Used to shut down any rendering thread structure for this component
Public function Virtual void

OnComponentDestroyed ( bool bDestroyingHierarchy
)

 Called when a component is destroyed
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Public function Virtual void Called when a component is unregistered.
Public function Virtual Const bool Return true if this component requires end of frame recreates to happen from the game thread.
Public function Virtual void Called to send dynamic data for this component to the rendering thread
Public function Virtual void Called to send a transform update for this component to the rendering thread
Public function Virtual void

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

 Function called every frame on this ActorComponent.

Overridden from UObject

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

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.
Public function Virtual void Called to finish 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
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreEditChange ( FProperty* PropertyAboutToChange
)

 This is called when a property is about to be modified externally

Overridden from ILODSyncInterface

  Type Name Description
Public function Virtual Const int32 Returns what the current sync LOD has bee set to
Public function Virtual Const int32 ~ Begin ILODSyncInterface Interface.
Public function Virtual Const int32 Returns number of LODs
Public function Virtual void

SetSyncLOD ( int32 LODIndex
)

 Sets what is synced LOD by 0 based index

Overridden from INiagaraPhysicsAssetDICollectorInterface

  Type Name Description
Public function Virtual Const UPhysicsAsset *

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

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page