Navigation
API > API/Plugins > API/Plugins/VirtualHeightfieldMesh
Component to render a heightfield mesh using a virtual texture heightmap.
| Name | UVirtualHeightfieldMeshComponent |
| Type | class |
| Header File | /Engine/Plugins/Experimental/VirtualHeightfieldMesh/Source/VirtualHeightfieldMesh/Public/VirtualHeightfieldMeshComponent.h |
| Include Path | #include "VirtualHeightfieldMeshComponent.h" |
Syntax
UCLASS (MinimalAPI, Blueprintable, ClassGroup=Rendering,
HideCategories=(Activation, Collision, Cooking, HLOD, Navigation, Mobility, Object, Physics, VirtualTexture))
class UVirtualHeightfieldMeshComponent : public UPrimitiveComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → UPrimitiveComponent → UVirtualHeightfieldMeshComponent
Implements Interfaces
- IAsyncPhysicsStateProcessor
- IInterface_AssetUserData
- IInterface_AsyncCompilation
- INavRelevantInterface
- IPhysicsComponent
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UVirtualHeightfieldMeshComponent
(
const FObjectInitializer& ObjectInitializer |
VirtualHeightfieldMeshComponent.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool GetHiddenInEditor() |
Get the HiddenInEditor flag on this component. | VirtualHeightfieldMeshComponent.h | |
float GetLod0Distribution() |
VirtualHeightfieldMeshComponent.h | ||
float GetLod0ScreenSize() |
VirtualHeightfieldMeshComponent.h | ||
float GetLodBiasScale() |
VirtualHeightfieldMeshComponent.h | ||
float GetLodDistribution() |
VirtualHeightfieldMeshComponent.h | ||
UMaterialInterface * GetMaterial () |
VirtualHeightfieldMeshComponent.h | ||
UHeightfieldMinMaxTexture * GetMinMaxTexture() |
Get the MinMax height texture on this component. | VirtualHeightfieldMeshComponent.h | |
int32 GetNumForceLoadLods() |
VirtualHeightfieldMeshComponent.h | ||
int32 GetNumMinMaxTextureBuildLevels() |
Get the number of levels to build in the MinMax Texture. | VirtualHeightfieldMeshComponent.h | |
int32 GetNumOcclusionLods() |
VirtualHeightfieldMeshComponent.h | ||
URuntimeVirtualTexture * GetVirtualTexture() |
Get the associated runtime virtual texture. | VirtualHeightfieldMeshComponent.h | |
FTransform GetVirtualTextureTransform() |
Get the associated runtime virtual texture transform including any texel snap offset. | VirtualHeightfieldMeshComponent.h | |
ARuntimeVirtualTextureVolume * GetVirtualTextureVolume () |
Get the associated runtime virtual texture volume. | VirtualHeightfieldMeshComponent.h | |
void InitializeMinMaxTexture
(
uint32 InSizeX, |
Initialize the MinMax height texture with the passed in size and data. | VirtualHeightfieldMeshComponent.h | |
bool IsMinMaxTextureEnabled() |
Returns true if a MinMax height texture is relevant for this virtual texture type. | VirtualHeightfieldMeshComponent.h | |
void SetMinMaxTexture
(
UHeightfieldMinMaxTexture* InTexture |
Set a new asset to hold the MinMax height texture. | VirtualHeightfieldMeshComponent.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ApplyWorldOffset
(
const FVector& InOffset, |
VirtualHeightfieldMeshComponent.h | ||
virtual FBoxSphereBounds CalcBounds
(
const FTransform& LocalToWorld |
VirtualHeightfieldMeshComponent.h | ||
virtual FPrimitiveSceneProxy * CreateSceneProxy() |
VirtualHeightfieldMeshComponent.h | ||
void GatherHideFlags
(
bool& InOutHidePrimitivesInEditor, |
Function used by the VirtualTexture delegate to retrieve our HidePrimitives flags. | VirtualHeightfieldMeshComponent.h | |
virtual UMaterialInterface * GetMaterial
(
int32 Index |
VirtualHeightfieldMeshComponent.h | ||
virtual void GetUsedMaterials
(
TArray< UMaterialInterface* >& OutMaterials, |
VirtualHeightfieldMeshComponent.h | ||
virtual bool IsVisible() |
VirtualHeightfieldMeshComponent.h | ||
virtual void OnRegister() |
VirtualHeightfieldMeshComponent.h | ||
virtual void OnUnregister() |
VirtualHeightfieldMeshComponent.h | ||
void OnVirtualTextureTransformUpdate
(
USceneComponent* InRootComponent, |
Handles when the transform is updated on the associated VirtualTexture. | VirtualHeightfieldMeshComponent.h | |
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
VirtualHeightfieldMeshComponent.h | ||
virtual void SetMaterial
(
int32 ElementIndex, |
VirtualHeightfieldMeshComponent.h | ||
virtual bool SupportsStaticLighting() |
VirtualHeightfieldMeshComponent.h | ||
virtual bool SupportsWorldPositionOffsetVelocity() |
VirtualHeightfieldMeshComponent.h |