1. Epic GamesDeveloper
  3. FPCGMetadataAttribute

FPCGMetadataAttribute

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

Inheritance Hierarchy

References

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

Syntax

template<typename T>  
class FPCGMetadataAttribute : public FPCGMetadataAttributeBase

Variables

  Type Name Description
Protected variable T DefaultValue  
Protected variable PCGMetadataValueKey ValueKeyOffset  
Protected variable FRWLock ValueLock  
Protected variable TArray< T > Values  

Constructors

  Type Name Description
Public function   This constructor is used only during serialization.
Public function  

FPCGMetadataAttribute ( UPCGMetadata* InMetadata,
FName InName,
const FPCGMetadataAttributeBase* InParent,
const T& InDefaultValue,
bool bInAllowsInterpolation
)

  

Functions

  Type Name Description
Protected function void

Accumulate ( PCGMetadataEntryKey ItemKey,
const FPCGMetadataAttributeBase* InAttribute,
PCGMetadataEntryKey InEntryKey,
float Weight
)

  
Protected function void

Accumulate ( PCGMetadataEntryKey ItemKey,
const FPCGMetadataAttributeBase* InAttribute,
PCGMetadataEntryKey InEntryKey,
float Weight
)

  
Protected function void

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

  
Protected function void

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

  
Public function PCGMetadataValueKey

AddValue ( const T& InValue
)

 Adds the value, returns the value key for the given value
Public function TArray< PCGMetadataValueKey >

AddValues ( const TArrayView< const T >& InValues
)

  
Public function TArray< PCGMetadataValueKey >

AddValues ( const TArrayView< const T >& InValues
)

  
Public function Const FPCGMetadataAttributeBase *

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

 TODO: add enable if only on compatible types, but this has some repercussion on using metadata on types that aren't normally supported.
Public function Const PCGMetadataValueKey

FindValue ( const T& InValue
)

  
Public function Const PCGMetadataValueKey

FindValue ( const T& InValue
)

  
Public function Const bool

FindValues ( const TArrayView< const T >& InValues,
TArray< PCGMetadataValueKey >& OutValueKeys
)

  
Public function Const bool

FindValues ( const TArrayView< const T >& InValues,
TArray< PCGMetadataValueKey >& OutValueKeys
)

  
Public function Const void

FindValuesInternal ( const TArrayView< const T >& InValues,
TArray< PCGMetadataValueKey >& ValueKeys,
int& ValueKeysSet,
bool bIsRoot
)

  
Public function Const const FPCGMetadataAttribute *  
Public function Const T  
Public function Const T  
Protected function bool

SetAdd ( PCGMetadataEntryKey ItemKey,
const FPCGMetadataAttributeBase* InAttributeA,
PCGMetadataEntryKey InEntryKeyA,
const FPCGMetadataAttributeBase* InAttributeB,
PCGMetadataEntryKey InEntryKeyB
)

  
Protected function bool

SetAdd ( PCGMetadataEntryKey ItemKey,
const FPCGMetadataAttributeBase* InAttributeA,
PCGMetadataEntryKey InEntryKeyA,
const FPCGMetadataAttributeBase* InAttributeB,
PCGMetadataEntryKey InEntryKeyB
)

  
Public function void

SetDefaultValue ( const T& Value
)

  
Protected function bool

SetDiv ( PCGMetadataEntryKey ItemKey,
const FPCGMetadataAttributeBase* InAttributeA,
PCGMetadataEntryKey InEntryKeyA,
const FPCGMetadataAttributeBase* InAttributeB,
PCGMetadataEntryKey InEntryKeyB
)

  
Protected function bool

SetDiv ( PCGMetadataEntryKey ItemKey,
const FPCGMetadataAttributeBase* InAttributeA,
PCGMetadataEntryKey InEntryKeyA,
const FPCGMetadataAttributeBase* InAttributeB,
PCGMetadataEntryKey InEntryKeyB
)

  
Protected function bool

SetMax ( PCGMetadataEntryKey ItemKey,
const FPCGMetadataAttributeBase* InAttributeA,
PCGMetadataEntryKey InEntryKeyA,
const FPCGMetadataAttributeBase* InAttributeB,
PCGMetadataEntryKey InEntryKeyB
)

  
Protected function bool

SetMax ( PCGMetadataEntryKey ItemKey,
const FPCGMetadataAttributeBase* InAttributeA,
PCGMetadataEntryKey InEntryKeyA,
const FPCGMetadataAttributeBase* InAttributeB,
PCGMetadataEntryKey InEntryKeyB
)

  
Protected function bool

SetMin ( PCGMetadataEntryKey ItemKey,
const FPCGMetadataAttributeBase* InAttributeA,
PCGMetadataEntryKey InEntryKeyA,
const FPCGMetadataAttributeBase* InAttributeB,
PCGMetadataEntryKey InEntryKeyB
)

 Code related to computing compared values (min, max, sub, add)
Protected function bool

SetMin ( PCGMetadataEntryKey ItemKey,
const FPCGMetadataAttributeBase* InAttributeA,
PCGMetadataEntryKey InEntryKeyA,
const FPCGMetadataAttributeBase* InAttributeB,
PCGMetadataEntryKey InEntryKeyB
)

  
Protected function bool

SetMul ( PCGMetadataEntryKey ItemKey,
const FPCGMetadataAttributeBase* InAttributeA,
PCGMetadataEntryKey InEntryKeyA,
const FPCGMetadataAttributeBase* InAttributeB,
PCGMetadataEntryKey InEntryKeyB
)

  
Protected function bool

SetMul ( PCGMetadataEntryKey ItemKey,
const FPCGMetadataAttributeBase* InAttributeA,
PCGMetadataEntryKey InEntryKeyA,
const FPCGMetadataAttributeBase* InAttributeB,
PCGMetadataEntryKey InEntryKeyB
)

  
Protected function bool

SetSub ( PCGMetadataEntryKey ItemKey,
const FPCGMetadataAttributeBase* InAttributeA,
PCGMetadataEntryKey InEntryKeyA,
const FPCGMetadataAttributeBase* InAttributeB,
PCGMetadataEntryKey InEntryKeyB
)

  
Protected function bool

SetSub ( PCGMetadataEntryKey ItemKey,
const FPCGMetadataAttributeBase* InAttributeA,
PCGMetadataEntryKey InEntryKeyA,
const FPCGMetadataAttributeBase* InAttributeB,
PCGMetadataEntryKey InEntryKeyB
)

  
Public function void

SetValue ( PCGMetadataEntryKey ItemKey,
const T& InValue
)

  
Public function void

SetValue ( PCGMetadataEntryKey ItemKey,
const U& InValue
)

  
Public function void

SetValues ( const TArrayView< const PCGMetadataEntryKey >& ItemKeys,
const TArrayView< const T >& InValues
)

  
Public function void

SetValues ( const TArrayView< const PCGMetadataEntryKey*const >& ItemKeys,
const TArrayView< const T >& InValues
)

  
Public function FPCGMetadataAttribute *

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

  
Protected function void Weighted/interpolated values related code
Protected function void  

Overridden from FPCGMetadataAttributeBase

  Type Name Description
Public function Virtual void

AccumulateValue ( PCGMetadataEntryKey ItemKey,
const FPCGMetadataAttributeBase* InAttribute,
PCGMetadataEntryKey InEntryKey,
float Weight
)

  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const FPCGMetadataAttributeBase *

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

  
Public function Virtual Const FPCGMetadataAttributeBase *

CopyToAnotherType ( int16 TargetType
)

  
Public function Virtual void

Flatten ()

 Unparents current attribute by flattening the values, entries, etc.
Public function Virtual 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 Virtual Const PCGMetadataValueKey  
Public function Virtual Const bool  
Public function Virtual void

Reset ()

 Remove all entries, values and parenting.
Public function Virtual void

Serialize ( UPCGMetadata* InMetadata,
FArchive& InArchive
)

  
Public function Virtual 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 Virtual void

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

  
Public function Virtual void

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

  
Public function Virtual void

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

  
Public function Virtual void  
Public function Virtual Const bool Code related to finding values / compressing data

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page