1. Epic GamesDeveloper
  3. FPCGMetadataAttributeBase

FPCGMetadataAttributeBase

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

Inheritance Hierarchy

References

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

Syntax

class FPCGMetadataAttributeBase

Variables

  Type Name Description
Public variable PCGMetadataAttributeKey AttributeId  
Protected variable bool bAllowsInterpolation  
Protected variable FRWLock EntryMapLock  
Protected variable TMap< PCGMetadataEntryKey, PCGMetadataValueKey > EntryToValueKeyMap  
Protected variable TObjectPtr< UPCGMetadata > Metadata  
Public variable FName Name  
Protected variable const FPCGMetadataAttributeBase * Parent  
Protected variable int16 TypeId  

Constructors

  Type Name Description
Public function    
Public function  

FPCGMetadataAttributeBase ( UPCGMetadata* InMetadata,
FName InName,
const FPCGMetadataAttributeBase* InParent,
bool bInAllowsInterpolation
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AccumulateValue ( PCGMetadataEntryKey ItemKey,
const FPCGMetadataAttributeBase* InAttributeA,
PCGMetadataEntryKey InEntryKeyA,
float Weight
)

  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function void  
Public function Const FPCGMetadataAttributeBase *

Copy ( FName NewName,
UPCGMetadata* InMetadata,
bool bKeepParent,
bool bCopyEntries,
bool bCopyValues
)

  
Public function Const FPCGMetadataAttributeBase *  
Public function void

Flatten ()

 Unparents current attribute by flattening the values, entries, etc.
Public function void

FlattenAndCompress ( const TArray< PCGMetadataEntryKey >& InEntryKeysToKeep
)

 Unparents current attribute by flattening the values, entries, etc while only keeping the entries referenced in InEntryKeysToKeep.
Public function Const const TMap< PCGMetadataEntryKey, PCGMetadataValueKey > & This call is not thread safe.
Public function Const const UPCGMetadata *  
Public function Const int32  
Public function Const int32  
Public function Const const FPCGMetadataAttributeBase *  
Public function Const int16  
Public function Const PCGMetadataValueKey  
Public function Const PCGMetadataValueKey  
Public function Const void

GetValueKeys ( const TArrayView< const PCGMetadataEntryKey >& EntryKeys,
TArray< PCGMetadataValueKey >& OutValueKeys
)

 Bulk getter, to lock in read only once per parent.
Public function Const bool  
Public function Const bool  
Public function Static bool

IsValidName ( const FName& Name
)

  
Public function Static bool

IsValidName ( const FString& Name
)

 Returns true if for valid attribute names, which are alphanumeric with some special characters allowed.
Public function void

Reset ()

 Remove all entries, values and parenting.
Public function Static bool

SanitizeName ( FString& InOutName
)

 Replaces any invalid characters in name with underscores. Returns true if Name was changed.
Public function Virtual void

Serialize ( UPCGMetadata* InMetadata,
FArchive& InArchive
)

  
Public function void In the case of multi entry attribute and after some operations, we might have a single entry attribute with a default value that is different than the first entry.
Public function void

SetValue ( PCGMetadataEntryKey ItemKey,
const FPCGMetadataAttributeBase* InAttribute,
PCGMetadataEntryKey InEntryKey
)

  
Public function void

SetValue ( PCGMetadataEntryKey ItemKey,
const FPCGMetadataAttributeBase* InAttributeA,
PCGMetadataEntryKey InEntryKeyA,
const FPCGMetadataAttributeBase* InAttributeB,
PCGMetadataEntryKey InEntryKeyB,
EPCGMetadataOp Op
)

  
Public function void

SetValueFromValueKey ( PCGMetadataEntryKey EntryKey,
PCGMetadataValueKey ValueKey,
bool bResetValueOnDefaultValueKey
)

  
Public function void

SetValuesFromValueKeys ( const TArrayView< const PCGMetadataEntryKey >& EntryKeys,
const TArrayView< const PCGMetadataValueKey >& ValueKeys,
bool bResetValueOnDefaultValueKey
)

 Two arrays version of bulk setter to lock in write only once. Both arrays must be the same size.
Public function void

SetValuesFromValueKeys ( const TArrayView< const TTuple< PCGMetadataEntryKey, PCGMetadataValueKey > >& EntryValuePairs,
bool bResetValueOnDefaultValueKey
)

 Bulk setter to lock in write only once.
Public function void

SetValuesFromValueKeys ( const TArrayView< const PCGMetadataEntryKey*const >& EntryKeys,
const TArrayView< const PCGMetadataValueKey >& ValueKeys,
bool bResetValueOnDefaultValueKey
)

  
Public function void

SetWeightedValue ( PCGMetadataEntryKey ItemKey,
const FPCGMetadataAttributeBase* InAttribute,
const TArrayView< const TPair< PCGMetadataEntryKey, float > >& InWeightedKeys
)

  
Public function void  
Public function Const bool  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page