1. Epic GamesDeveloper
  3. UGroomSolverComponent

UGroomSolverComponent

Groom solver component in which groom component could be added to be solver together

API > API/Plugins > API/Plugins/HairStrandsSolver

Groom solver component in which groom component could be added to be solver together

   
Name UGroomSolverComponent
Type class
Header File /Engine/Plugins/Runtime/HairStrands/Source/HairStrandsSolver/Public/GroomSolverComponent.h
Include Path #include "GroomSolverComponent.h"

Syntax

UCLASS (HideCategories=(Object, Physics, Collision, Activation, Mobility, "Components|Activation"),  
       Meta=(BlueprintSpawnableComponent), ClassGroup=Physics, MinimalAPI)  
class UGroomSolverComponent :  
    public UMeshComponent ,  
    public IDataflowPhysicsSolverInterface

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UGroomSolverComponent ( const FObjectInitializer& ObjectInitializer
)

   GroomSolverComponent.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CollisionComponents TMap< TObjectPtr< UMeshComponent >, int32 > List of collision components registered to the solver GroomSolverComponent.h
  • VisibleAnywhere
  • Category="Groom"
DeformerInstance TObjectPtr< UMeshDeformerInstance > Object containing state for the MeshDeformer. GroomSolverComponent.h
  • Transient
DeformerSettings TObjectPtr< UMeshDeformerInstanceSettings > Object containing instance settings for the MeshDeformer. GroomSolverComponent.h
  • VisibleAnywhere
  • Instanced
  • Category="Groom"
  • Meta=(DisplayName="Deformer Settings", EditCondition="DeformerSettings!=nullptr", ShowOnlyInnerProperties)
GroomComponents TSet< TObjectPtr< UGroomComponent > > List of physics objects registered to the solver GroomSolverComponent.h
  • VisibleAnywhere
  • Category="Groom"
GroomSolverProxy FDataflowGroomSolverProxy Groom solver proxy to be used in dataflow GroomSolverComponent.h  
MeshDeformer TObjectPtr< UMeshDeformer > Graph deformer solver the component is using GroomSolverComponent.h
  • EditAnywhere
  • Category="Groom"
  • Meta=(DisplayPriority=2)
SimulationAsset FDataflowSimulationAsset Solver dataflow asset used to advance in time GroomSolverComponent.h
  • EditAnywhere
  • Category="Dataflow"
  • Meta=(EditConditionHides)
  • AdvancedDisplay
SolverSettings FGroomSolverSettings Solver settings used to control the simulation GroomSolverComponent.h
  • EditAnywhere
  • Category="Settings"

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddCollisionComponent ( UMeshComponent* CollisionComponent,
const int32 LODIndex
)

 Add a collision component to the solver GroomSolverComponent.h
  • BlueprintCallable
  • Category="Groom"

void AddGroomComponent ( UGroomComponent* GroomComponent
)

 Add a groom component to the solver GroomSolverComponent.h
  • BlueprintCallable
  • Category="Groom"

const TMap< TObjectPtr< UMeshComponent >, int32 > & GetCollisionComponents()

 Get the solver collision components GroomSolverComponent.h  

const TSet< TObjectPtr< UGroomComponent > > & GetGroomComponents()

 Get the solver groom components GroomSolverComponent.h  

UMeshDeformerInstance * GetMeshDeformerInstance()

 Return the mesh deformer instance GroomSolverComponent.h  

const FGroomSolverSettings & GetSolverSettings()

 Get the groom solver settings GroomSolverComponent.h  

void RemoveCollisionComponent ( UMeshComponent* CollisionComponent
)

 Remove a collision component to the solver GroomSolverComponent.h
  • BlueprintCallable
  • Category="Groom"

void RemoveGroomComponent ( UGroomComponent* GroomComponent
)

 Remove a groom component to the solver GroomSolverComponent.h
  • BlueprintCallable
  • Category="Groom"

void ResetCollisionComponents()

 Reset the solver collision components GroomSolverComponent.h
  • BlueprintCallable
  • Category="Groom"

void ResetGroomComponents()

 Reset the solver groom components GroomSolverComponent.h
  • BlueprintCallable
  • Category="Groom"

void SetDeformerSolver ( UMeshDeformer* DeformerSolver
)

 Change the MeshDeformer solver that is used for this Component. GroomSolverComponent.h
  • BlueprintCallable
  • Category="Groom"

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void CreateRenderState_Concurrent ( FRegisterComponentContext* Context
)

   GroomSolverComponent.h  

virtual void DestroyRenderState_Concurrent()

   GroomSolverComponent.h  

virtual void OnRegister()

   GroomSolverComponent.h  

virtual void OnUnregister()

   GroomSolverComponent.h  

virtual void SendRenderDynamicData_Concurrent()

   GroomSolverComponent.h  

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

   GroomSolverComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   GroomSolverComponent.h  

Overridden from IDataflowSimulationInterface

Name Remarks Include Path Unreal Specifiers

virtual void BuildSimulationProxy()

   GroomSolverComponent.h  
  GroomSolverComponent.h  
  GroomSolverComponent.h  

virtual FString GetSimulationName()

   GroomSolverComponent.h  
  GroomSolverComponent.h  
  GroomSolverComponent.h  

virtual void ReadFromSimulation ( const float DeltaTime,
const bool bAsyncTask
)

   GroomSolverComponent.h  

virtual void ResetSimulationProxy()

   GroomSolverComponent.h  

virtual void WriteToSimulation ( const float DeltaTime,
const bool bAsyncTask
)

   GroomSolverComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page