UVectorFieldComponent

A Component referencing a vector field.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Components/VectorFieldComponent.h

Include

#include "Components/VectorFieldComponent.h"

Syntax

class UVectorFieldComponent : public UPrimitiveComponent

Remarks

A Component referencing a vector field.

Variables

Name Description

Public variable

uint32: 1

 

bPreviewVectorField

If true, the vector field is only used for preview visualizations.

Public variable

FFXSystemInterf...

 

FXSystem

The FX system with which this vector field is associated.

Public variable

float

 

Intensity

The intensity at which the vector field is applied.

Public variable

float

 

Tightness

How tightly particles follow the vector field.

Public variable

UVectorField &#...

 

VectorField

The vector field asset.

Public variable

FVectorFieldIns...

 

VectorFieldInstance

The instance of this vector field registered with the FX system.

Constructors

Name Description

Public function

UVectorFieldComponent

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Virtual

void

 

SetIntensity

(
    float NewIntensity
)

Set the intensity of the vector field.

Overridden from UPrimitiveComponent

Name Description

Public function Virtual

FPrimitiveSc...

 

CreateSceneProxy()

Creates a proxy to represent the primitive to the scene manager in the rendering thread.

Public function Virtual Const

void

 

GetUsedMaterials

(
    TArray< UMaterialInterface* > ...,
    bool bGetDebugMaterials
)

Retrieves the materials used in this component

Overridden from USceneComponent

Name Description

Public function Virtual Const

FBoxSphereBo...

 

CalcBounds

(
    const FTransform& LocalToWorld
)

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

Overridden from UActorComponent

Name Description

Public function Virtual

void

 

OnRegister()

Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.

Public function Virtual

void

 

OnUnregister()

Called when a component is unregistered.

Public function Virtual

void

 

SendRenderTransform_Concurrent()

Called to send a transform update for this component to the rendering thread

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostInterpChange

(
    UProperty* PropertyThatChanged
)

This is called when property is modified by InterpPropertyTracks

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback