1. Epic GamesDeveloper
  3. UPCGSpatialData

UPCGSpatialData

"Concrete" data base class for PCG generation This will be the base class for data classes that actually represent concrete evidence of spatial data - points, surfaces, splines, etc.

API > API/Plugins > API/Plugins/PCG > API/Plugins/PCG/Data

Inheritance Hierarchy

References

   
Module PCG
Header /Engine/Plugins/Experimental/PCG/Source/PCG/Public/Data/PCGSpatialData.h
Include #include "Data/PCGSpatialData.h"

Syntax

UCLASS&40;Abstract, BlueprintType, ClassGroup&61;&40;Procedural&41;&41;  
class UPCGSpatialData : public UPCGData

Remarks

"Concrete" data base class for PCG generation This will be the base class for data classes that actually represent concrete evidence of spatial data - points, surfaces, splines, etc. In opposition to settings/control type of data.

Conceptually, any concrete data can be decayed into points (potentially through transformations) which hold metadata and a transform, and this is the basic currency of the PCG framework.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite Transient bool bKeepZeroDensityPoints  
Public variable UProperty Category visibleanywhere TObjectPtr< UPCGMetadata > Metadata Not accessible through blueprint to make sure the constness is preserved.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite Transient TWeakObjectPtr< AActor > TargetActor Recipient of any artifacts generated using this data.

Constructors

  Type Name Description
Public function  

UPCGSpatialData ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const UFunction BlueprintCallable, Category const UPCGMetadata *  
Protected function Virtual Const UPCGSpatialData *  
Public function UFunction BlueprintCallable, Category, Meta UPCGMetadata *  
Public function Const UPCGSpatialData *

DuplicateData ( const bool bInitializeMetadata
)

 Virtual call to allocate a new spacial data object, duplicate this spatial data into and parent the new metadata with this class metadata (if asked).
Public function Virtual Const const UPCGSpatialData * Find the first concrete (non-composite) shape in the network. Depth first search.
Public function Virtual Const UFunction BlueprintCallable, Category FBox Returns the full bounds (including density fall-off) of the data
Public function Virtual Const UFunction BlueprintCallable, Category float

GetDensityAtPosition ( const FVector& InPosition
)

 Computes the density at a given location
Public function Virtual Const UFunction BlueprintCallable, Category int Returns the dimension of the data type, which has nothing to do with the dimension of its points
Public function Virtual Const UFunction BlueprintCallable, Category FVector Returns the expected data normal (for surfaces) or eventual projection axis (for volumes)
Public function Virtual Const UFunction BlueprintCallable, Category FBox Returns the bounds in which the density is always 1
Public function Virtual Const UFunction BlueprintCallable, Category bool Returns true if the data has a non-trivial transform
Public function UFunction BlueprintCallable, Category void

InitializeFromData ( const UPCGSpatialData* InSource,
const UPCGMetadata* InMetadataParentOverride,
bool bInheritMetadata,
bool bInheritAttributes
)

  
Public function Virtual Const UFunction BlueprintCallable, Category UPCGIntersectionData *

IntersectWith ( const UPCGSpatialData* InOther
)

 Returns a specialized data to intersect with another data
Public function Virtual Const bool Returns whether a given spatial data is bounded as some data types do not require bounds by themselves
Public function UFunction BlueprintCallable, Category UPCGMetadata *  
Public function Virtual Const UFunction BlueprintCallable, Category, Meta UPCGSpatialData *

ProjectOn ( const UPCGSpatialData* InOther,
const FPCGProjectionParams& InParams
)

 Returns a specialized data to project this on another data of equal or higher dimension.
Public function Virtual Const UFunction BlueprintCallable, Category bool

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

 Project the query point onto this data, and sample point and metadata information at the projected position.
Public function Virtual Const bool True if this operation does not have an inverse and cannot be queried analytically/implicitly, and therefore must be collapsed to an explicit point representation.
Public function Virtual Const UFunction BlueprintCallable, Category bool

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

 Sample rotation, scale and other attributes from this data at the query position.
Public function Virtual Const UFunction BlueprintCallable, Category UPCGDifferenceData *

Subtract ( const UPCGSpatialData* InOther
)

  
Public function Const UFunction BlueprintCallable, Category, Meta const UPCGPointData * Discretizes the data into points
Public function Virtual Const const UPCGPointData *

ToPointData ( FPCGContext* Context,
const FBox& InBounds
)

  
Public function Const UFunction BlueprintCallable, Category const UPCGPointData *  
Public function Virtual Const UFunction BlueprintCallable, Category UPCGUnionData *

UnionWith ( const UPCGSpatialData* InOther
)

 Returns a specialized data to union this with another data

Overridden from UPCGData

  Type Name Description
Public function Virtual Const FPCGAttributePropertyInputSelector  
Public function Virtual Const EPCGDataType  
Public function Virtual Const bool  
Public function Virtual void  

Overridden from UObject

  Type Name Description
Public function Virtual 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).

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page