Navigation
API > API/Runtime > API/Runtime/Engine
| Name | UVectorFieldStatic |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/VectorField/VectorFieldStatic.h |
| Include Path | #include "VectorField/VectorFieldStatic.h" |
Syntax
UCLASS (HideCategories=VectorFieldBounds, MinimalAPI)
class UVectorFieldStatic : public UVectorField
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UVectorField → UVectorFieldStatic
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UVectorFieldStatic
(
const FObjectInitializer& ObjectInitializer |
VectorField/VectorFieldStatic.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| InternalFloatType | float | VectorField/VectorFieldStatic.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AssetImportData | TObjectPtr< class UAssetImportData > | VectorField/VectorFieldStatic.h |
|
|
| bAllowCPUAccess | bool | Whether to keep vector field data accessible to the CPU. | VectorField/VectorFieldStatic.h |
|
| Resource | FVectorFieldResource * | The resource for this vector field. | VectorField/VectorFieldStatic.h | |
| SizeX | int32 | Size of the vector field volume. | VectorField/VectorFieldStatic.h |
|
| SizeY | int32 | Size of the vector field volume. | VectorField/VectorFieldStatic.h |
|
| SizeZ | int32 | Size of the vector field volume. | VectorField/VectorFieldStatic.h |
|
| SourceData | FByteBulkData | Source vector data. | VectorField/VectorFieldStatic.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CPUData | TArray< uint8 > | Local copy of the source vector data. | VectorField/VectorFieldStatic.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FVector FilteredSample
(
const FVector& SamplePosition, |
VectorField/VectorFieldStatic.h | ||
FRHITexture * GetVolumeTextureRef() |
Returns a reference to a 3D texture handle for the GPU data. | VectorField/VectorFieldStatic.h | |
bool HasCPUData() |
VectorField/VectorFieldStatic.h | ||
void InitResource() |
Initialize resources. | VectorField/VectorFieldStatic.h | |
TConstArrayView< InternalFloatType > ReadCPUData() |
VectorField/VectorFieldStatic.h | ||
FVector Sample
(
const FIntVector& SamplePosition |
VectorField/VectorFieldStatic.h | ||
void SetCPUAccessEnabled() |
Sets the bAllowCPUAccess flag and calls UpdateCPUData(). | VectorField/VectorFieldStatic.h | |
void UpdateCPUData () |
VectorField/VectorFieldStatic.h | ||
void UpdateCPUData
(
bool bDiscardData |
Takes a local copy of the source bulk data so that it is readable at runtime on the CPU. | VectorField/VectorFieldStatic.h |
Overridden from UVectorField
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void InitInstance
(
FVectorFieldInstance* Instance, |
Initializes an instance for use with this vector field. | VectorField/VectorFieldStatic.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
VectorField/VectorFieldStatic.h | ||
virtual void GetAssetRegistryTags
(
TArray< FAssetRegistryTag >& OutTags |
VectorField/VectorFieldStatic.h | ||
virtual void GetAssetRegistryTags
(
FAssetRegistryTagsContext Context |
VectorField/VectorFieldStatic.h | ||
virtual void GetResourceSizeEx
(
FResourceSizeEx& CumulativeResourceSize |
VectorField/VectorFieldStatic.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
VectorField/VectorFieldStatic.h | ||
virtual void PostInitProperties() |
VectorField/VectorFieldStatic.h | ||
virtual void PostLoad() |
VectorField/VectorFieldStatic.h | ||
virtual void Serialize
(
FArchive& Ar |
VectorField/VectorFieldStatic.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| SourceFilePath_DEPRECATED | FString | VectorField/VectorFieldStatic.h |