1. Epic GamesDeveloper
  3. UPCGLandscapeData

UPCGLandscapeData

Landscape data access abstraction for PCG.

API > API/Plugins > API/Plugins/PCG

Landscape data access abstraction for PCG. Supports multi-landscape access, but it assumes that they are not overlapping.

   
Name UPCGLandscapeData
Type class
Header File /Engine/Plugins/PCG/Source/PCG/Public/Data/PCGLandscapeData.h
Include Path #include "Data/PCGLandscapeData.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, ClassGroup=(Procedural))  
class UPCGLandscapeData : public UPCGSurfaceData

Inheritance Hierarchy

Typedefs

Name Type Remarks Include Path
TypeInfo FPCGDataTypeInfoLandscape   Data/PCGLandscapeData.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Landscapes TArray< TSoftObjectPtr< ALandscapeProxy > > TODO: add on property changed to clear cached data. This is used to populate the LandscapeInfos array. Data/PCGLandscapeData.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=SourceData

Protected

Name Type Remarks Include Path Unreal Specifiers
BoundsToLandscapeInfos TArray< TPair< FBox, ULandscapeInfo * > > Transient data. Data/PCGLandscapeData.h  
LandscapeCache UPCGLandscapeCache *   Data/PCGLandscapeData.h  
LandscapeInfos TArray< ULandscapeInfo * >   Data/PCGLandscapeData.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CanSampleVirtualTextureNormals()

   Data/PCGLandscapeData.h  

bool CanSampleVirtualTextures()

   Data/PCGLandscapeData.h  

void Initialize ( const TArray< TWeakObjectPtr< ALandscapeProxy > >& InLandscapes,
const FBox& InBounds,
const FPCGLandscapeDataProps& InDataProps
)

   Data/PCGLandscapeData.h  

bool IsUsingMetadata()

   Data/PCGLandscapeData.h  

Overridden from UPCGSpatialDataWithPointCache

Name Remarks Include Path Unreal Specifiers

virtual const UPCGPointArrayData * CreatePointArrayData ( FPCGContext* Context,
const FBox& InBounds
) const

   Data/PCGLandscapeData.h  

virtual const UPCGPointData * CreatePointData ( FPCGContext* Context
) const

   Data/PCGLandscapeData.h  

virtual const UPCGPointData * CreatePointData ( FPCGContext* Context,
const FBox& InBounds
) const

   Data/PCGLandscapeData.h  

virtual bool SupportsBoundedPointData()

   Data/PCGLandscapeData.h  

Overridden from UPCGSpatialData

Name Remarks Include Path Unreal Specifiers

virtual FBox GetBounds()

 Returns the full bounds (including density fall-off) of the data Data/PCGLandscapeData.h  

virtual FBox GetStrictBounds()

 Returns the bounds in which the density is always 1 Data/PCGLandscapeData.h  

virtual bool HasNonTrivialTransform()

 Returns true if the data has a non-trivial transform Data/PCGLandscapeData.h  

virtual void InitializeTargetMetadata ( const FPCGInitializeFromDataParams& InParams,
UPCGMetadata* MetadataToInitialize
) const

 Initialize another metadata from this data. Data/PCGLandscapeData.h  

virtual TArray< FPCGTaskId > PrepareForSpatialQuery ( FPCGContext* InContext,
const FBox& InBounds
) const

 Optionally return a list of scheduled tasks that will prepare the data for spatial queries. Data/PCGLandscapeData.h  

virtual bool ProjectPoint ( const FTransform& InTransform,
const FBox& InBounds,
const FPCGProjectionParams& InParams,
FPCGPoint& OutPoint,
UPCGMetadata* OutMetadata
) const

 Project the query point onto this data, and sample point and metadata information at the projected position. Data/PCGLandscapeData.h  

virtual bool SamplePoint ( const FTransform& Transform,
const FBox& Bounds,
FPCGPoint& OutPoint,
UPCGMetadata* OutMetadata
) const

 Sample rotation, scale and other attributes from this data at the query position. Data/PCGLandscapeData.h  

virtual void SamplePoints ( const TArrayView< const TPair< FTransform, FBox > >& Samples,
const TArrayView< FPCGPoint >& OutPoints,
UPCGMetadata* OutMetadata
) const

 Performs multiple samples at the same time. Data/PCGLandscapeData.h  

Overridden from UPCGData

Name Remarks Include Path Unreal Specifiers

virtual void AddToCrc ( FArchiveCrc32& Ar,
bool bFullDataCrc
) const

 Adds this data to Crc. Data/PCGLandscapeData.h  

virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSEPCGDataType GetDataType()

 @todo_pcg To be deprecated when we switch to the new type Data/PCGLandscapeData.h  

virtual const FPCGDataTypeBaseId & GetDataTypeId()

   Data/PCGLandscapeData.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

   Data/PCGLandscapeData.h  

Protected

Name Remarks Include Path Unreal Specifiers

const UPCGBasePointData * CreateBasePointData ( FPCGContext* Context,
const FBox& InBounds,
TSubclassOf< UPCGBasePointData > PointDataClass
) const

   Data/PCGLandscapeData.h  

const ULandscapeInfo * GetLandscapeInfo ( const FVector& InPosition
) const

 Returns the landscape info associated to the first landscape that contains the given position Note that this implicitly removes support for overlapping landscapes, which might be a future TODO Data/PCGLandscapeData.h  

Overridden from UPCGSpatialData

Name Remarks Include Path Unreal Specifiers

virtual UPCGSpatialData * CopyInternal ( FPCGContext* Context
) const

   Data/PCGLandscapeData.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bHeightOnly_DEPRECATED bool   Data/PCGLandscapeData.h  
bUseMetadata_DEPRECATED bool   Data/PCGLandscapeData.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page