Navigation
Unreal Engine C++ API Reference > Runtime > Landscape
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
Type | Name | Description | |
---|---|---|---|
![]() |
bool[2] | bShouldSaveCookedDataToDDC | Flag to indicate that the next time we cook data, we should save it to the DDC. |
![]() |
FNavHeightfieldSamples | 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< TObjectPtr< ULandscapeLayerInfoObject > > | 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< TObjectPtr< UPhysicalMaterial > > | 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 Physics heightfield objects in the editor |
![]() |
TRefCountPtr< FHeightfieldGeometryRef > | HeightfieldRef | Physics engine version of heightfield data. |
![]() |
int32 | HeightfieldRowsCount | Cached PxHeightFieldSamples values for navmesh generation. |
![]() |
FByteBulkData | PhysicalMaterialRenderData | Indices for physical materials generated by the render material. Stripped from cooked content |
![]() |
TArray< TObjectPtr< UPhysicalMaterial > > | PhysicalMaterialRenderObjects | Physical materials objects referenced by the indices in PhysicalMaterialRenderData. |
![]() |
int32 | SectionBaseX | Offset of component in landscape quads |
![]() |
int32 | SectionBaseY | |
![]() |
int32 | SimpleCollisionSizeQuads | Size of component's "simple collision" in collision quads |
![]() |
TSharedPtr< FAsyncPreRegisterDDCRequest > | SpeculativeDDCRequest | Async DCC load for cooked collision representation. |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
ULandscapeHeightfieldCollisionComponent
(
const FObjectInitializer& ObjectInitializer |
||
![]() |
ULandscapeHeightfieldCollisionComponent
(
FVTableHelper& Helper |
Destructors
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
Functions
Type | Name | Description | |
---|---|---|---|
![]() ![]() ![]() |
uint32 | Computes a hash of all the data that will impact final collision | |
![]() ![]() ![]() |
bool | CookCollisionData
(
const FName& Format, |
Cooks raw height data into collision object binary stream |
![]() |
void | CreateCollisionObject
(
bool bUseDefaultMaterialOnly, |
Creates collision object from raw runtime data. |
![]() ![]() |
void | Creates collision object from a cooked collision data | |
![]() ![]() |
bool | FillHeightTile
(
TArrayView< float > Heights, |
Populates a supplied array with the heights from the heightfield. |
![]() ![]() |
bool | FillMaterialIndexTile
(
TArrayView< uint8 > Materials, |
|
![]() ![]() |
void | GetCollisionSampleInfo
(
int32& OutCollisionSizeVerts, |
|
![]() |
TOptional< float > | GetHeight
(
float X, |
|
![]() ![]() |
ULandscapeInfo * | Gets the landscape info object for this landscape | |
![]() ![]() |
ALandscapeProxy * | Return the landscape actor associated with this component. | |
![]() ![]() |
ULandscapeComponent * | Returns associated landscape component | |
![]() ![]() |
FIntPoint | ||
![]() ![]() |
bool | Recreate heightfield and restart physics | |
![]() |
void | SetRenderComponent
(
ULandscapeComponent* InRenderComponent |
|
![]() |
void | SetSectionBase
(
FIntPoint InSectionBase |
|
![]() |
void | SnapFoliageInstances
(
const FBox& InInstanceBox |
Called from editor code to manage foliage instances on landscape. |
![]() |
void | ||
![]() |
void | We speculatively async load collision object from DDC to remove hitch when streaming | |
![]() |
void | UpdateHeightfieldRegion
(
int32 ComponentX1, |
Modify a sub-region of the physics heightfield. |
![]() ![]() |
bool | WriteRuntimeData
(
const FWriteRuntimeDataParams& Params, |
Writes to a cooked data buffer using raw heightfield data. |
Overridden from UPrimitiveComponent
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
FPrimitiveSceneProxy * | The scene proxy is only for debug purposes : | |
![]() ![]() ![]() |
bool | DoCustomNavigableGeometryExport
(
FNavigableGeometryExport& GeomExport |
Collects custom navigable geometry of component. |
![]() ![]() ![]() |
bool | IsShown
(
const FEngineShowFlags& ShowFlags |
Would this primitive be shown with these rendering flags. |
Overridden from USceneComponent
Type | Name | Description | |
---|---|---|---|
![]() ![]() ![]() |
FBoxSphereBounds | CalcBounds
(
const FTransform& LocalToWorld |
Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size. |
![]() ![]() ![]() |
ECollisionEnabled::Type | Returns the form of collision for this component | |
![]() ![]() ![]() |
ECollisionChannel | Gets the collision object type | |
![]() ![]() ![]() |
ECollisionResponse | GetCollisionResponseToChannel
(
ECollisionChannel Channel |
Gets the response type given a specific channel |
![]() ![]() ![]() |
const FCollisionResponseContainer & | Return const reference to CollsionResponseContainer |
Overridden from UActorComponent
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
void | ApplyWorldOffset
(
const FVector& InOffset, |
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 | Used to create any physics engine information for this component | |
![]() ![]() |
void | 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
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
void | BeginDestroy () |
Called before destroying the object. |
![]() ![]() |
void | ExportCustomProperties
(
FOutputDevice& Out, |
Exports the property values for the specified object as text to the output device. |
![]() ![]() |
void | GetResourceSizeEx
(
FResourceSizeEx& CumulativeResourceSize |
Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific). |
![]() ![]() |
void | ImportCustomProperties
(
const TCHAR* SourceText, |
Exports the property values for the specified object as text to the output device. |
![]() ![]() |
void | 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
(
FObjectPreSaveContext SaveContext |
Presave function. |
![]() ![]() |
void | Handles reading, writing, and reference collecting using FArchive. |
Overridden from INavRelevantInterface
Type | Name | Description | |
---|---|---|---|
![]() ![]() ![]() |
void | GatherGeometrySlice
(
FNavigableGeometryExport& GeomExport, |
This function is called "on demand", whenever that specified piece of geometry is needed for navigation generation |
![]() ![]() ![]() |
ENavDataGatheringMode | ||
![]() ![]() |
void | Called on Game-thread to give implementer a change to perform actions that require game-thread to run, for example precaching physics data | |
![]() ![]() ![]() |
bool | If this instance knows how to export sub-sections of self |
Classes
Type | Name | Description | |
---|---|---|---|
![]() |
FHeightfieldGeometryRef | ||
![]() |
FWriteRuntimeDataParams |
Enums
Type | Name | Description | |
---|---|---|---|
![]() |
ECollisionQuadFlags |
Deprecated Variables
Type | Name | Description | |
---|---|---|---|
![]() |
TLazyObjectPtr< ULandscapeComponent > | RenderComponent_DEPRECATED | Reference to render component |
Deprecated Functions
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid | PreSave
(
const ITargetPlatform* TargetPlatform |
Use version that takes FObjectPreSaveContext instead. |