1. Epic GamesDeveloper
  3. FPCGMetadataAttribute

FPCGMetadataAttribute

API > API/Plugins > API/Plugins/PCG

   
Name FPCGMetadataAttribute
Type class
Header File /Engine/Plugins/PCG/Source/PCG/Public/Metadata/PCGMetadataAttributeTpl.h
Include Path #include "Metadata/PCGMetadataAttributeTpl.h"

Syntax

template<typename T>  
class FPCGMetadataAttribute : public FPCGMetadataAttributeBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
This constructor is used only during serialization. Metadata/PCGMetadataAttributeTpl.h  

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

 TODO: All deprecated versions taking a UPCGMetadata will be added at the end of this declaration. Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

PCGMetadataValueKey AddValue ( const T& InValue
)

 Adds the value, returns the value key for the given value Metadata/PCGMetadataAttributeTpl.h  

TArray< PCGMetadataValueKey > AddValues ( const TArrayView< const T >& InValues
)

   Metadata/PCGMetadataAttributeTpl.h  

TArray< PCGMetadataValueKey > AddValues ( const TArrayView< const T >& InValues
)

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

PCGMetadataValueKey FindValue ( const T& InValue
) const

   Metadata/PCGMetadataAttributeTpl.h  

PCGMetadataValueKey FindValue ( const T& InValue
) const

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

const FPCGMetadataAttribute * GetParent()

   Metadata/PCGMetadataAttributeTpl.h  

T GetValue ( PCGMetadataValueKey ValueKey
) const

   Metadata/PCGMetadataAttributeTpl.h  

T GetValueFromItemKey ( PCGMetadataEntryKey ItemKey
) const

   Metadata/PCGMetadataAttributeTpl.h  

void GetValues ( const TArrayView< const PCGMetadataValueKey > ValueKeys,
TArrayView< T > OutValues
) const

 Write into pre-allocated OutValues the values associated with the given value keys. Metadata/PCGMetadataAttributeTpl.h  

void GetValuesFromItemKeys ( TArrayView< PCGMetadataEntryKey > EntryKeys,
TArrayView< T > OutValues
) const

 Write into pre-allocated OutValues the values associated with the given entry keys. Metadata/PCGMetadataAttributeTpl.h  

void GetValuesFromItemKeys ( const TArrayView< const PCGMetadataEntryKey > EntryKeys,
TArrayView< T > OutValues
) const

 Write into pre-allocated OutValues the values associated with the given entry keys. Metadata/PCGMetadataAttributeTpl.h  

int32 PreallocateValues ( TArrayView< PCGMetadataEntryKey* > EntryKeys,
bool bLockless
)

   Metadata/PCGMetadataAttributeTpl.h  

void Prepare ( int32 Count
)

   Metadata/PCGMetadataAttributeTpl.h  

void SetDefaultValue ( const T& Value
)

   Metadata/PCGMetadataAttributeTpl.h  

void SetValue ( PCGMetadataEntryKey ItemKey,
const T& InValue
)

   Metadata/PCGMetadataAttributeTpl.h  

void SetValue ( PCGMetadataEntryKey ItemKey,
const U& InValue
)

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

void SetValues_TryLockless ( TArrayView< PCGMetadataEntryKey* > EntryKeys,
TArrayView< const T > InValues,
int32 StartIndex
)

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

Overridden from FPCGMetadataAttributeBase

Name Remarks Include Path Unreal Specifiers

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

   Metadata/PCGMetadataAttributeTpl.h  

virtual bool AreValuesEqual ( PCGMetadataValueKey ValueKey1,
PCGMetadataValueKey ValueKey2
) const

   Metadata/PCGMetadataAttributeTpl.h  

virtual bool AreValuesEqualForEntryKeys ( PCGMetadataEntryKey EntryKey1,
PCGMetadataEntryKey EntryKey2
) const

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

virtual FPCGMetadataAttributeBase * Copy ( FName NewName,
FPCGMetadataDomain* InMetadata,
bool bKeepParent,
bool bCopyEntries,
bool bCopyValues
) const

   Metadata/PCGMetadataAttributeTpl.h  

virtual FPCGMetadataAttributeBase * CopyToAnotherType ( int16 TargetType
) const

   Metadata/PCGMetadataAttributeTpl.h  

virtual void Flatten()

 Unparents current attribute by flattening the values, entries, etc. Metadata/PCGMetadataAttributeTpl.h  

virtual void FlattenAndCompress ( const TArrayView< const PCGMetadataEntryKey >& InEntryKeysToKeep
)

 Unparents current attribute by flattening the values, entries, etc while only keeping the entries referenced in InEntryKeysToKeep. Metadata/PCGMetadataAttributeTpl.h  

virtual PCGMetadataValueKey GetValueKeyOffsetForChild()

   Metadata/PCGMetadataAttributeTpl.h  

virtual bool IsEqualToDefaultValue ( PCGMetadataValueKey ValueKey
) const

   Metadata/PCGMetadataAttributeTpl.h  

virtual void Reset()

 Remove all entries, values and parenting. Metadata/PCGMetadataAttributeTpl.h  

virtual void Serialize ( FPCGMetadataDomain* InMetadata,
FArchive& InArchive
)

   Metadata/PCGMetadataAttributeTpl.h  

virtual void SetDefaultValueToFirstEntry ()

 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. Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

virtual void SetZeroValue ( PCGMetadataEntryKey ItemKey
)

   Metadata/PCGMetadataAttributeTpl.h  

virtual bool UsesValueKeys()

 Code related to finding values / compressing data Metadata/PCGMetadataAttributeTpl.h  

Protected

Name Remarks Include Path Unreal Specifiers

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

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

FPCGMetadataAttributeBase * CopyInternal ( FName NewName,
FPCGMetadataDomain* InMetadata,
bool bKeepParent,
bool bCopyEntries,
bool bCopyValues
) const

 TODO: add enable if only on compatible types, but this has some repercussion on using metadata on types that aren't normally supported. Metadata/PCGMetadataAttributeTpl.h  

void GetValues_Internal ( const TArrayView< const PCGMetadataValueKey > ValueKeys,
TArrayView< T > OutValues,
TBitArray<>& UnretrievedValues
) const

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

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

 Code related to computing compared values (min, max, sub, add) Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

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

   Metadata/PCGMetadataAttributeTpl.h  

void ZeroValue ( PCGMetadataEntryKey ItemKey
)

 Weighted/interpolated values related code Metadata/PCGMetadataAttributeTpl.h  

void ZeroValue ( PCGMetadataEntryKey ItemKey
)

   Metadata/PCGMetadataAttributeTpl.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page