1. Epic GamesDeveloper
  3. UPCGBasePointData

UPCGBasePointData

API > API/Plugins > API/Plugins/PCG

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

Syntax

UCLASS (MinimalAPI, Abstract, BlueprintType, ClassGroup=(Procedural))  
class UPCGBasePointData : public UPCGSpatialData

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UPCGBasePointData ( const FObjectInitializer& ObjectInitializer
)

   Data/PCGBasePointData.h  

Typedefs

Name Type Remarks Include Path
TypeInfo FPCGDataTypeInfoPoint   Data/PCGBasePointData.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddSinglePointFromActor ( AActor* InActor,
bool* bOutOptionalSanitizedTagAttributeName
)

 Adds a single point based on the given actor Data/PCGBasePointData.h  

virtual void AllocateProperties ( EPCGPointNativeProperties Properties
)

   Data/PCGBasePointData.h  

void BP_AllocateProperties ( int32 Properties
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData
  • Meta=(DisplayName="Allocate Properties")

void BP_SetPointsFrom ( const UPCGBasePointData* InData,
const TArray< int32 >& InDataIndices
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData
  • Meta=(DisplayName="Set Points From")

virtual void CopyPointsTo ( UPCGBasePointData* To,
int32 ReadStartIndex,
int32 WriteStartIndex,
int32 Count
) const

   Data/PCGBasePointData.h  

virtual void CopyPointsTo ( UPCGBasePointData* To,
const TArrayView< const int32 >& ReadIndices,
const TArrayView< const int32 >& WriteIndices
) const

   Data/PCGBasePointData.h  

virtual void CopyPropertiesTo ( UPCGBasePointData* To,
int32 ReadStartIndex,
int32 WriteStartIndex,
int32 Count,
EPCGPointNativeProperties Properties
) const

   Data/PCGBasePointData.h  

virtual void CopyPropertiesTo ( UPCGBasePointData* To,
const TArrayView< const int32 >& ReadIndices,
const TArrayView< const int32 >& WriteIndices,
EPCGPointNativeProperties Properties
) const

   Data/PCGBasePointData.h  

virtual void CopyUnallocatedPropertiesFrom ( const UPCGBasePointData* InPointData
)

   Data/PCGBasePointData.h  

virtual void FreeProperties ( EPCGPointNativeProperties Properties
)

   Data/PCGBasePointData.h  

virtual EPCGPointNativeProperties GetAllocatedProperties ( bool bWithInheritance
) const

   Data/PCGBasePointData.h  

virtual const FVector & GetBoundsMax ( int32 InPointIndex
) const

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

virtual FPCGPointBoundsMax::ValueRange GetBoundsMaxValueRange ( bool bAllocate
)

   Data/PCGBasePointData.h  

virtual const FVector & GetBoundsMin ( int32 InPointIndex
) const

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

virtual FPCGPointBoundsMin::ValueRange GetBoundsMinValueRange ( bool bAllocate
)

   Data/PCGBasePointData.h  

virtual const FVector4 & GetColor ( int32 InPointIndex
) const

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

virtual FPCGPointColor::ValueRange GetColorValueRange ( bool bAllocate
)

   Data/PCGBasePointData.h  

virtual FPCGPointBoundsMax::ConstValueRange GetConstBoundsMaxValueRange()

   Data/PCGBasePointData.h  

virtual FPCGPointBoundsMin::ConstValueRange GetConstBoundsMinValueRange()

   Data/PCGBasePointData.h  

virtual FPCGPointColor::ConstValueRange GetConstColorValueRange()

   Data/PCGBasePointData.h  

virtual FPCGPointDensity::ConstValueRange GetConstDensityValueRange()

   Data/PCGBasePointData.h  

virtual FPCGPointMetadataEntry::ConstValueRange GetConstMetadataEntryValueRange()

   Data/PCGBasePointData.h  

virtual FPCGPointSeed::ConstValueRange GetConstSeedValueRange()

   Data/PCGBasePointData.h  

virtual FPCGPointSteepness::ConstValueRange GetConstSteepnessValueRange()

   Data/PCGBasePointData.h  

virtual FPCGPointTransform::ConstValueRange GetConstTransformValueRange()

   Data/PCGBasePointData.h  
  Data/PCGBasePointData.h  

TConstPCGValueRange< T > GetConstValueRange ( EPCGPointNativeProperties NativeProperty
) const

 Keeping for backward compatibility (prefer using enum template version) Data/PCGBasePointData.h  

virtual const float & GetDensity ( int32 InPointIndex
) const

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

virtual FBoxSphereBounds GetDensityBounds ( int32 InPointIndex
) const

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

virtual FPCGPointDensity::ValueRange GetDensityValueRange ( bool bAllocate
)

   Data/PCGBasePointData.h  

virtual FVector GetExtents ( int32 InPointIndex
) const

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

virtual FBox GetLocalBounds ( int32 InPointIndex
) const

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

virtual FVector GetLocalCenter ( int32 InPointIndex
) const

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

virtual FBox GetLocalDensityBounds ( int32 InPointIndex
) const

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

virtual FVector GetLocalSize ( int32 InPointIndex
) const

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

virtual const int64 & GetMetadataEntry ( int32 InPointIndex
) const

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

virtual FPCGPointMetadataEntry::ValueRange GetMetadataEntryValueRange ( bool bAllocate
)

   Data/PCGBasePointData.h  

virtual int32 GetNumPoints()

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

virtual const PCGPointOctree::FPointOctree & GetPointOctree()

   Data/PCGBasePointData.h  

const TPCGPointNativeProperty< Property >::Type & GetPointPropertyValue ( int32 InPointIndex
) const

   Data/PCGBasePointData.h  

virtual FVector GetScaledExtents ( int32 InPointIndex
) const

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

virtual FVector GetScaledLocalSize ( int32 InPointIndex
) const

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

virtual const int32 & GetSeed ( int32 InPointIndex
) const

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

virtual FPCGPointSeed::ValueRange GetSeedValueRange ( bool bAllocate
)

   Data/PCGBasePointData.h  

virtual const float & GetSteepness ( int32 InPointIndex
) const

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

virtual FPCGPointSteepness::ValueRange GetSteepnessValueRange ( bool bAllocate
)

   Data/PCGBasePointData.h  

virtual const FTransform & GetTransform ( int32 InPointIndex
) const

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

virtual TArray< FTransform > GetTransformsCopy()

   Data/PCGBasePointData.h  

virtual FPCGPointTransform::ValueRange GetTransformValueRange ( bool bAllocate
)

   Data/PCGBasePointData.h  

TPCGValueRange< T > GetValueRange ( EPCGPointNativeProperties NativeProperty,
bool bAllocate
)

 Keeping for backward compatibility (prefer using enum template version) Data/PCGBasePointData.h  

TPCGPointNativeProperty< Property >::ValueRange GetValueRange ( bool bAllocate
)

   Data/PCGBasePointData.h  

void InitializeFromActor ( AActor* InActor,
bool* bOutOptionalSanitizedTagAttributeName
)

 Initializes a single point based on the given actor Data/PCGBasePointData.h  

bool IsEmpty()

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

virtual bool IsPointOctreeDirty ()

 Get the dirty status of the Octree. Data/PCGBasePointData.h  

virtual bool IsValidRef ( const PCGPointOctree::FPointRef& InPointRef
) const

   Data/PCGBasePointData.h  

virtual void MoveRange ( int32 RangeStartIndex,
int32 MoveToIndex,
int32 NumElements
)

   Data/PCGBasePointData.h  

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

   Data/PCGBasePointData.h  

virtual void SetBoundsMax ( const FVector& InBoundsMax
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData
  • Meta=(DisplayName="Set All Bounds Max", ToolTip="Set all bounds max to same value")

virtual void SetBoundsMin ( const FVector& InBoundsMin
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData
  • Meta=(DisplayName="Set All Bounds Min", ToolTip="Set all bounds min to same value")

virtual void SetColor ( const FVector4& InColor
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData
  • Meta=(DisplayName="Set All Colors", ToolTip="Set all colors to same value")

virtual void SetDensity ( float InDensity
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData
  • Meta=(DisplayName="Set All Densities", ToolTip="Set all densities to same value")

virtual void SetExtents ( const FVector& InExtents
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData
  • Meta=(DisplayName="Set All Extents", ToolTip="Set all extents to same value")

virtual void SetLocalCenter ( const FVector& InLocalCenter
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData
  • Meta=(DisplayName="Set All Local Centers", ToolTip="Set all local centers to same value")

virtual void SetMetadataEntry ( int64 InMetadataEntry
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData
  • Meta=(DisplayName="Set All Metadata Entries", ToolTip="Set all metadata entries to same value")

virtual void SetNumPoints ( int32 InNumPoints,
bool bInitializeValues
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

void SetPointPropertyValues ( const typename TPCGPointNativeProperty< Property >::Type& InValue
)

   Data/PCGBasePointData.h  

void SetPointsFrom ( const UPCGBasePointData* InData,
const TArrayView< const int32 >& InDataIndices
)

   Data/PCGBasePointData.h  

virtual void SetSeed ( int32 InSeed
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData
  • Meta=(DisplayName="Set All Seeds", ToolTip="Set all seeds to same value")

virtual void SetSteepness ( float InSteepness
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData
  • Meta=(DisplayName="Set All Steepness", ToolTip="Set all steepness to same value")

virtual void SetTransform ( const FTransform& InTransform
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData
  • Meta=(DisplayName="Set All Transforms", ToolTip="Set all transforms to same value")

Overridden from UPCGSpatialData

Name Remarks Include Path Unreal Specifiers

virtual FBox GetBounds()

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

virtual int GetDimension()

 Returns the dimension of the data type, which has nothing to do with the dimension of its points Data/PCGBasePointData.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/PCGBasePointData.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/PCGBasePointData.h  

Overridden from UPCGData

Name Remarks Include Path Unreal Specifiers

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

 Adds this data to Crc. Data/PCGBasePointData.h  

virtual void Flatten()

 Make a pass on Metadata to flatten parenting and only keep entries used by points. Data/PCGBasePointData.h  
Returns all the supported domain for this data. Data/PCGBasePointData.h  

virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSEPCGDataType GetDataType()

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

virtual const FPCGDataTypeBaseId & GetDataTypeId()

   Data/PCGBasePointData.h  

virtual FPCGMetadataDomainID GetDefaultMetadataDomainID()

 Metadata specific Data/PCGBasePointData.h  
Return the associated domain ID for a given domain name in the selector. Data/PCGBasePointData.h  

virtual bool SetDomainFromDomainID ( const FPCGMetadataDomainID& InDomainID,
FPCGAttributePropertySelector& InOutSelector
) const

 Write the domain name into the selector associated with this domain ID. Data/PCGBasePointData.h  

virtual bool SupportsFullDataCrc()

 Whether the data distinguishes between regular crc and full crc Data/PCGBasePointData.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

   Data/PCGBasePointData.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void DirtyCache()

   Data/PCGBasePointData.h  

void RebuildOctree()

   Data/PCGBasePointData.h  

void RebuildOctreeIfNeeded()

   Data/PCGBasePointData.h  

void RecomputeBounds()

   Data/PCGBasePointData.h  

void RecomputeBoundsIfNeeded()

   Data/PCGBasePointData.h  

Static

Name Remarks Include Path Unreal Specifiers

static TArray< FVector > GetBoundsMaxValuesFromRange ( const FPCGPointInputRange& InputRange
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

static TArray< FVector > GetBoundsMinValuesFromRange ( const FPCGPointInputRange& InputRange
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

static TArray< FVector4 > GetColorValuesFromRange ( const FPCGPointInputRange& InputRange
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

static TArray< float > GetDensityValuesFromRange ( const FPCGPointInputRange& InputRange
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

static TArray< int64 > GetMetadataEntryValuesFromRange ( const FPCGPointInputRange& InputRange
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

static FPCGAttributeAccessorMethods GetPointAccessorMethods()

 Get the functions to the accessor factory. Data/PCGBasePointData.h  

static FPCGPoint GetPointFromRange ( const FPCGPointInputRange& InputRange,
int32 Index
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

static EPCGPointNativeProperties GetPropertiesToAllocateFromPointData ( const TArray< const UPCGBasePointData* >& PointDatas
)

   Data/PCGBasePointData.h  

static TArray< int32 > GetSeedValuesFromRange ( const FPCGPointInputRange& InputRange
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

static TArray< float > GetSteepnessValuesFromRange ( const FPCGPointInputRange& InputRange
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

static TArray< FTransform > GetTransformValuesFromRange ( const FPCGPointInputRange& InputRange
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

static bool NeedToAllocateSingleValueProperty ( const TArray< const UPCGBasePointData* >& PointDatas
)

   Data/PCGBasePointData.h  

static void SetBoundsMaxValuesOnRange ( FPCGPointOutputRange& OutputRange,
const TArray< FVector >& Values
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

static void SetBoundsMinValuesOnRange ( FPCGPointOutputRange& OutputRange,
const TArray< FVector >& Values
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

static void SetColorValuesOnRange ( FPCGPointOutputRange& OutputRange,
const TArray< FVector4 >& Values
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

static void SetDensityValuesOnRange ( FPCGPointOutputRange& OutputRange,
const TArray< float >& Values
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

static void SetMetadataEntryValuesOnRange ( FPCGPointOutputRange& OutputRange,
const TArray< int64 >& Values
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

static void SetPointOnRange ( FPCGPointOutputRange& OutputRange,
int32 Index,
const FPCGPoint& Point
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

static void SetPoints ( const UPCGBasePointData* From,
UPCGBasePointData* To,
const TArrayView< const int32 >& InDataIndices,
bool bCopyAll
)

   Data/PCGBasePointData.h  

static void SetSeedValuesOnRange ( FPCGPointOutputRange& OutputRange,
const TArray< int32 >& Values
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

static void SetSteepnessValuesOnRange ( FPCGPointOutputRange& OutputRange,
const TArray< float >& Values
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

static void SetTransformValuesOnRange ( FPCGPointOutputRange& OutputRange,
const TArray< FTransform >& Values
)

   Data/PCGBasePointData.h
  • BlueprintCallable
  • Category=SpatialData

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page