1. Epic GamesDeveloper
  3. UVirtualHeightfieldMeshComponent

UVirtualHeightfieldMeshComponent

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

API > API/Plugins > API/Plugins/VirtualHeightfieldMesh

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Blueprintable, ClassGroup&61;Rendering,  
       HideCategories&61;&40;Activation, Collision, Cooking, HLOD, Navigation, Mobility, Object, Physics, VirtualTexture&41;&41;  
class UVirtualHeightfieldMeshComponent : public UPrimitiveComponent

Remarks

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

Variables

  Type Name Description
Protected variable UProperty Category Transient visibleanywhere bool bBuildMinMaxTextureButton Placeholder for details customization button.
Protected variable UProperty Category Transient visibleanywhere bool bCopyBoundsButton Placeholder for details customization button.
Protected variable UProperty Category, EditAnywhere, Meta bool bHiddenInEditor Allows us to only see this actor in game and not in the Editor.
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay bool bWorldPositionOffsetVelocity Allows material World Position Offset to contribute to velocity rendering.
Protected variable UProperty Category, EditAnywhere, Meta float Lod0Distribution Distribution multiplier applied only for LOD 0.
Protected variable UProperty Category, EditAnywhere, Meta float Lod0ScreenSize Target screen size for a LOD 0 tile.
Protected variable UProperty Category, EditAnywhere, Meta float LodBiasScale Scale applied to LodBias texture.
Protected variable UProperty Category, EditAnywhere, Meta float LodDistribution Distribution multiplier applied for each LOD level.
Protected variable UProperty Category, EditAnywhere TObjectPtr< UMaterialInterface > Material The material to apply.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly TObjectPtr< UHeightfieldMinMaxTexture > MinMaxTexture Texture object containing minimum and maximum height values.
Protected variable UProperty Category, EditAnywhere, Meta int32 NumForceLoadLods The number of levels that we force loaded.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly int32 NumMinMaxTextureBuildLevels Number of levels to build in the MinMax Texture.
Protected variable UProperty Category, EditAnywhere, Meta int32 NumOcclusionLods The number of levels that we calculate occlusion volumes for.
Protected variable UProperty Category, EditAnywhere TSoftObjectPtr< ARuntimeVirtualTextureVolume > VirtualTexture The RuntimeVirtualTextureVolume that contains virtual texture heightmap.
Protected variable UProperty Transient TObjectPtr< ARuntimeVirtualTextureVolume > VirtualTextureRef UObject ref resolved from VirtualTexture weak ref.
Protected variable UProperty Category Transient visibleanywhere TObjectPtr< UObject > VirtualTextureThumbnail Placeholder for details customization image.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function Const UFunction void

GatherHideFlags ( bool& InOutHidePrimitivesInEditor,
bool& InOutHidePrimitivesInGame
)

 Function used by the VirtualTexture delegate to retrieve our HidePrimitives flags.
Public function Const bool Get the HiddenInEditor flag on this component.
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const UMaterialInterface *  
Public function Const UHeightfieldMinMaxTexture * Get the MinMax height texture on this component.
Public function Const int32  
Public function int32 Get the number of levels to build in the MinMax Texture.
Public function Const int32  
Public function Const URuntimeVirtualTexture * Get the associated runtime virtual texture.
Public function Const FTransform Get the associated runtime virtual texture transform including any texel snap offset.
Public function Const ARuntimeVirtualTextureVolume * Get the associated runtime virtual texture volume.
Public function void

InitializeMinMaxTexture ( uint32 InSizeX,
uint32 InSizeY,
uint32 InNumMips,
uint8* InData
)

 Initialize the MinMax height texture with the passed in size and data.
Public function Const bool Returns true if a MinMax height texture is relevant for this virtual texture type.
Protected function void

OnVirtualTextureTransformUpdate ( USceneComponent* InRootComponent,
EUpdateTransformFlags UpdateTransformFlags,
ETeleportType Teleport
)

 Handles when the transform is updated on the associated VirtualTexture.
Public function void Set a new asset to hold the MinMax height texture.

Overridden from UPrimitiveComponent

  Type Name Description
Protected function Virtual FPrimitiveSceneProxy * Creates a proxy to represent the primitive to the scene manager in the rendering thread.
Protected function Virtual Const UMaterialInterface *

GetMaterial ( int32 ElementIndex
)

 Returns the material used by the element at the specified index
Protected function Virtual Const void

GetUsedMaterials ( TArray< UMaterialInterface* >& OutMaterials,
bool bGetDebugMaterials
)

 Retrieves the materials used in this component
Protected function Virtual void

SetMaterial ( int32 ElementIndex,
UMaterialInterface* Material
)

 Changes the material applied to an element of the mesh.
Protected function Virtual Const bool Whether the component type supports static lighting.
Protected function Virtual Const bool Returns false if this primitive should never output velocity based on its WPO state.

Overridden from USceneComponent

  Type Name Description
Protected function Virtual Const FBoxSphereBounds

CalcBounds ( const FTransform& LocalToWorld
)

 Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
Protected function Virtual Const bool Returns true if this component is visible in the current context

Overridden from UActorComponent

  Type Name Description
Protected function Virtual void

ApplyWorldOffset ( const FVector& InOffset,
bool bWorldShift
)

 Called by owner actor on position shifting Component should update all relevant data structures to reflect new actor location
Protected function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Protected function Virtual void Called when a component is unregistered.

Overridden from UObject

  Type Name Description
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page