Navigation
API > API/Plugins > API/Plugins/PCG
| Name | FPCGMetadataAttributeBase |
| Type | class |
| Header File | /Engine/Plugins/PCG/Source/PCG/Public/Metadata/PCGMetadataAttribute.h |
| Include Path | #include "Metadata/PCGMetadataAttribute.h" |
Syntax
class FPCGMetadataAttributeBase
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPCGMetadataAttributeBase
(
UPCGMetadata* InMetadata, |
Metadata/PCGMetadataAttribute.h | ||
FPCGMetadataAttributeBase
(
FPCGMetadataDomain* InMetadata, |
Metadata/PCGMetadataAttribute.h | ||
| Metadata/PCGMetadataAttribute.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FPCGMetadataAttributeBase() |
Metadata/PCGMetadataAttribute.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AttributeId | PCGMetadataAttributeKey | Metadata/PCGMetadataAttribute.h | ||
| Name | FName | Metadata/PCGMetadataAttribute.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AccumulateValue
(
PCGMetadataEntryKey ItemKey, |
Metadata/PCGMetadataAttribute.h | ||
bool AllowsInterpolation() |
Metadata/PCGMetadataAttribute.h | ||
bool AreValuesEqual
(
PCGMetadataValueKey ValueKey1, |
Metadata/PCGMetadataAttribute.h | ||
bool AreValuesEqualForEntryKeys
(
PCGMetadataEntryKey EntryKey1, |
Metadata/PCGMetadataAttribute.h | ||
void ClearEntries() |
Metadata/PCGMetadataAttribute.h | ||
FPCGMetadataAttributeBase * Copy
(
FName NewName, |
Metadata/PCGMetadataAttribute.h | ||
FPCGMetadataAttributeBase * Copy
(
FName NewName, |
Metadata/PCGMetadataAttribute.h | ||
FPCGMetadataAttributeBase * CopyToAnotherType
(
int16 Type |
Metadata/PCGMetadataAttribute.h | ||
void Flatten() |
Unparents current attribute by flattening the values, entries, etc. | Metadata/PCGMetadataAttribute.h | |
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/PCGMetadataAttribute.h | |
const TMap< PCGMetadataEntryKey, PCGMetadataValueKey > & GetEntryToValueKeyMap_NotThreadSafe() |
This call is not thread safe. | Metadata/PCGMetadataAttribute.h | |
const UPCGMetadata * GetMetadata() |
Metadata/PCGMetadataAttribute.h | ||
const FPCGMetadataDomain * GetMetadataDomain() |
Metadata/PCGMetadataAttribute.h | ||
int32 GetNumberOfEntries() |
Metadata/PCGMetadataAttribute.h | ||
int32 GetNumberOfEntriesWithParents() |
Metadata/PCGMetadataAttribute.h | ||
const FPCGMetadataAttributeBase * GetParent() |
Metadata/PCGMetadataAttribute.h | ||
int16 GetTypeId() |
Metadata/PCGMetadataAttribute.h | ||
PCGMetadataValueKey GetValueKey
(
PCGMetadataEntryKey EntryKey |
Metadata/PCGMetadataAttribute.h | ||
PCGMetadataValueKey GetValueKeyOffsetForChild() |
Metadata/PCGMetadataAttribute.h | ||
void GetValueKeys
(
TPCGValueRange< PCGMetadataEntryKey > EntryKeys, |
Optimized version that take ownership on the Entries passed. | Metadata/PCGMetadataAttribute.h | |
void GetValueKeys
(
TArrayView< PCGMetadataEntryKey > EntryKeys, |
Optimized version that take ownership on the Entries passed. | Metadata/PCGMetadataAttribute.h | |
void GetValueKeys
(
const TArrayView< const PCGMetadataEntryKey >& EntryKeys, |
Bulk getter, to lock in read only once per parent. | Metadata/PCGMetadataAttribute.h | |
void GetValueKeys
(
TConstPCGValueRange< PCGMetadataEntryKey > EntryKeys, |
Bulk getter, to lock in read only once per parent. | Metadata/PCGMetadataAttribute.h | |
bool HasNonDefaultValue
(
PCGMetadataEntryKey EntryKey |
Metadata/PCGMetadataAttribute.h | ||
bool IsEqualToDefaultValue
(
PCGMetadataValueKey ValueKey |
Metadata/PCGMetadataAttribute.h | ||
void Reset() |
Remove all entries, values and parenting. | Metadata/PCGMetadataAttribute.h | |
virtual void Serialize
(
UPCGMetadata* InMetadata, |
Metadata/PCGMetadataAttribute.h | ||
virtual void Serialize
(
FPCGMetadataDomain* InMetadata, |
Metadata/PCGMetadataAttribute.h | ||
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/PCGMetadataAttribute.h | |
void SetValue
(
PCGMetadataEntryKey ItemKey, |
Metadata/PCGMetadataAttribute.h | ||
void SetValue
(
PCGMetadataEntryKey ItemKey, |
Metadata/PCGMetadataAttribute.h | ||
void SetValueFromValueKey
(
PCGMetadataEntryKey EntryKey, |
Metadata/PCGMetadataAttribute.h | ||
void SetValuesFromValueKeys
(
const TArrayView< const PCGMetadataEntryKey >& EntryKeys, |
Two arrays version of bulk setter to lock in write only once. Both arrays must be the same size. | Metadata/PCGMetadataAttribute.h | |
void SetValuesFromValueKeys
(
const TArrayView< const TTuple< PCGMetadataEntryKey, PCGMetadataValueKey > >& EntryValuePairs, |
Bulk setter to lock in write only once. | Metadata/PCGMetadataAttribute.h | |
void SetValuesFromValueKeys
(
const TArrayView< const PCGMetadataEntryKey*const >& EntryKeys, |
Metadata/PCGMetadataAttribute.h | ||
void SetWeightedValue
(
PCGMetadataEntryKey ItemKey, |
Metadata/PCGMetadataAttribute.h | ||
void SetZeroValue
(
PCGMetadataEntryKey ItemKey |
Metadata/PCGMetadataAttribute.h | ||
bool UsesValueKeys() |
Metadata/PCGMetadataAttribute.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool IsValidName
(
const FName& Name |
Metadata/PCGMetadataAttribute.h | ||
static bool IsValidName
(
const FString& Name |
Returns true if for valid attribute names, which are alphanumeric with some special characters allowed. | Metadata/PCGMetadataAttribute.h | |
static bool SanitizeName
(
FString& InOutName |
Replaces any invalid characters in name with underscores. Returns true if Name was changed. | Metadata/PCGMetadataAttribute.h |