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

> Unreal Engine API Reference > Plugins > VirtualHeightfieldMesh > UVirtualHeightfieldMeshComponent

Light Theme

Dark Theme

UVirtualHeightfieldMeshComponent

Component to render a heightfield mesh using a virtual texture heightmap.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

UVirtualHeightfieldMeshComponent

References

Module	VirtualHeightfieldMesh
Header	/Engine/Plugins/Experimental/VirtualHeightfieldMesh/Source/VirtualHeightfieldMesh/Public/VirtualHeightfieldMeshComponent.h
Include	#include "VirtualHeightfieldMeshComponent.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, ClassGroup=Rendering,
HideCategories=(Activation, Collision, Cooking, HLOD, Navigation, Mobility, Object, Physics, VirtualTexture))
class UVirtualHeightfieldMeshComponent : public UPrimitiveComponent

Remarks

Component to render a heightfield mesh using a virtual texture heightmap.

Variables

	Name	Description
bool	bBuildMinMaxTextureButton	Placeholder for details customization button.
bool	bCopyBoundsButton	Placeholder for details customization button.
bool	bHiddenInEditor	Allows us to only see this actor in game and not in the Editor.
float	Lod0Distribution	Distribution multiplier applied only for LOD 0.
float	Lod0ScreenSize	Target screen size for a LOD 0 tile.
float	LodBiasScale	Scale applied to LodBias texture.
float	LodDistribution	Distribution multiplier applied for each LOD level.
UMaterialInterf...	Material	The material to apply.
UHeightfieldMin...	MinMaxTexture	Texture object containing minimum and maximum height values.
int32	NumForceLoadLods	The number of levels that we force loaded.
int32	NumMinMaxTextureBuildLevels	Number of levels to build in the MinMax Texture.
int32	NumOcclusionLods	The number of levels that we calculate occlusion volumes for.
TSoftObjectPtr<...	VirtualTexture	The RuntimeVirtualTextureVolume that contains virtual texture heightmap.
ARuntimeVirtual...	VirtualTextureRef	UObject ref resolved from VirtualTexture weak ref.
UObject *	VirtualTextureThumbnail	Placeholder for details customization image.

Constructors

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

Functions

	Name	Description
void	GatherHideFlags ( bool& InOutHidePrimitivesInEditor, bool& InOutHidePrimitivesInGame )	Function used by the VirtualTexture delegate to retrieve our HidePrimitives flags.
bool	GetHiddenInEditor()	Get the HiddenInEditor flag on this component.
float	GetLod0Distribution()
float	GetLod0ScreenSize()
float	GetLodBiasScale()
float	GetLodDistribution()
UMaterialInt...	GetMaterial()
UHeightfield...	GetMinMaxTexture()	Get the MinMax height texture on this component.
int32	GetNumForceLoadLods()
int32	GetNumMinMaxTextureBuildLevels()	Get the number of levels to build in the MinMax Texture.
int32	GetNumOcclusionLods()
URuntimeVirt...	GetVirtualTexture()	Get the associated runtime virtual texture.
FTransform	GetVirtualTextureTransform()	Get the associated runtime virtual texture transform including any texel snap offset.
ARuntimeVirt...	GetVirtualTextureVolume()	Get the associated runtime virtual texture volume.
void	InitializeMinMaxTexture ( uint32 InSizeX, uint32 InSizeY, uint32 InNumMips, uint8* InData )	Initialize the MinMax height texture with the passed in size and data.
bool	IsMinMaxTextureEnabled()	Returns true if a MinMax height texture is relevant for this virtual texture type.
void	OnVirtualTextureTransformUpdate ( USceneComponent* InRootCompone..., EUpdateTransformFlags UpdateTransfo..., ETeleportType Teleport )	Handles when the transform is updated on the associated VirtualTexture.
void	SetMinMaxTexture ( UHeightfieldMinMaxTexture* InT... )	Set a new asset to hold the MinMax height texture.

Overridden from UPrimitiveComponent

	Name	Description
FPrimitiveSc...	CreateSceneProxy()	Creates a proxy to represent the primitive to the scene manager in the rendering thread.
UMaterialInt...	GetMaterial ( int32 ElementIndex )	Returns the material used by the element at the specified index
void	GetUsedMaterials ( TArray< UMaterialInterface* > ..., bool bGetDebugMaterials )	Retrieves the materials used in this component
bool	SupportsStaticLighting()	Whether the component type supports static lighting.

Overridden from USceneComponent

		Name	Description
	FBoxSphereBo...	CalcBounds ( const FTransform& LocalToWorld )	Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
	bool	IsVisible()	Returns true if this component is visible in the current context

Overridden from UActorComponent

		Name	Description
	void	OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
	void	OnUnregister()	Called when a component is unregistered.

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss