1. Epic GamesDeveloper
  3. UPCGMetadata

UPCGMetadata

API > API/Plugins > API/Plugins/PCG > API/Plugins/PCG/Metadata

Inheritance Hierarchy

  • UObject
  • UPCGMetadata

References

   
Module PCG
Header /Engine/Plugins/PCG/Source/PCG/Public/Metadata/PCGMetadata.h
Include #include "Metadata/PCGMetadata.h"

Syntax

UCLASS (BlueprintType)  
class UPCGMetadata : public UObject

Variables

  Type Name Description
Protected variable FRWLock AttributeLock  
Protected variable TMap< FName, FPCGMetadataAttributeBase * > Attributes  
Public variable bool bool bAllowsInterpolation  
Public variable FName bool bAllowsInterpolation  
Public variable FQuat bool bAllowsInterpolation  
Public variable FString bool bAllowsInterpolation  
Public variable const FSoftObjectPath bool bAllowsInterpolation  
Public variable FVector4 bool bAllowsInterpolation  
Public variable const FSoftClassPath bool bAllowsInterpolation  
Public variable float bool bAllowsInterpolation  
Public variable FVector2D bool bAllowsInterpolation  
Public variable FTransform bool bAllowsInterpolation  
Public variable FRotator bool bAllowsInterpolation  
Public variable int64 bool bAllowsInterpolation  
Public variable int32 bool bAllowsInterpolation  
Public variable double bool bAllowsInterpolation  
Public variable FVector bool bAllowsInterpolation  
Public variable FVector2D bool bool bOverrideParent  
Public variable int32 bool bool bOverrideParent  
Public variable int64 bool bool bOverrideParent  
Public variable const FSoftClassPath bool bool bOverrideParent  
Public variable float bool bool bOverrideParent  
Public variable const FSoftObjectPath bool bool bOverrideParent  
Public variable FRotator bool bool bOverrideParent  
Public variable bool bool bool bOverrideParent  
Public variable double bool bool bOverrideParent  
Public variable FQuat bool bool bOverrideParent  
Public variable FName bool bool bOverrideParent  
Public variable FString bool bool bOverrideParent  
Public variable FVector bool bool bOverrideParent  
Public variable FVector4 bool bool bOverrideParent  
Public variable FTransform bool bool bOverrideParent  
Public variable int32 DefaultValue  
Public variable const FSoftObjectPath & DefaultValue  
Public variable const FSoftClassPath & DefaultValue  
Public variable int64 DefaultValue  
Public variable bool DefaultValue  
Public variable FString DefaultValue  
Public variable FTransform DefaultValue  
Public variable FQuat DefaultValue  
Public variable FName DefaultValue  
Public variable FVector2D DefaultValue  
Public variable float DefaultValue  
Public variable FVector4 DefaultValue  
Public variable FVector DefaultValue  
Public variable double DefaultValue  
Public variable FRotator DefaultValue  
Protected variable TAtomic< int64 > DelayedEntriesIndex  
Protected variable int64 ItemKeyOffset  
Protected variable FRWLock ItemLock  
Protected variable PCGMetadataAttributeKey NextAttributeId  
Protected variable UProperty TSet< TWeakObjectPtr< const UPCGMetadata > > OtherParents Set of parents kept for streams relationship and GC collection But otherwise not used directly
Protected variable UProperty TObjectPtr< const UPCGMetadata > Parent  
Protected variable TArray< PCGMetadataEntryKey > ParentKeys  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void

AccumulatePointWeightedAttributes ( const FPCGPoint& InPoint,
const UPCGMetadata* InMetadata,
float Weight,
bool bSetNonInterpolableAttributes,
UPARAM(ref) FPCGPoint& OutPoint
)

  
Public function void

AccumulateWeightedAttributes ( PCGMetadataEntryKey InKey,
const UPCGMetadata* InMetadata,
float Weight,
bool bSetNonInterpolableAttributes,
PCGMetadataEntryKey& OutKey
)

  
Public function UFunction BlueprintCallable, Category void

AccumulateWeightedAttributesByKey ( int64 Key,
const UPCGMetadata* Metadata,
float Weight,
bool bSetNonInterpolableAttributes,
int64 TargetKey,
int64& OutKey
)

  
Public function UFunction BlueprintCallable, Category void

AddAttribute ( const UPCGMetadata* InOther,
FName AttributeName
)

 Creates missing attribute from another metadata if it is not currently present - note that this does not copy values
Protected function void

AddAttributeInternal ( FName AttributeName,
FPCGMetadataAttributeBase* Attribute
)

  
Public function UFunction BlueprintCallable, Category void

AddAttributes ( const UPCGMetadata* InOther
)

 Creates missing attributes from another metadata if they are not currently present - note that this does not copy values
Public function UFunction BlueprintCallable, Category void

AddAttributesFiltered ( const UPCGMetadata* InOther,
const TSet< FName >& InFilteredAttributes,
EPCGMetadataFilterMode InFilterMode
)

 Creates missing attributes from another metadata if they are not currently present - note that this does not copy values.
Public function void

AddDelayedEntries ( const TArray< TTuple< int64, int64 > >& AllEntries
)

 Advanced method.
Public function UFunction BlueprintCallable, Category int64

AddEntry ( int64 ParentEntryKey
)

 Adds a unique entry key to the metadata
Public function int64 Advanced method.
Public function Virtual void  
Public function bool

ChangeAttributeType ( FName AttributeName,
int16 AttributeNewType
)

 Change type of an attribute
Public function UFunction BlueprintCallable, Category void

ClearAttribute ( FName AttributeToClear
)

 Clear/Reinit attribute
Public function void

ComputePointWeightedAttribute ( FPCGPoint& OutPoint,
const TArrayView< TPair< const FPCGPoint*, float > >& InWeightedPoints,
const UPCGMetadata* InMetadata
)

  
Public function void

ComputeWeightedAttribute ( PCGMetadataEntryKey& OutKey,
const TArrayView< TPair< PCGMetadataEntryKey, float > >& InWeightedKeys,
const UPCGMetadata* InMetadata
)

  
Protected function FPCGMetadataAttributeBase *

CopyAttribute ( FName AttributeToCopy,
FName NewAttributeName,
bool bKeepParent,
bool bCopyEntries,
bool bCopyValues
)

  
Public function FPCGMetadataAttributeBase *

CopyAttribute ( const FPCGMetadataAttributeBase* OriginalAttribute,
FName NewAttributeName,
bool bKeepParent,
bool bCopyEntries,
bool bCopyValues
)

 Copies another attribute, with options to keep its parent and copy entries/values
Public function UFunction BlueprintCallable, Category void

CopyAttribute ( const UPCGMetadata* InOther,
FName AttributeToCopy,
FName NewAttributeName
)

 Copies an attribute from another metadata, including entries & values.
Public function UFunction BlueprintCallable, Category void

CopyAttributes ( const UPCGMetadata* InOther
)

 Copies attributes from another metadata, including entries & values.
Public function UFunction BlueprintCallable, Category bool

CopyExistingAttribute ( FName AttributeToCopy,
FName NewAttributeName,
bool bKeepParent
)

 Copy attribute
Public function FPCGMetadataAttribute< T > *

CreateAttribute ( FName AttributeName,
const T& DefaultValue,
bool bAllowsInterpolation,
bool bOverrideParent
)

 Create a new attribute.
Public function bool

CreateAttributeFromDataProperty ( FName AttributeName,
const void* Data,
const FProperty* Property
)

 Creates an attribute given a property.
Public function bool

CreateAttributeFromProperty ( FName AttributeName,
const UObject* Object,
const FProperty* Property
)

 Creates an attribute given a property.
Public function UFunction BlueprintCallable, Category void

DeleteAttribute ( FName AttributeName
)

 Due to stream inheriting, we might want to consider "hiding" parent stream and deleting local streams only.
Public function FPCGMetadataAttribute< T > *

FindOrCreateAttribute ( FName AttributeName,
const T& DefaultValue,
bool bAllowsInterpolation,
bool bOverrideParent,
bool bOverwriteIfTypeMismatch
)

 Find or create an attribute.
Public function UFunction BlueprintCallable, Category void

Flatten ()

 Unparents current metadata by flattening the attributes (values, entries, etc.) and potentially compress the data to remove unused values.
Public function bool

FlattenAndCompress ( const TArray< PCGMetadataEntryKey >& InEntryKeysToKeep
)

 Unparents current metadata, flatten attribute and only keep the entries specified.
Public function void Unparents current metadata by flattening the attributes (values, entries, etc.)
Public function Const UFunction BlueprintCallable, Category int32 Return the number of attributes in this metadata.
Public function Const UFunction BlueprintCallable, Category void

GetAttributes ( TArray< FName >& AttributeNames,
TArray< EPCGMetadataTypes >& AttributeTypes
)

  
Public function Const const FPCGMetadataAttributeBase *

GetConstAttribute ( FName AttributeName
)

  
Public function Const const FPCGMetadataAttributeBase *

GetConstAttributeById ( int32 AttributeId
)

  
Public function Const const FPCGMetadataAttribute< T > *

GetConstTypedAttribute ( FName AttributeName
)

  
Public function Const UFunction BlueprintCallable, Category, Meta int64 Return the number of entries in metadata including the parent entries.
Public function Const int64  
Public function Const FName Returns name of the most recently created attribute, or none if no attributes are present.
Public function Const int64  
Public function FPCGMetadataAttributeBase *

GetMutableAttribute ( FName AttributeName
)

 Get attributes
Public function FPCGMetadataAttribute< T > *

GetMutableTypedAttribute ( FName AttributeName
)

  
Public function Const const UPCGMetadata *  
Public function Const PCGMetadataEntryKey Metadata chaining mechanism
Public function Const TWeakObjectPtr< const UPCGMetadata > Returns this metadata's parent
Public function Const const UPCGMetadata *

GetRoot ()

  
Public function Const UFunction BlueprintCallable, Category bool

HasAttribute ( FName AttributeName
)

  
Public function Const UFunction BlueprintCallable, Category bool

HasCommonAttributes ( const UPCGMetadata* InMetadata
)

  
Public function Const bool

HasParent ( const UPCGMetadata* InTentativeParent
)

  
Public function void

Initialize ( const UPCGMetadata* InParent,
bool bAddAttributesFromParent
)

 Initializes the metadata from a parent metadata, if any (can be null) with the option to not add attributes from the parent.
Public function UFunction BlueprintCallable, Category void

Initialize ( const UPCGMetadata* InParent
)

 Initializes the metadata from a parent metadata, if any (can be null).
Public function void

InitializeAsCopy ( const UPCGMetadata* InMetadataToCopy,
const TArray< PCGMetadataEntryKey >* InOptionalEntriesToCopy
)

 Initializes the metadata from a parent metadata by copying all attributes to it.
Public function void

InitializeAsCopyWithAttributeFilter ( const UPCGMetadata* InMetadataToCopy,
const TSet< FName >& InFilteredAttributes,
EPCGMetadataFilterMode InFilterMode,
const TArray< PCGMetadataEntryKey >* InOptionalEntriesToCopy
)

 Initializes the metadata from a parent metadata by copy filtered attributes only to it
Public function bool

InitializeOnSet ( PCGMetadataEntryKey& InOutKey,
PCGMetadataEntryKey InParentKeyA,
const UPCGMetadata* InParentMetadataA,
PCGMetadataEntryKey InParentKeyB,
const UPCGMetadata* InParentMetadataB
)

 Initializes the metadata entry key. Returns true if key set from either parent
Public function UFunction BlueprintCallable, Category void

InitializeWithAttributeFilter ( const UPCGMetadata* InParent,
const TSet< FName >& InFilteredAttributes,
EPCGMetadataFilterMode InFilterMode
)

 Initializes the metadata from a parent metadata. Copies attributes and values.
Public function UFunction BlueprintCallable, Category, Meta void

K2_InitializeAsCopy ( const UPCGMetadata* InMetadataToCopy,
const TArray< int64 >& InOptionalEntriesToCopy
)

 Initializes the metadata from a parent metadata by copying all attributes to it.
Public function UFunction BlueprintCallable, Category, Meta void

K2_InitializeAsCopyWithAttributeFilter ( const UPCGMetadata* InMetadataToCopy,
const TSet< FName >& InFilteredAttributes,
const TArray< int64 >& InOptionalEntriesToCopy,
EPCGMetadataFilterMode InFilterMode
)

 Initializes the metadata from a parent metadata by copy filtered attributes only to it
Public function void

MergeAttributes ( PCGMetadataEntryKey InKeyA,
const UPCGMetadata* InMetadataA,
PCGMetadataEntryKey InKeyB,
const UPCGMetadata* InMetadataB,
PCGMetadataEntryKey& OutKey,
EPCGMetadataOp Op
)

 Attributes operations
Public function UFunction BlueprintCallable, Category void

MergeAttributesByKey ( int64 KeyA,
const UPCGMetadata* MetadataA,
int64 KeyB,
const UPCGMetadata* MetadataB,
int64 TargetKey,
EPCGMetadataOp Op,
int64& OutKey
)

 Blueprint-friend versions
Public function void

MergeAttributesSubset ( PCGMetadataEntryKey InKeyA,
const UPCGMetadata* InMetadataA,
const UPCGMetadata* InMetadataSubetA,
PCGMetadataEntryKey InKeyB,
const UPCGMetadata* InMetadataB,
const UPCGMetadata* InMetadataSubsetb,
PCGMetadataEntryKey& OutKey,
EPCGMetadataOp Op
)

  
Public function UFunction BlueprintCallable, Category void

MergePointAttributes ( const FPCGPoint& PointA,
const UPCGMetadata* MetadataA,
const FPCGPoint& PointB,
const UPCGMetadata* MetadataB,
UPARAM(ref) FPCGPoint& TargetPoint,
EPCGMetadataOp Op
)

  
Public function void

MergePointAttributes ( const FPCGPoint& InPointA,
const FPCGPoint& InPointB,
FPCGPoint& OutPoint,
EPCGMetadataOp Op
)

 Attributes operations - shorthand for points
Public function void

MergePointAttributesSubset ( const FPCGPoint& InPointA,
const UPCGMetadata* InMetadataA,
const UPCGMetadata* InMetadataSubetA,
const FPCGPoint& InPointB,
const UPCGMetadata* InMetadataB,
const UPCGMetadata* InMetadataSubsetb,
FPCGPoint& OutPoint,
EPCGMetadataOp Op
)

  
Protected function Const bool

ParentHasAttribute ( FName AttributeName
)

  
Protected function void

RemoveAttributeInternal ( FName AttributeName
)

  
Public function UFunction BlueprintCallable, Category bool

RenameAttribute ( FName AttributeToRename,
FName NewAttributeName
)

 Rename attribute
Public function UFunction BlueprintCallable, Category void  
Public function void  
Public function UFunction BlueprintCallable, Category void

ResetWeightedAttributesByKey ( int64 TargetKey,
int64& OutKey
)

  
Public function Virtual void

Serialize ( FArchive& InArchive
)

  
Public function bool

SetAttributeFromDataProperty ( FName AttributeName,
PCGMetadataEntryKey& EntryKey,
const void* Data,
const FProperty* Property,
bool bCreate
)

 Set an attribute given a property and its value.
Public function bool

SetAttributeFromProperty ( FName AttributeName,
PCGMetadataEntryKey& EntryKey,
const UObject* Object,
const FProperty* Property,
bool bCreate
)

 Set an attribute given a property and its value.
Public function void

SetAttributes ( PCGMetadataEntryKey InKey,
const UPCGMetadata* InMetadata,
PCGMetadataEntryKey& OutKey
)

  
Public function void

SetAttributes ( const TArrayView< const PCGMetadataEntryKey >& InKeys,
const UPCGMetadata* InMetadata,
const TArrayView< PCGMetadataEntryKey >& OutKeys,
FPCGContext* OptionalContext
)

  
Public function UFunction BlueprintCallable, Category void

SetAttributesByKey ( int64 Key,
const UPCGMetadata* InMetadata,
int64 TargetKey,
int64& OutKey
)

  
Protected function void

SetLastCachedSelectorOnOwner ( FName AttributeName
)

  
Public function void

SetPointAttributes ( const TArrayView< const FPCGPoint >& InPoints,
const UPCGMetadata* InMetadata,
const TArrayView< FPCGPoint >& OutPoints,
FPCGContext* OptionalContext
)

  
Public function UFunction BlueprintCallable, Category void

SetPointAttributes ( const FPCGPoint& Point,
const UPCGMetadata* Metadata,
UPARAM(ref) FPCGPoint& OutPoint
)

  
Public function UFunction BlueprintCallable, Category    
Public function UFunction BlueprintCallable, Category    
Public function UFunction BlueprintCallable, Category    
Public function UFunction BlueprintCallable, Category    
Public function UFunction BlueprintCallable, Category    
Public function UFunction BlueprintCallable, Category    
Public function UFunction BlueprintCallable, Category, Meta    
Public function UFunction BlueprintCallable, Category    
Public function UFunction BlueprintCallable, Category    
Public function UFunction BlueprintCallable, Category    
Public function UFunction BlueprintCallable, Category    
Public function UFunction BlueprintCallable, Category    
Public function UFunction BlueprintCallable, Category    
Public function UFunction BlueprintCallable, Category    
Public function UFunction BlueprintCallable, Category    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page