Navigation
API > API/Plugins > API/Plugins/PCG
| Name | UPCGMetadata |
| Type | class |
| Header File | /Engine/Plugins/PCG/Source/PCG/Public/Metadata/PCGMetadata.h |
| Include Path | #include "Metadata/PCGMetadata.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType)
class UPCGMetadata : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UPCGMetadata
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UPCGMetadata
(
const FObjectInitializer& ObjectInitializer |
Metadata/PCGMetadata.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FPCGMetadataDomain | friend | Metadata/PCGMetadata.h | ||
| FPCGMetadataInitializeParams | friend | Metadata/PCGMetadata.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AccumulatePointWeightedAttributes
(
const FPCGPoint& InPoint, |
Metadata/PCGMetadata.h |
|
|
void AccumulateWeightedAttributes
(
PCGMetadataEntryKey InKey, |
Metadata/PCGMetadata.h | ||
void AccumulateWeightedAttributesByKey
(
int64 Key, |
Metadata/PCGMetadata.h |
|
|
void AddAttribute
(
const UPCGMetadata* InOther, |
Metadata/PCGMetadata.h | ||
void AddAttributes
(
const FPCGMetadataInitializeParams& InParams |
Metadata/PCGMetadata.h | ||
void AddAttributes
(
const UPCGMetadata* InOther |
Creates missing attributes from another metadata if they are not currently present - note that this does not copy values | Metadata/PCGMetadata.h |
|
void AddAttributesFiltered
(
const UPCGMetadata* InOther, |
Creates missing attributes from another metadata if they are not currently present - note that this does not copy values. | Metadata/PCGMetadata.h |
|
void AddDelayedEntries
(
const TArray< TTuple< int64, int64 > >& AllEntries |
Advanced method. | Metadata/PCGMetadata.h | |
TArray< int64 > AddEntries
(
TArrayView< const int64 > ParentEntryKeys |
Adds a unique entry key to the metadata for all the parent entry keys. | Metadata/PCGMetadata.h | |
void AddEntriesInPlace
(
TArrayView< int64* > ParentEntryKeys |
Adds a unique entry key to the metadata for all the parent entry keys, in place. | Metadata/PCGMetadata.h | |
int64 AddEntry
(
int64 ParentEntryKey |
Adds a unique entry key to the metadata | Metadata/PCGMetadata.h |
|
int64 AddEntryPlaceholder () |
Advanced method. | Metadata/PCGMetadata.h | |
void AddToCrc
(
FArchiveCrc32& Ar, |
Computes Crc from all attributes & keys from outer's data. | Metadata/PCGMetadata.h | |
void BP_AddAttribute
(
const UPCGMetadata* InOther, |
Creates missing attribute from another metadata if it is not currently present - note that this does not copy values | Metadata/PCGMetadata.h |
|
void BP_ClearAttribute
(
FName AttributeToClear |
Clear/Reinit attribute | Metadata/PCGMetadata.h |
|
void BP_CopyAttribute
(
const UPCGMetadata* InOther, |
Copies an attribute from another metadata, including entries & values. | Metadata/PCGMetadata.h |
|
| Copy attribute | Metadata/PCGMetadata.h |
|
|
void BP_DeleteAttribute
(
FName AttributeName |
Due to stream inheriting, we might want to consider "hiding" parent stream and deleting local streams only. | Metadata/PCGMetadata.h |
|
bool BP_HasAttribute
(
FName AttributeName |
Metadata/PCGMetadata.h |
|
|
| Rename attribute | Metadata/PCGMetadata.h |
|
|
bool ChangeAttributeType
(
FPCGAttributeIdentifier AttributeName, |
Change type of an attribute | Metadata/PCGMetadata.h | |
void ClearAttribute
(
FPCGAttributeIdentifier AttributeToClear |
Metadata/PCGMetadata.h | ||
void ComputePointWeightedAttribute
(
FPCGPoint& OutPoint, |
Metadata/PCGMetadata.h | ||
void ComputeWeightedAttribute
(
PCGMetadataEntryKey& OutKey, |
Metadata/PCGMetadata.h | ||
void CopyAttribute
(
const UPCGMetadata* InOther, |
Metadata/PCGMetadata.h | ||
FPCGMetadataAttributeBase * CopyAttribute
(
const FPCGMetadataAttributeBase* OriginalAttribute, |
Copies another attribute, with options to keep its parent and copy entries/values | Metadata/PCGMetadata.h | |
void CopyAttributes
(
const UPCGMetadata* InOther |
Copies attributes from another metadata, including entries & values. | Metadata/PCGMetadata.h |
|
bool CopyExistingAttribute
(
FPCGAttributeIdentifier AttributeToCopy, |
Metadata/PCGMetadata.h | ||
FPCGMetadataAttribute< T > * CreateAttribute
(
FPCGAttributeIdentifier AttributeName, |
Create a new attribute. | Metadata/PCGMetadata.h | |
bool CreateAttributeFromDataProperty
(
FPCGAttributeIdentifier AttributeName, |
Creates an attribute given a property. | Metadata/PCGMetadata.h | |
bool CreateAttributeFromProperty
(
FPCGAttributeIdentifier AttributeName, |
Creates an attribute given a property. | Metadata/PCGMetadata.h | |
UPCGMetadata * CreateBoolAttribute
(
FName AttributeName, |
Metadata/PCGMetadata.h |
|
|
UPCGMetadata * CreateDoubleAttribute
(
FName AttributeName, |
Metadata/PCGMetadata.h |
|
|
UPCGMetadata * CreateFloatAttribute
(
FName AttributeName, |
Metadata/PCGMetadata.h |
|
|
UPCGMetadata * CreateInteger32Attribute
(
FName AttributeName, |
TODO: Will be moved at the end of the class before commit, as they are functions planned to be deprecated. | Metadata/PCGMetadata.h |
|
UPCGMetadata * CreateInteger64Attribute
(
FName AttributeName, |
Metadata/PCGMetadata.h |
|
|
UPCGMetadata * CreateNameAttribute
(
FName AttributeName, |
Metadata/PCGMetadata.h |
|
|
UPCGMetadata * CreateQuatAttribute
(
FName AttributeName, |
Metadata/PCGMetadata.h |
|
|
UPCGMetadata * CreateRotatorAttribute
(
FName AttributeName, |
Metadata/PCGMetadata.h |
|
|
UPCGMetadata * CreateSoftClassPathAttribute
(
FName AttributeName, |
Metadata/PCGMetadata.h |
|
|
UPCGMetadata * CreateSoftObjectPathAttribute
(
FName AttributeName, |
Metadata/PCGMetadata.h |
|
|
UPCGMetadata * CreateStringAttribute
(
FName AttributeName, |
Metadata/PCGMetadata.h |
|
|
UPCGMetadata * CreateTransformAttribute
(
FName AttributeName, |
Metadata/PCGMetadata.h |
|
|
UPCGMetadata * CreateVector2Attribute
(
FName AttributeName, |
Metadata/PCGMetadata.h |
|
|
UPCGMetadata * CreateVector4Attribute
(
FName AttributeName, |
Metadata/PCGMetadata.h |
|
|
UPCGMetadata * CreateVectorAttribute
(
FName AttributeName, |
Metadata/PCGMetadata.h |
|
|
void DeleteAttribute
(
FPCGAttributeIdentifier AttributeName |
Metadata/PCGMetadata.h | ||
FPCGMetadataAttribute< T > * FindOrCreateAttribute
(
FPCGAttributeIdentifier AttributeName, |
Find or create an attribute. | Metadata/PCGMetadata.h | |
void Flatten() |
Unparents current metadata by flattening the attributes (values, entries, etc.) and potentially compress the data to remove unused values. | Metadata/PCGMetadata.h |
|
bool FlattenAndCompress
(
const TArray< PCGMetadataEntryKey >& InEntryKeysToKeep |
Metadata/PCGMetadata.h | ||
bool FlattenAndCompress
(
const TMap< FPCGMetadataDomainID, TArrayView< const PCGMetadataEntryKey > >& InEntryKeysToKeepMappi... |
Unparents current metadata, flatten attribute and only keep the entries specified. | Metadata/PCGMetadata.h | |
void FlattenImpl() |
Unparents current metadata by flattening the attributes (values, entries, etc.) | Metadata/PCGMetadata.h | |
void GetAllAttributes
(
TArray< FPCGAttributeIdentifier >& AttributeNames, |
Get all the attributes identifiers and their type for all domains. | Metadata/PCGMetadata.h | |
int32 GetAttributeCount() |
Return the number of attributes in this metadata. | Metadata/PCGMetadata.h |
|
void GetAttributes
(
TArray< FName >& AttributeNames, |
Get all the attributes names and type on the default domain. | Metadata/PCGMetadata.h |
|
const FPCGMetadataAttributeBase * GetConstAttribute
(
FPCGAttributeIdentifier AttributeName |
Metadata/PCGMetadata.h | ||
const FPCGMetadataDomain * GetConstDefaultMetadataDomain() |
Metadata/PCGMetadata.h | ||
const FPCGMetadataDomain * GetConstMetadataDomain
(
const FPCGMetadataDomainID& InMetadataDomainID |
Expected to be used when metadata domain are already setup. | Metadata/PCGMetadata.h | |
const FPCGMetadataDomain * GetConstMetadataDomainFromSelector
(
const FPCGAttributePropertySelector& InSelector |
Metadata/PCGMetadata.h | ||
const FPCGMetadataAttribute< T > * GetConstTypedAttribute
(
FPCGAttributeIdentifier AttributeName |
Metadata/PCGMetadata.h | ||
FPCGMetadataDomain * GetDefaultMetadataDomain() |
Metadata/PCGMetadata.h | ||
int64 GetItemCountForChild() |
Return the number of entries in metadata including the parent entries. | Metadata/PCGMetadata.h |
|
int64 GetItemKeyCountForParent() |
Metadata/PCGMetadata.h | ||
FName GetLatestAttributeNameOrNone() |
Returns name of the most recently created attribute, or none if no attributes are present. | Metadata/PCGMetadata.h | |
int64 GetLocalItemCount() |
Metadata/PCGMetadata.h | ||
FPCGMetadataDomain * GetMetadataDomain
(
const FPCGMetadataDomainID& InMetadataDomainID |
Expected to be used when metadata domains are already setup. | Metadata/PCGMetadata.h | |
FPCGMetadataDomain * GetMetadataDomainFromSelector
(
const FPCGAttributePropertySelector& InSelector |
Metadata/PCGMetadata.h | ||
FPCGMetadataAttributeBase * GetMutableAttribute
(
FPCGAttributeIdentifier AttributeName |
Get attributes | Metadata/PCGMetadata.h | |
FPCGMetadataAttribute< T > * GetMutableTypedAttribute
(
FPCGAttributeIdentifier AttributeName |
Metadata/PCGMetadata.h | ||
FPCGMetadataAttribute< T > * GetMutableTypedAttribute_Unsafe
(
FPCGAttributeIdentifier AttributeName |
Metadata/PCGMetadata.h | ||
const UPCGMetadata * GetParent() |
Metadata/PCGMetadata.h | ||
PCGMetadataEntryKey GetParentKey
(
PCGMetadataEntryKey LocalItemKey |
Metadata chaining mechanism | Metadata/PCGMetadata.h | |
void GetParentKeys
(
TArrayView< PCGMetadataEntryKey > LocalItemKeys, |
Metadata chaining mechanism for bulk version. | Metadata/PCGMetadata.h | |
TWeakObjectPtr< const UPCGMetadata > GetParentPtr() |
Returns this metadata's parent | Metadata/PCGMetadata.h | |
const UPCGMetadata * GetRoot() |
Metadata/PCGMetadata.h | ||
bool HasAttribute
(
FPCGAttributeIdentifier AttributeName |
Metadata/PCGMetadata.h |
|
|
bool HasCommonAttributes
(
const UPCGMetadata* InMetadata |
Metadata/PCGMetadata.h |
|
|
bool HasParent
(
const UPCGMetadata* InTentativeParent |
Metadata/PCGMetadata.h | ||
void Initialize
(
const UPCGMetadata* InParent |
Initializes the metadata from a parent metadata, if any (can be null). | Metadata/PCGMetadata.h |
|
void Initialize
(
const FPCGMetadataInitializeParams& InParams |
Metadata/PCGMetadata.h | ||
void Initialize
(
const UPCGMetadata* InParent, |
Initializes the metadata from a parent metadata, if any (can be null) with the option to not add attributes from the parent. | Metadata/PCGMetadata.h | |
void InitializeAsCopy
(
const UPCGMetadata* InMetadataToCopy, |
Metadata/PCGMetadata.h | ||
void InitializeAsCopy
(
const FPCGMetadataInitializeParams& InParams |
Initializes the metadata from a parent metadata by copying all attributes to it. | Metadata/PCGMetadata.h | |
void InitializeAsCopyWithAttributeFilter
(
const UPCGMetadata* InMetadataToCopy, |
Metadata/PCGMetadata.h | ||
bool InitializeOnSet
(
PCGMetadataEntryKey& InOutKey, |
Initializes the metadata entry key. Returns true if key set from either parent | Metadata/PCGMetadata.h | |
void InitializeWithAttributeFilter
(
const UPCGMetadata* InParent, |
Initializes the metadata from a parent metadata. Copies attributes and values. | Metadata/PCGMetadata.h |
|
void K2_InitializeAsCopy
(
const UPCGMetadata* InMetadataToCopy, |
Initializes the metadata from a parent metadata by copying all attributes to it. | Metadata/PCGMetadata.h |
|
void K2_InitializeAsCopyWithAttributeFilter
(
const UPCGMetadata* InMetadataToCopy, |
Initializes the metadata from a parent metadata by copy filtered attributes only to it | Metadata/PCGMetadata.h |
|
void MergeAttributes
(
PCGMetadataEntryKey InKeyA, |
Attributes operations | Metadata/PCGMetadata.h | |
void MergeAttributesByKey
(
int64 KeyA, |
Blueprint-friend versions | Metadata/PCGMetadata.h |
|
void MergeAttributesSubset
(
PCGMetadataEntryKey InKeyA, |
Metadata/PCGMetadata.h | ||
void MergePointAttributes
(
const FPCGPoint& PointA, |
Metadata/PCGMetadata.h |
|
|
void MergePointAttributes
(
const FPCGPoint& InPointA, |
TODO: Will be moved at the end of the class before commit, as they are functions planned to be deprecated. | Metadata/PCGMetadata.h | |
void MergePointAttributesSubset
(
const FPCGPoint& InPointA, |
Metadata/PCGMetadata.h | ||
bool MetadataDomainSupportsMultiEntries
(
const FPCGMetadataDomainID& InDomainID |
Mirror functions to be called on the outer data. | Metadata/PCGMetadata.h | |
bool MetadataDomainSupportsParenting
(
const FPCGMetadataDomainID& InDomainID |
Metadata/PCGMetadata.h | ||
bool RenameAttribute
(
FPCGAttributeIdentifier AttributeToRename, |
Metadata/PCGMetadata.h | ||
void ResetPointWeightedAttributes
(
FPCGPoint& OutPoint |
Metadata/PCGMetadata.h |
|
|
void ResetWeightedAttributes
(
PCGMetadataEntryKey& OutKey |
Metadata/PCGMetadata.h | ||
void ResetWeightedAttributesByKey
(
int64 TargetKey, |
Metadata/PCGMetadata.h |
|
|
bool SetAttributeFromDataProperty
(
FPCGAttributeIdentifier AttributeName, |
Set an attribute given a property and its value. | Metadata/PCGMetadata.h | |
bool SetAttributeFromProperty
(
FPCGAttributeIdentifier AttributeName, |
Set an attribute given a property and its value. | Metadata/PCGMetadata.h | |
void SetAttributes
(
const TArrayView< const PCGMetadataEntryKey >& InKeys, |
Metadata/PCGMetadata.h | ||
void SetAttributes
(
const TArrayView< const PCGMetadataEntryKey >& InOriginalKeys, |
Metadata/PCGMetadata.h | ||
void SetAttributes
(
PCGMetadataEntryKey InKey, |
Metadata/PCGMetadata.h | ||
void SetAttributesByKey
(
int64 Key, |
Metadata/PCGMetadata.h |
|
|
void SetPointAttributes
(
const FPCGPoint& Point, |
Metadata/PCGMetadata.h |
|
|
void SetPointAttributes
(
const TArrayView< const FPCGPoint >& InPoints, |
Metadata/PCGMetadata.h | ||
void SetupDomain
(
FPCGMetadataDomainID DomainID, |
To be called by the outer pcg data to initialize the domains supported for this data. | Metadata/PCGMetadata.h | |
void SetupDomainsFromPCGDataType () |
If we have floating metadata , setup it to match a given data type. | Metadata/PCGMetadata.h | |
void SetupDomainsFromPCGDataType
(
const TSubclassOf< UPCGData >& PCGDataType |
Metadata/PCGMetadata.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Serialize
(
FArchive& InArchive |
Metadata/PCGMetadata.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPCGMetadataAttributeBase * CopyAttribute
(
FPCGAttributeIdentifier AttributeToCopy, |
Metadata/PCGMetadata.h | ||
FPCGMetadataDomain * CreateMetadataDomain_Unsafe
(
const FPCGMetadataDomainID& InMetadataDomainID |
Metadata/PCGMetadata.h | ||
FPCGMetadataDomain * FindOrCreateMetadataDomain
(
const FPCGMetadataDomainID& InMetadataDomainID |
Metadata/PCGMetadata.h | ||
bool ParentHasAttribute
(
FPCGAttributeIdentifier AttributeName |
Metadata/PCGMetadata.h | ||
void SetLastCachedSelectorOnOwner
(
FName AttributeName, |
Metadata/PCGMetadata.h | ||
void SetupDomainsFromOtherMetadataIfNeeded
(
const UPCGMetadata* OtherMetadata |
Metadata/PCGMetadata.h |