1. Epic GamesDeveloper
  3. UFieldSystemComponent

UFieldSystemComponent

UENUM(BlueprintType) enum class EChaosObjectType Chaos_Destruction UMETA(DisplayName = "Set Always", ToolTip = "The particle output value will be equal to Interior-value if the particle position is inside a sphere / Exterior-value otherwise."), Chaos_Rigid

API > API/Runtime > API/Runtime/FieldSystemEngine > API/Runtime/FieldSystemEngine/Field

Inheritance Hierarchy

  • UPrimitiveComponent
  • UFieldSystemComponent

References

   
Module FieldSystemEngine
Header /Engine/Source/Runtime/Experimental/FieldSystem/Source/FieldSystemEngine/Public/Field/FieldSystemComponent.h
Include #include "Field/FieldSystemComponent.h"

Syntax

UCLASS (Meta=(BlueprintSpawnableComponent), MinimalAPI)  
class UFieldSystemComponent : public UPrimitiveComponent

Remarks

UENUM(BlueprintType) enum class EChaosObjectType Chaos_Destruction UMETA(DisplayName = "Set Always", ToolTip = "The particle output value will be equal to Interior-value if the particle position is inside a sphere / Exterior-value otherwise."), Chaos_Rigid,

Chaos_Rban UMETA(DisplayName = "Merge Interior", ToolTip = "The particle output value will be equal to Interior-value if the particle position is inside the sphere or if the particle input value is already Interior-Value / Exterior-value otherwise."), Chaos_Cloth UMETA(DisplayName = "Merge Exterior", ToolTip = "The particle output value will be equal to Exterior-value if the particle position is outside the sphere or if the particle input value is already Exterior-Value / Interior-value otherwise."), //~~~ //256th entry Chaos_Objects_Max UMETA(Hidden) FieldSystemComponent

Variables

  Type Name Description
Protected variable bool bHasPhysicsState Boolean to check that the physics state has been built
Public variable UProperty Category, EditAnywhere, Meta bool bIsChaosField If enabled the field will be used by all the chaos solvers
Public variable UProperty Category, EditAnywhere, Meta bool bIsWorldField If enabled the field will be pushed to the world fields and will be available to materials and niagara
Public variable UProperty FFieldObjectCommands BufferCommands List of all the buffer command
Protected variable FChaosSolversModule * ChaosModule Chaos module linked to that component
Protected variable TArray< FFieldSystemCommand > ChaosPersistentFields List of all the chaos peristent fields
Public variable UProperty FFieldObjectCommands ConstructionCommands List of all the construction command
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly TObjectPtr< UFieldSystem > FieldSystem Field system asset to be used to store the construction fields
Protected variable TArray< FFieldSystemCommand > SetupConstructionFields List of all the field used to setup chaos (anchor...)
Public variable UProperty Category, EditAnywhere, Meta TArray< TSoftObjectPtr< AChaosSolverActor > > SupportedSolvers List of solvers this field will affect. An empty list makes this field affect all solvers.
Protected variable TArray< FFieldSystemCommand > WorldCPUPersistentFields List of the world CPU peristent fields created by this field component
Protected variable TArray< FFieldSystemCommand > WorldGPUPersistentFields List of the world GPU peristent fields created by this field component

Constructors

  Type Name Description
Public function  

UFieldSystemComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category displayname void

AddFieldCommand ( UPARAM(DisplayName="Enable Field") bool Enabled,
UPARAM(DisplayName="Physics Type") EFieldPhysicsType Target,
UPARAM(DisplayName="Meta Data") UFieldSystemMetaData* MetaData,
UPARAM(DisplayName="Field Node") UFieldNodeBase* Field
)

 AddConstructionField This function will dispatch a command to the physics thread to apply a generic evaluation of a user defined field network.
Public function UFunction BlueprintCallable, Category, Meta displayname void

AddPersistentField ( UPARAM(DisplayName="Enable Field") bool Enabled,
UPARAM(DisplayName="Physics Type") EFieldPhysicsType Target,
UPARAM(DisplayName="Meta Data") UFieldSystemMetaData* MetaData,
UPARAM(DisplayName="Field Node") UFieldNodeBase* Field
)

 AddPersistentField This function will dispatch a command to the physics thread to apply a generic evaluation of a user defined field network.
Public function UFunction BlueprintCallable, Category, Meta displayname void

ApplyLinearForce ( UPARAM(DisplayName="Enable Field") bool Enabled,
UPARAM(DisplayName="Uniform Direction") FVector Direction,
UPARAM(DisplayName="Field Magnitude") float Magnitude
)

 ApplyUniformForce This function will dispatch a command to the physics thread to apply a uniform linear force on each particle within the simulation.
Public function UFunction BlueprintCallable, Category, Meta displayname void

ApplyPhysicsField ( UPARAM(DisplayName="Enable Field") bool Enabled,
UPARAM(DisplayName="Physics Type") EFieldPhysicsType Target,
UPARAM(DisplayName="Meta Data") UFieldSystemMetaData* MetaData,
UPARAM(DisplayName="Field Node") UFieldNodeBase* Field
)

 AddTransientField This function will dispatch a command to the physics thread to apply a generic evaluation of a user defined transient field network.
Public function UFunction BlueprintCallable, Category, Meta displayname void

ApplyRadialForce ( UPARAM(DisplayName="Enable Field") bool Enabled,
UPARAM(DisplayName="Center Position") FVector Position,
UPARAM(DisplayName="Field Magnitude") float Magnitude
)

 ApplyRadialForce This function will dispatch a command to the physics thread to apply a linear force that points away from a position.
Public function UFunction BlueprintCallable, Category, Meta displayname void

ApplyRadialVectorFalloffForce ( UPARAM(DisplayName="Enable Field") bool Enabled,
UPARAM(DisplayName="Center Position") FVector Position,
UPARAM(DisplayName="Falloff Radius") float Radius,
UPARAM(DisplayName="Field Magnitude") float Magnitude
)

 FalloffRadialForce This function will dispatch a command to the physics thread to apply a linear force from a position in space.
Public function UFunction BlueprintCallable, Category, Meta displayname void

ApplyStayDynamicField ( UPARAM(DisplayName="Enable Field") bool Enabled,
UPARAM(DisplayName="Center Position") FVector Position,
UPARAM(DisplayName="Field Radius") float Radius
)

 SetDynamicState This function will dispatch a command to the physics thread to apply a kinematic to dynamic state change for the particles within the field.
Public function UFunction BlueprintCallable, Category, Meta displayname void

ApplyStrainField ( UPARAM(DisplayName="Enable Field") bool Enabled,
UPARAM(DisplayName="Center Position") FVector Position,
UPARAM(DisplayName="Falloff Radius") float Radius,
UPARAM(DisplayName="Field Magnitude") float Magnitude,
UPARAM(DisplayName="Cluster Levels") int32 Iterations
)

 ApplyExternalStran This function will dispatch a command to the physics thread to apply a strain field on a clustered set of geometry.
Public function UFunction BlueprintCallable, Category, Meta displayname void

ApplyUniformVectorFalloffForce ( UPARAM(DisplayName="Enable Field") bool Enabled,
UPARAM(DisplayName="Center Position") FVector Position,
UPARAM(DisplayName="Uniform Direction") FVector Direction,
UPARAM(DisplayName="Falloff Radius") float Radius,
UPARAM(DisplayName="Field Magnitude") float Magnitude
)

 FalloffUniformForce This function will dispatch a command to the physics thread to apply a linear force in a uniform direction.
Protected function void

BuildFieldCommand ( bool Enabled,
EFieldPhysicsType Target,
UFieldSystemMetaData* MetaData,
UFieldNodeBase* Field,
const bool IsTransient
)

 Build a physics field command and dispatch it
Protected function void Remove the persistent commands from chaos/world
Public function Virtual FPrimitiveSceneProxy *  
Protected function void

DispatchFieldCommand ( const FFieldSystemCommand& InCommand,
const bool IsTransient
)

 Dispatch the field command to chaos/world
Public function Const const TArray< FFieldSystemCommand > & Get all the construction fields
Public function Const const UFieldSystem * Get the field system asset
Protected function Const TSet< FPhysScene_Chaos * > Get ell ethe supported physics scenes
Protected function Const TArray< Chaos::FPhysicsSolverBase * > Get ell the supported physics solvers
Public function Virtual Const bool  
Protected function Virtual Const bool  
Protected function Virtual void  
Protected function Virtual void  
Public function UFunction BlueprintCallable, Category, Meta displayname void RemovePersistentFields This function will remove all the field component persistent fields from chaos and from the world
Public function UFunction BlueprintCallable, Category displayname void RemoveConstructionFields This function will remove all the field component construction fields from chaos and from the world
Public function void

SetFieldSystem ( UFieldSystem* FieldSystemIn
)

 Set the field system asset
Protected function Virtual Const bool  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page