UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FVectorFieldInstance Class Reference

#include <VectorField.h>

Public Member Functions

 FVectorFieldInstance ()
 
 ~FVectorFieldInstance ()
 
void Init (FVectorFieldResource *InResource, bool bInstanced)
 
void UpdateTransforms (const FMatrix &LocalToWorld)
 

Public Attributes

TRefCountPtr< FVectorFieldResourceResource
 
FBox WorldBounds
 
FMatrix VolumeToWorldNoScale
 
FMatrix WorldToVolume
 
FMatrix VolumeToWorld
 
float Tightness
 
float Intensity
 
int32 Index
 
uint32 bTileX: 1
 
uint32 bTileY: 1
 
uint32 bTileZ: 1
 
uint32 bUseFixDT: 1
 

Detailed Description

An instance of a vector field.

Constructor & Destructor Documentation

◆ FVectorFieldInstance()

FVectorFieldInstance::FVectorFieldInstance ( )
inline

Default constructor.

◆ ~FVectorFieldInstance()

FVectorFieldInstance::~FVectorFieldInstance ( )

Destructor.

Member Function Documentation

◆ Init()

void FVectorFieldInstance::Init ( FVectorFieldResource InResource,
bool  bInstanced 
)

Initializes the instance for the given resource.

Parameters
InResource- The resource to be used by this instance.
bInstanced- true if the resource is instanced and ownership is being transferred.

◆ UpdateTransforms()

void FVectorFieldInstance::UpdateTransforms ( const FMatrix LocalToWorld)

Update the transforms for this vector field instance.

Parameters
LocalToWorld- Transform from local space to world space.

Member Data Documentation

◆ bTileX

uint32 FVectorFieldInstance::bTileX

Tile vector field in x axis?

◆ bTileY

uint32 FVectorFieldInstance::bTileY

Tile vector field in y axis?

◆ bTileZ

uint32 FVectorFieldInstance::bTileZ

Tile vector field in z axis?

◆ bUseFixDT

uint32 FVectorFieldInstance::bUseFixDT

Use fix delta time in the simulation?

◆ Index

int32 FVectorFieldInstance::Index

Index of the vector field in the world.

◆ Intensity

float FVectorFieldInstance::Intensity

The amount by which to scale vectors for this instance of the field.

◆ Resource

TRefCountPtr<FVectorFieldResource> FVectorFieldInstance::Resource

The vector field resource. Kept an active ref count to manage release with UVectorFieldStatic.

◆ Tightness

float FVectorFieldInstance::Tightness

How tightly particles adhere to the vector field. 0: Vectors act like forces, 1: Vectors act like velocities.

◆ VolumeToWorld

FMatrix FVectorFieldInstance::VolumeToWorld

Transform from the vector field's local space to world space.

◆ VolumeToWorldNoScale

FMatrix FVectorFieldInstance::VolumeToWorldNoScale

Transform from the vector field's local space to world space, no scaling is applied.

◆ WorldBounds

FBox FVectorFieldInstance::WorldBounds

Bounds of the vector field in world space.

◆ WorldToVolume

FMatrix FVectorFieldInstance::WorldToVolume

Tra32nsform from world space to the vector field's local space.


The documentation for this class was generated from the following files: