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 > Runtime > Landscape > ULandscapeHeightfieldCollisionComponent

Light Theme

Dark Theme

ULandscapeHeightfieldCollisionComponent

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

ULandscapeHeightfieldCollisionComponent

ULandscapeMeshCollisionComponent

References

Module	Landscape
Header	/Engine/Source/Runtime/Landscape/Classes/LandscapeHeightfieldCollisionComponent.h
Include	#include "LandscapeHeightfieldCollisionComponent.h"

Syntax

class ULandscapeHeightfieldCollisionComponent : public UPrimitiveComponent

Variables

	Name	Description
bool[2]	bShouldSaveCookedDataToDDC	Flag to indicate that the next time we cook data, we should save it to the DDC.
FNavHeightfield...	CachedHeightFieldSamples
FBox	CachedLocalBox	Cached local-space bounding box, created at heightmap update time
uint32	CollisionHash
FWordBulkData	CollisionHeightData	The collision height values. Stripped from cooked content
TArray< uint8 >	CollisionQuadFlags	The flags for each collision quad. See ECollisionQuadFlags.
float	CollisionScale	Collision scale: (ComponentSizeQuads) / (CollisionSizeQuads)
int32	CollisionSizeQuads	Size of component in collision quads
TArray< ULandsc...	ComponentLayerInfos	List of layers painted on this component.
TArray< uint8 >	CookedCollisionData	Cooked HeightField data.
TArray< uint8 >	CookedCollisionDataEd	Cooked editor specific heightfield data, never serialized
TArray< UPhysic...	CookedPhysicalMaterials	This is a list of physical materials that is actually used by a cooked HeightField
FByteBulkData	DominantLayerData	Indices into the ComponentLayers array for the per-vertex dominant layer.
int32	HeightfieldColumnsCount
FGuid	HeightfieldGuid	Guid used to share PhysX heightfield objects in the editor
TRefCountPtr< F...	HeightfieldRef	Physics engine version of heightfield data.
int32	HeightfieldRowsCount	Cached PxHeightFieldSamples values for navmesh generation.
TLazyObjectPtr<...	RenderComponent	Reference to render component
int32	SectionBaseX	Offset of component in landscape quads
int32	SectionBaseY
int32	SimpleCollisionSizeQuads	Size of component's "simple collision" in collision quads
TSharedPtr< FAs...	SpeculativeDDCRequest	Async DCC load for cooked collision representation.

Constructors

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

Functions

	Name	Description
uint32	ComputeCollisionHash()	Computes a hash of all the data that will impact final collision
bool	CookCollisionData ( const FName& Format, bool bUseOnlyDefMaterial, bool bCheckDDC, TArray< uint8 >& OutCookedData, TArray< UPhysicalMaterial* >&... )	Cooks raw height data into collision object binary stream
void	CreateCollisionObject()	Creates collision object from a cooked collision data
TOptional< f...	GetHeight ( float X, float Y )
ULandscapeIn...	GetLandscapeInfo()	Gets the landscape info object for this landscape
ALandscapePr...	GetLandscapeProxy()	Return the landscape actor associated with this component.
ULandscapeCo...	GetRenderComponent()	Returns associated landscape component
FIntPoint	GetSectionBase()
bool	RecreateCollision()	Recreate heightfield and restart physics
void	SetSectionBase ( FIntPoint InSectionBase )
void	SnapFoliageInstances()
void	SnapFoliageInstances ( const FBox& InInstanceBox )	Called from editor code to manage foliage instances on landscape.
void	SpeculativelyLoadAsyncDDCCollsionData()	We speculatively async load collision object from DDC to remove hitch when streaming
void	UpdateHeightfieldRegion ( int32 ComponentX1, int32 ComponentY1, int32 ComponentX2, int32 ComponentY2 )	Modify a sub-region of the PhysX heightfield. Note that this does not update the physical material

Overridden from UPrimitiveComponent

	Name	Description
bool	ComponentIsTouchingSelectionBox ( const FBox& InSelBBox, const FEngineShowFlags& ShowFlags, const bool bConsiderOnlyBSP, const bool bMustEncompassEntireComp... )	Determines whether the supplied bounding box intersects with the component.
bool	ComponentIsTouchingSelectionFrustum ( const FConvexVolume& InFrustum, const FEngineShowFlags& ShowFlags, const bool bConsiderOnlyBSP, const bool bMustEncompassEntireComp... )	Determines whether the supplied frustum intersects with the component.
bool	DoCustomNavigableGeometryExport ( FNavigableGeometryExport& GeomExpo... )	Collects custom navigable geometry of component.

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.
ECollisionEn...	GetCollisionEnabled()	Returns the form of collision for this component
ECollisionCh...	GetCollisionObjectType()	Gets the collision object type
ECollisionRe...	GetCollisionResponseToChannel ( ECollisionChannel Channel )	Gets the response type given a specific channel
const FColli...	GetCollisionResponseToChannels()	Return const reference to CollsionResponseContainer

Overridden from UActorComponent

	Name	Description
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
void	DestroyComponent ( bool bPromoteChildren )	Unregister the component, remove it from its outer Actor's Components array and mark for pending kill.
void	OnCreatePhysicsState()	Used to create any physics engine information for this component
void	OnDestroyPhysicsState()	Used to shut down and physics engine structure for this component
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	BeginDestroy()	Called before destroying the object.
void	ExportCustomProperties ( FOutputDevice& Out, uint32 Indent )	Exports the property values for the specified object as text to the output device.
void	ImportCustomProperties ( const TCHAR* SourceText, FFeedbackContext* Warn )	Exports the property values for the specified object as text to the output device.
void	PostEditImport()	Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization
void	PostEditUndo()	Called after applying a transaction to the object.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PreSave ( const ITargetPlatform* TargetP... )	Presave function.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Overridden from INavRelevantInterface

	Name	Description
void	GatherGeometrySlice ( FNavigableGeometryExport& GeomExpo..., const FBox& SliceBox )	This function is called "on demand", whenever that specified piece of geometry is needed for navigation generation
ENavDataGath...	GetGeometryGatheringMode()
void	PrepareGeometryExportSync()	Called on Game-thread to give implementer a change to perform actions that require game-thread to run, for example precaching physics data
bool	SupportsGatheringGeometrySlices()	If this instance knows how to export sub-sections of self

Classes

	Name	Description
	FHeightfieldGeometryRef

Enums

	Name	Description
	ECollisionQuadFlags

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

Take our survey

Dismiss