1. Epic GamesDeveloper
  3. ULandscapeHeightfieldCollisionComponent

ULandscapeHeightfieldCollisionComponent

API > API/Runtime > API/Runtime/Landscape

   
Name ULandscapeHeightfieldCollisionComponent
Type class
Header File /Engine/Source/Runtime/Landscape/Classes/LandscapeHeightfieldCollisionComponent.h
Include Path #include "LandscapeHeightfieldCollisionComponent.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
  LandscapeHeightfieldCollisionComponent.h  
  LandscapeHeightfieldCollisionComponent.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~ULandscapeHeightfieldCollisionComponent()

   LandscapeHeightfieldCollisionComponent.h  

Structs

Name Remarks
FCollisionSampleInfo  
FHeightfieldGeometryRef  
FWriteRuntimeDataParams  

Enums

Public

Name Remarks
ECollisionQuadFlags  

Variables

Public

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

Protected

Name Type Remarks Include Path Unreal Specifiers
bEnableCollisionHashOptim bool   LandscapeHeightfieldCollisionComponent.h  
RenderComponentRef TObjectPtr< ULandscapeComponent > Reference to render component LandscapeHeightfieldCollisionComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool AllowsAsyncPhysicsStateCreation()

   LandscapeHeightfieldCollisionComponent.h  

virtual void ApplyWorldOffset ( const FVector& InOffset,
bool bWorldShift
)

   LandscapeHeightfieldCollisionComponent.h  

virtual void BeginDestroy()

   LandscapeHeightfieldCollisionComponent.h  

virtual FBoxSphereBounds CalcBounds ( const FTransform& BoundTransform
) const

   LandscapeHeightfieldCollisionComponent.h  

virtual uint32 ComputeCollisionHash()

 Computes a hash of all the data that will impact final collision LandscapeHeightfieldCollisionComponent.h  

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

   LandscapeHeightfieldCollisionComponent.h  

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. LandscapeHeightfieldCollisionComponent.h  

virtual void CreateCollisionObject ()

 Creates collision object from a cooked collision data LandscapeHeightfieldCollisionComponent.h  

virtual FPrimitiveSceneProxy * CreateSceneProxy()

 The scene proxy is only for debug purposes : LandscapeHeightfieldCollisionComponent.h  

virtual void DestroyComponent ( bool bPromoteChildren
)

   LandscapeHeightfieldCollisionComponent.h  

virtual bool DoCustomNavigableGeometryExport ( FNavigableGeometryExport& GeomExport
) const

   LandscapeHeightfieldCollisionComponent.h  

virtual void ExportCustomProperties ( FOutputDevice& Out,
uint32 Indent
)

   LandscapeHeightfieldCollisionComponent.h  

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

 Populates a supplied array with the heights from the heightfield. LandscapeHeightfieldCollisionComponent.h  

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

   LandscapeHeightfieldCollisionComponent.h  

virtual void GatherGeometrySlice ( FNavigableGeometryExport& GeomExport,
const FBox& SliceBox
) const

   LandscapeHeightfieldCollisionComponent.h  

bool GenerateCollisionData ( const FWriteRuntimeDataParams& Params,
Chaos::FHeightFieldPtr& OutHeightField,
bool bGenerateSimpleCollision,
Chaos::FHeightFieldPtr& OutSimpleHeightField,
TArray< UPhysicalMaterial* >& InOutMaterials
) const

   LandscapeHeightfieldCollisionComponent.h  

bool GenerateCollisionObjects ( const FName& Format,
bool bUseDefaultMaterialOnly,
Chaos::FHeightFieldPtr& OutHeightField,
bool bGenerateSimpleCollision,
Chaos::FHeightFieldPtr& OutSimpleHeightField,
TArray< UPhysicalMaterial* >& InOutMaterials
) const

 Cooks raw height data into collision object binary stream LandscapeHeightfieldCollisionComponent.h  

virtual ECollisionEnabled::Type GetCollisionEnabled()

   LandscapeHeightfieldCollisionComponent.h  

virtual ECollisionChannel GetCollisionObjectType()

   LandscapeHeightfieldCollisionComponent.h  

virtual ECollisionResponse GetCollisionResponseToChannel ( ECollisionChannel Channel
) const

   LandscapeHeightfieldCollisionComponent.h  

virtual const FCollisionResponseContainer & GetCollisionResponseToChannels()

   LandscapeHeightfieldCollisionComponent.h  

FCollisionSampleInfo GetCollisionSampleInfo()

   LandscapeHeightfieldCollisionComponent.h  

virtual ENavDataGatheringMode GetGeometryGatheringMode()

   LandscapeHeightfieldCollisionComponent.h  

TOptional< float > GetHeight ( float X,
float Y,
EHeightfieldSource HeightFieldSource
)

   LandscapeHeightfieldCollisionComponent.h  

ULandscapeInfo * GetLandscapeInfo()

 Gets the landscape info object for this landscape LandscapeHeightfieldCollisionComponent.h  

ALandscapeProxy * GetLandscapeProxy()

 Return the landscape actor associated with this component. LandscapeHeightfieldCollisionComponent.h  

UPhysicalMaterial * GetPhysicalMaterial ( float X,
float Y,
EHeightfieldSource HeightFieldSource
)

   LandscapeHeightfieldCollisionComponent.h  

ULandscapeComponent * GetRenderComponent()

 Returns associated landscape component LandscapeHeightfieldCollisionComponent.h
  • BlueprintCallable
  • Category="Landscape"

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

   LandscapeHeightfieldCollisionComponent.h  

FIntPoint GetSectionBase()

   LandscapeHeightfieldCollisionComponent.h  

virtual void ImportCustomProperties ( const TCHAR* SourceText,
FFeedbackContext* Warn
)

   LandscapeHeightfieldCollisionComponent.h  

virtual bool IsShown ( const FEngineShowFlags& ShowFlags
) const

   LandscapeHeightfieldCollisionComponent.h  

FWriteRuntimeDataParams MakeWriteRuntimeDataParams ( bool bUseDefaultMaterialOnly
) const

 Set up params to call WriteRuntimeData using editor data members. LandscapeHeightfieldCollisionComponent.h  

virtual bool NeedsLoadForClient()

   LandscapeHeightfieldCollisionComponent.h  

virtual bool NeedsLoadForServer()

   LandscapeHeightfieldCollisionComponent.h  

virtual void OnRegister()

   LandscapeHeightfieldCollisionComponent.h  

virtual void OnUnregister()

   LandscapeHeightfieldCollisionComponent.h  

virtual void PostLoad()

   LandscapeHeightfieldCollisionComponent.h  

virtual void PrepareGeometryExportSync()

   LandscapeHeightfieldCollisionComponent.h  

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

   LandscapeHeightfieldCollisionComponent.h  

virtual bool RecreateCollision()

 Recreate heightfield and restart physics LandscapeHeightfieldCollisionComponent.h  

virtual void Serialize ( FArchive& Ar
)

   LandscapeHeightfieldCollisionComponent.h  

void SetRenderComponent ( ULandscapeComponent* InRenderComponent
)

   LandscapeHeightfieldCollisionComponent.h  

void SetSectionBase ( FIntPoint InSectionBase
)

   LandscapeHeightfieldCollisionComponent.h  
  LandscapeHeightfieldCollisionComponent.h  

void SnapFoliageInstances ( const FBox& InInstanceBox
)

 Called from editor code to manage foliage instances on landscape. LandscapeHeightfieldCollisionComponent.h  

void SpeculativelyLoadAsyncDDCCollsionData()

 We speculatively async load collision object from DDC to remove hitch when streaming LandscapeHeightfieldCollisionComponent.h  

virtual bool SupportsGatheringGeometrySlices()

   LandscapeHeightfieldCollisionComponent.h  

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

 Modify a sub-region of the physics heightfield. LandscapeHeightfieldCollisionComponent.h  

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

 Writes to a cooked data buffer using raw heightfield data. LandscapeHeightfieldCollisionComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void OnCreatePhysicsState()

   LandscapeHeightfieldCollisionComponent.h  

virtual void OnDestroyPhysicsState()

   LandscapeHeightfieldCollisionComponent.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
RenderComponent_DEPRECATED TLazyObjectPtr< ULandscapeComponent > Reference to render component LandscapeHeightfieldCollisionComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page