Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

UVectorFieldStatic

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVectorField

UVectorFieldStatic

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/VectorField/VectorFieldStatic.h
Include	#include "VectorField/VectorFieldStatic.h"

Syntax

class UVectorFieldStatic : public UVectorField

Variables

	Name	Description
TObjectPtr< cla...	AssetImportData
bool	bAllowCPUAccess	Whether to keep vector field data accessible to the CPU.
FVectorFieldRes...	Resource	The resource for this vector field.
int32	SizeX	Size of the vector field volume.
int32	SizeY	Size of the vector field volume.
int32	SizeZ	Size of the vector field volume.
FByteBulkData	SourceData	Source vector data.

Constructors

	Name	Description
	UVectorFieldStatic ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
FVector	FilteredSample ( const FVector& SamplePosition, const FVector& TilingAxes )
FRHITexture ...	GetVolumeTextureRef()	Returns a reference to a 3D texture handle for the GPU data.
bool	HasCPUData()
void	InitResource()	Initialize resources.
TConstArrayV...	ReadCPUData()
FVector	Sample ( const FIntVector& SamplePosition )
void	SetCPUAccessEnabled()	Sets the bAllowCPUAccess flag and calls UpdateCPUData().
void	UpdateCPUData ( bool bDiscardData )	Takes a local copy of the source bulk data so that it is readable at runtime on the CPU.

Overridden from UVectorField

		Name	Description
	void	InitInstance ( FVectorFieldInstance* Instance, bool bPreviewInstance )	Initializes an instance for use with this vector field.

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTa... )	Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
void	GetResourceSizeEx ( FResourceSizeEx& CumulativeResourc... )	Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Typedefs

Name	Description
InternalFloatType

Deprecated Variables

		Name	Description
	FString	SourceFilePath_DEPRECATED

Deprecated Functions

		Name	Description
	void	UpdateCPUData()	Please call UpdateCPUData(bool bDiscardData) instead and choose if the internal data should be discarded or not