1. Epic GamesDeveloper
  3. ULandscapeHeightfieldCollisionComponent

ULandscapeHeightfieldCollisionComponent

Unreal Engine C++ API Reference > Runtime > Landscape

Inheritance Hierarchy

References

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

Syntax

UCLASS (MinimalAPI, Within=LandscapeProxy)  
class ULandscapeHeightfieldCollisionComponent : public UPrimitiveComponent

Variables

  Type Name Description
Public variable bool bCookedCollisionDataWasDeleted  
Public variable bool[2] bShouldSaveCookedDataToDDC Flag to indicate that the next time we cook data, we should save it to the DDC.
Public variable FNavHeightfieldSamples CachedHeightFieldSamples  
Public variable UProperty FBox CachedLocalBox Cached local-space bounding box, created at heightmap update time
Public variable UProperty uint32 CollisionHash  
Public variable FWordBulkData CollisionHeightData The collision height values. Stripped from cooked content
Public variable UProperty TArray< uint8 > CollisionQuadFlags The flags for each collision quad. See ECollisionQuadFlags.
Public variable UProperty float CollisionScale Collision scale: (ComponentSizeQuads) / (CollisionSizeQuads)
Public variable UProperty int32 CollisionSizeQuads Size of component in collision quads
Public variable UProperty TArray< TObjectPtr< ULandscapeLayerInfoObject > > ComponentLayerInfos List of layers painted on this component.
Public variable TArray< uint8 > CookedCollisionData Cooked HeightField data.
Public variable TArray< uint8 > CookedCollisionDataEd Cooked editor specific heightfield data, never serialized
Public variable UProperty TArray< TObjectPtr< UPhysicalMaterial > > CookedPhysicalMaterials This is a list of physical materials that is actually used by a cooked HeightField
Public variable FByteBulkData DominantLayerData Indices into the ComponentLayers array for the per-vertex dominant layer.
Public variable int32 HeightfieldColumnsCount  
Public variable UProperty FGuid HeightfieldGuid Guid used to share Physics heightfield objects in the editor
Public variable TRefCountPtr< FHeightfieldGeometryRef > HeightfieldRef Physics engine version of heightfield data.
Public variable int32 HeightfieldRowsCount Cached PxHeightFieldSamples values for navmesh generation.
Public variable Chaos::FHeightFieldPtr LocalHeightfieldGeometryRef Local non-serialized ref counted pointers to keep the chaos heightfields alive between Unregister() and actual destruction of the component.
Public variable Chaos::FHeightFieldPtr LocalHeightfieldSimpleGeometryRef  
Public variable FByteBulkData PhysicalMaterialRenderData Indices for physical materials generated by the render material. Stripped from cooked content
Public variable UProperty TArray< TObjectPtr< UPhysicalMaterial > > PhysicalMaterialRenderObjects Physical materials objects referenced by the indices in PhysicalMaterialRenderData.
Public variable UProperty int32 SectionBaseX Offset of component in landscape quads
Public variable UProperty int32 SectionBaseY  
Public variable UProperty int32 SimpleCollisionSizeQuads Size of component's "simple collision" in collision quads
Public variable TSharedPtr< FAsyncPreRegisterDDCRequest > SpeculativeDDCRequest Async DCC load for cooked collision representation.

Constructors

  Type Name Description
Public function  

ULandscapeHeightfieldCollisionComponent ( const FObjectInitializer& ObjectInitializer
)

  
Public function  

ULandscapeHeightfieldCollisionComponent ( FVTableHelper& Helper
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual void

ApplyWorldOffset ( const FVector& InOffset,
bool bWorldShift
)

  
Public function Virtual void  
Public function Virtual Const FBoxSphereBounds

CalcBounds ( const FTransform& BoundTransform
)

  
Public function Virtual Const uint32 Computes a hash of all the data that will impact final collision
Public function Virtual Const bool

CookCollisionData ( const FName& Format,
bool bUseDefaultMaterialOnly,
bool bCheckDDC,
TArray< uint8 >& OutCookedData,
TArray< UPhysicalMaterial* >& InOutMaterials
)

 Cooks raw height data into collision object binary stream
Public function void

CreateCollisionObject ( bool bUseDefaultMaterialOnly,
TArrayView< const uint16 > Heights,
TArrayView< const uint16 > SimpleHeights,
TArrayView< const uint8 > PhysicalMaterialIds,
TArrayView< const uint8 > SimplePhysicalMaterialIds,
TArrayView< const TObjectPtr< UPhysicalMaterial > > PhysicalMaterialObjects
)

 Creates collision object from raw runtime data.
Public function Virtual void Creates collision object from a cooked collision data
Public function Virtual FPrimitiveSceneProxy * The scene proxy is only for debug purposes :
Public function Virtual void

DestroyComponent ( bool bPromoteChildren
)

  
Public function Virtual Const bool

DoCustomNavigableGeometryExport ( FNavigableGeometryExport& GeomExport
)

  
Public function Virtual void

ExportCustomProperties ( FOutputDevice& Out,
uint32 Indent
)

  
Public function Const bool

FillHeightTile ( TArrayView< float > Heights,
int32 Offset,
int32 Stride
)

 Populates a supplied array with the heights from the heightfield.
Public function Const bool

FillMaterialIndexTile ( TArrayView< uint8 > Materials,
int32 Offset,
int32 Stride
)

  
Public function Virtual Const void

GatherGeometrySlice ( FNavigableGeometryExport& GeomExport,
const FBox& SliceBox
)

  
Public function Virtual Const ECollisionEnabled::Type  
Public function Virtual Const ECollisionChannel  
Public function Virtual Const ECollisionResponse

GetCollisionResponseToChannel ( ECollisionChannel Channel
)

  
Public function Virtual Const const FCollisionResponseContainer &  
Public function Const void

GetCollisionSampleInfo ( int32& OutCollisionSizeVerts,
int32& OutSimpleCollisionSizeVerts,
int32& OutNumSamples,
int32& OutNumSimpleSamples
)

  
Public function Virtual Const ENavDataGatheringMode  
Public function TOptional< float >

GetHeight ( float X,
float Y,
EHeightfieldSource HeightFieldSource
)

  
Public function Const ULandscapeInfo * Gets the landscape info object for this landscape
Public function Const ALandscapeProxy * Return the landscape actor associated with this component.
Public function UPhysicalMaterial *

GetPhysicalMaterial ( float X,
float Y,
EHeightfieldSource HeightFieldSource
)

  
Public function Const UFunction BlueprintCallable, Category ULandscapeComponent * Returns associated landscape component
Public function Virtual void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

  
Public function Const FIntPoint  
Public function Virtual void

ImportCustomProperties ( const TCHAR* SourceText,
FFeedbackContext* Warn
)

  
Public function Virtual Const bool

IsShown ( const FEngineShowFlags& ShowFlags
)

  
Public function Virtual Const bool  
Public function Virtual Const bool  
Protected function Virtual void  
Protected function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

PreSave ( FObjectPreSaveContext ObjectSaveContext
)

  
Public function Virtual bool Recreate heightfield and restart physics
Public function Virtual void

Serialize ( FArchive& Ar
)

  
Public function void

SetRenderComponent ( ULandscapeComponent* InRenderComponent
)

  
Public function void

SetSectionBase ( FIntPoint InSectionBase
)

  
Public function void  
Public function void

SnapFoliageInstances ( const FBox& InInstanceBox
)

 Called from editor code to manage foliage instances on landscape.
Public function void We speculatively async load collision object from DDC to remove hitch when streaming
Public function Virtual Const bool  
Public function void

UpdateHeightfieldRegion ( int32 ComponentX1,
int32 ComponentY1,
int32 ComponentX2,
int32 ComponentY2
)

 Modify a sub-region of the physics heightfield.
Public function Const bool

WriteRuntimeData ( const FWriteRuntimeDataParams& Params,
TArray< uint8 >& OutHeightfieldData,
TArray< UPhysicalMaterial* >& InOutMaterials
)

 Writes to a cooked data buffer using raw heightfield data.

Classes

  Type Name Description
Public struct FHeightfieldGeometryRef    
Public struct FWriteRuntimeDataParams    

Enums

  Type Name Description
Public enum ECollisionQuadFlags    

Deprecated Variables

  Type Name Description
Public variable UProperty TLazyObjectPtr< ULandscapeComponent > RenderComponent_DEPRECATED Reference to render component

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page