Navigation
API > API/Runtime > API/Runtime/Engine
A Component referencing a vector field.
| Name | UVectorFieldComponent |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Components/VectorFieldComponent.h |
| Include Path | #include "Components/VectorFieldComponent.h" |
Syntax
UCLASS (ClassGroup=Rendering, HideCategories=Object, Meta=(BlueprintSpawnableComponent),
MinimalAPI)
class UVectorFieldComponent : public UPrimitiveComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → UPrimitiveComponent → UVectorFieldComponent
Implements Interfaces
- IAsyncPhysicsStateProcessor
- IInterface_AssetUserData
- IInterface_AsyncCompilation
- INavRelevantInterface
- IPhysicsComponent
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UVectorFieldComponent
(
const FObjectInitializer& ObjectInitializer |
Components/VectorFieldComponent.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bPreviewVectorField | uint32 | If true, the vector field is only used for preview visualizations. | Components/VectorFieldComponent.h |
|
| FXSystem | FFXSystemInterface * | The FX system with which this vector field is associated. | Components/VectorFieldComponent.h | |
| Intensity | float | The intensity at which the vector field is applied. | Components/VectorFieldComponent.h |
|
| Tightness | float | How tightly particles follow the vector field. | Components/VectorFieldComponent.h |
|
| VectorField | TObjectPtr< class UVectorField > | The vector field asset. | Components/VectorFieldComponent.h |
|
| VectorFieldInstance | FVectorFieldInstance * | The instance of this vector field registered with the FX system. | Components/VectorFieldComponent.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void SetIntensity
(
float NewIntensity |
Set the intensity of the vector field. | Components/VectorFieldComponent.h |
|
Overridden from UPrimitiveComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FPrimitiveSceneProxy * CreateSceneProxy() |
Creates a proxy to represent the primitive to the scene manager in the rendering thread. | Components/VectorFieldComponent.h | |
virtual void GetUsedMaterials
(
TArray< UMaterialInterface* >& OutMaterials, |
Retrieves the materials used in this component | Components/VectorFieldComponent.h |
Overridden from USceneComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FBoxSphereBounds CalcBounds
(
const FTransform& LocalToWorld |
Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size. | Components/VectorFieldComponent.h |
Overridden from UActorComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnRegister() |
Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called. | Components/VectorFieldComponent.h | |
virtual void OnUnregister () |
Called when a component is unregistered. | Components/VectorFieldComponent.h | |
virtual void SendRenderTransform_Concurrent () |
Called to send a transform update for this component to the rendering thread | Components/VectorFieldComponent.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Components/VectorFieldComponent.h |