1. Epic GamesDeveloper
  3. UPCGMetadata

UPCGMetadata

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

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;BlueprintType&41;  
class UPCGMetadata : public UObject

Variables

  Type Name Description
Protected variable FRWLock AttributeLock  
Protected variable TMap< FName, FPCGMetadataAttributeBase * > Attributes  
Protected variable TAtomic< int64 > DelayedEntriesIndex  
Protected variable int64 ItemKeyOffset  
Protected variable FRWLock ItemLock  
Protected variable PCGMetadataAttributeKey NextAttributeId  
Protected variable UProperty TSet< TWeakObjectPtr< const UPCGMetadata > > OtherParents Set of parents kept for streams relationship and GC collection But otherwise not used directly
Protected variable UProperty TObjectPtr< const UPCGMetadata > Parent  
Protected variable TArray< PCGMetadataEntryKey > ParentKeys  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void

AccumulatePointWeightedAttributes ( const FPCGPoint& InPoint,
const UPCGMetadata* InMetadata,
float Weight,
bool bSetNonInterpolableAttributes,
FPCGPoint& OutPoint
)

  
Public function void

AccumulateWeightedAttributes ( PCGMetadataEntryKey InKey,
const UPCGMetadata* InMetadata,
float Weight,
bool bSetNonInterpolableAttributes,
PCGMetadataEntryKey& OutKey
)

  
Public function UFunction BlueprintCallable, Category void

AccumulateWeightedAttributesByKey ( int64 Key,
const UPCGMetadata* Metadata,
float Weight,
bool bSetNonInterpolableAttributes,
int64 TargetKey,
int64& OutKey
)

  
Public function UFunction BlueprintCallable, Category void

AddAttribute ( const UPCGMetadata* InOther,
FName AttributeName
)

 Creates missing attribute from another metadata if it is not currently present - note that this does not copy values
Protected function void

AddAttributeInternal ( FName AttributeName,
FPCGMetadataAttributeBase* Attribute
)

  
Public function UFunction BlueprintCallable, Category void

AddAttributes ( const UPCGMetadata* InOther
)

 Creates missing attributes from another metadata if they are not currently present - note that this does not copy values
Public function UFunction BlueprintCallable, Category void

AddAttributesFiltered ( const UPCGMetadata* InOther,
const TSet< FName >& InFilteredAttributes,
EPCGMetadataFilterMode InFilterMode
)

 Creates missing attributes from another metadata if they are not currently present - note that this does not copy values.
Public function void

AddDelayedEntries ( const TArray< TTuple< int64, int64 >>& AllEntries
)

 Advanced method.
Public function UFunction BlueprintCallable, Category int64

AddEntry ( int64 ParentEntryKey
)

 Adds a unique entry key to the metadata
Public function int64 Advanced method.
Public function UFunction BlueprintCallable, Category void

ClearAttribute ( FName AttributeToClear
)

 Clear/Reinit attribute
Public function void

ComputePointWeightedAttribute ( FPCGPoint& OutPoint,
const TArrayView< TPair< const FPCGPoint*, float >>& InWeightedPoints,
const UPCGMetadata* InMetadata
)

  
Public function void

ComputeWeightedAttribute ( PCGMetadataEntryKey& OutKey,
const TArrayView< TPair< PCGMetadataEntryKey, float >>& InWeightedKeys,
const UPCGMetadata* InMetadata
)

  
Protected function FPCGMetadataAttributeBase *

CopyAttribute ( FName AttributeToCopy,
FName NewAttributeName,
bool bKeepParent,
bool bCopyEntries,
bool bCopyValues
)

  
Public function FPCGMetadataAttributeBase *

CopyAttribute ( const FPCGMetadataAttributeBase* OriginalAttribute,
FName NewAttributeName,
bool bKeepParent,
bool bCopyEntries,
bool bCopyValues
)

 Copies another attribute, with options to keep its parent and copy entries/values
Public function UFunction BlueprintCallable, Category void

CopyAttribute ( const UPCGMetadata* InOther,
FName AttributeToCopy,
FName NewAttributeName
)

 Copies an attribute from another metadata, including entries & values.
Public function UFunction BlueprintCallable, Category void

CopyAttributes ( const UPCGMetadata* InOther
)

 Copies attributes from another metadata, including entries & values.
Public function UFunction BlueprintCallable, Category bool

CopyExistingAttribute ( FName AttributeToCopy,
FName NewAttributeName,
bool bKeepParent
)

 Copy attribute
Public function FPCGMetadataAttribute< T > *

CreateAttribute ( FName AttributeName,
const T& DefaultValue,
bool bAllowsInterpolation,
bool bOverrideParent
)

 Create a new attribute.
Public function bool

CreateAttributeFromDataProperty ( FName AttributeName,
const void* Data,
const FProperty* Property
)

 Creates an attribute given a property.
Public function bool

CreateAttributeFromProperty ( FName AttributeName,
const UObject* Object,
const FProperty* Property
)

 Creates an attribute given a property.
Public function UFunction BlueprintCallable, Category void

CreateBoolAttribute ( FName AttributeName,
bool DefaultValue,
bool bAllowsInterpolation,
bool bOverrideParent
)

  
Public function UFunction BlueprintCallable, Category void

CreateDoubleAttribute ( FName AttributeName,
double DefaultValue,
bool bAllowsInterpolation,
bool bOverrideParent
)

  
Public function UFunction BlueprintCallable, Category void

CreateFloatAttribute ( FName AttributeName,
float DefaultValue,
bool bAllowsInterpolation,
bool bOverrideParent
)

  
Public function UFunction BlueprintCallable, Category void

CreateInteger32Attribute ( FName AttributeName,
int32 DefaultValue,
bool bAllowsInterpolation,
bool bOverrideParent
)

 Create new streams
Public function UFunction BlueprintCallable, Category void

CreateInteger64Attribute ( FName AttributeName,
int64 DefaultValue,
bool bAllowsInterpolation,
bool bOverrideParent
)

  
Public function UFunction BlueprintCallable, Category void

CreateNameAttribute ( FName AttributeName,
FName DefaultValue,
bool bAllowsInterpolation,
bool bOverrideParent
)

  
Public function UFunction BlueprintCallable, Category void

CreateQuatAttribute ( FName AttributeName,
FQuat DefaultValue,
bool bAllowsInterpolation,
bool bOverrideParent
)

  
Public function UFunction BlueprintCallable, Category void

CreateRotatorAttribute ( FName AttributeName,
FRotator DefaultValue,
bool bAllowsInterpolation,
bool bOverrideParent
)

  
Public function UFunction BlueprintCallable, Category void

CreateStringAttribute ( FName AttributeName,
FString DefaultValue,
bool bAllowsInterpolation,
bool bOverrideParent
)

  
Public function UFunction BlueprintCallable, Category void

CreateTransformAttribute ( FName AttributeName,
FTransform DefaultValue,
bool bAllowsInterpolation,
bool bOverrideParent
)

  
Public function UFunction BlueprintCallable, Category void

CreateVector2Attribute ( FName AttributeName,
FVector2D DefaultValue,
bool bAllowsInterpolation,
bool bOverrideParent
)

  
Public function UFunction BlueprintCallable, Category, Meta void

CreateVector4Attribute ( FName AttributeName,
FVector4 DefaultValue,
bool bAllowsInterpolation,
bool bOverrideParent
)

  
Public function UFunction BlueprintCallable, Category void

CreateVectorAttribute ( FName AttributeName,
FVector DefaultValue,
bool bAllowsInterpolation,
bool bOverrideParent
)

  
Public function UFunction BlueprintCallable, Category void

DeleteAttribute ( FName AttributeName
)

 Due to stream inheriting, we might want to consider "hiding" parent stream and deleting local streams only.
Public function FPCGMetadataAttribute< T > *

FindOrCreateAttribute ( FName AttributeName,
const T& DefaultValue,
bool bAllowsInterpolation,
bool bOverrideParent,
bool bOverwriteIfTypeMismatch
)

 Find or create an attribute.
Public function UFunction BlueprintCallable, Category void

Flatten ()

 Unparents current metadata by flattening the attributes (values, entries, etc.)
Public function Const int32  
Public function Const UFunction BlueprintCallable, Category void

GetAttributes ( TArray< FName >& AttributeNames,
TArray< EPCGMetadataTypes >& AttributeTypes
)

  
Public function Const const FPCGMetadataAttributeBase *

GetConstAttribute ( FName AttributeName
)

  
Public function Const const FPCGMetadataAttributeBase *

GetConstAttributeById ( int32 AttributeId
)

  
Public function Const const FPCGMetadataAttribute< T > *

GetConstTypedAttribute ( FName AttributeName
)

  
Public function Const int64  
Public function Const int64  
Public function Const FName  
Public function FPCGMetadataAttributeBase *

GetMutableAttribute ( FName AttributeName
)

 Get attributes
Public function FPCGMetadataAttribute< T > *

GetMutableTypedAttribute ( FName AttributeName
)

  
Public function Const const UPCGMetadata *  
Public function Const PCGMetadataEntryKey Metadata chaining mechanism
Public function Const TWeakObjectPtr< const UPCGMetadata > Returns this metadata's parent
Public function Const const UPCGMetadata *

GetRoot ()

  
Public function Const UFunction BlueprintCallable, Category bool

HasAttribute ( FName AttributeName
)

  
Public function Const UFunction BlueprintCallable, Category bool

HasCommonAttributes ( const UPCGMetadata* InMetadata
)

  
Public function Const bool

HasParent ( const UPCGMetadata* InTentativeParent
)

  
Public function UFunction BlueprintCallable, Category void

Initialize ( const UPCGMetadata* InParent
)

 Initializes the metadata from a parent metadata, if any (can be null).
Public function void

Initialize ( const UPCGMetadata* InParent,
bool bAddAttributesFromParent
)

 Initializes the metadata from a parent metadata, if any (can be null) with the option to not add attributes from the parent.
Public function UFunction BlueprintCallable, Category void

InitializeAsCopy ( const UPCGMetadata* InMetadataToCopy
)

 Initializes the metadata from a parent metadata by copying all attributes to it.
Public function UFunction BlueprintCallable, Category void

InitializeAsCopyWithAttributeFilter ( const UPCGMetadata* InMetadataToCopy,
const TSet< FName >& InFilteredAttributes,
EPCGMetadataFilterMode InFilterMode
)

 Initializes the metadata from a parent metadata by copy filtered attributes only to it
Public function bool

InitializeOnSet ( PCGMetadataEntryKey& InKey,
PCGMetadataEntryKey InParentKeyA,
const UPCGMetadata* InParentMetadataA,
PCGMetadataEntryKey InParentKeyB,
const UPCGMetadata* InParentMetadataB
)

 Initializes the metadata entry key. Returns true if key set from either parent
Public function UFunction BlueprintCallable, Category void

InitializeWithAttributeFilter ( const UPCGMetadata* InParent,
const TSet< FName >& InFilteredAttributes,
EPCGMetadataFilterMode InFilterMode
)

 Initializes the metadata from a parent metadata. Copies attributes and values.
Public function void

MergeAttributes ( PCGMetadataEntryKey InKeyA,
const UPCGMetadata* InMetadataA,
PCGMetadataEntryKey InKeyB,
const UPCGMetadata* InMetadataB,
PCGMetadataEntryKey& OutKey,
EPCGMetadataOp Op
)

 Attributes operations
Public function UFunction BlueprintCallable, Category void

MergeAttributesByKey ( int64 KeyA,
const UPCGMetadata* MetadataA,
int64 KeyB,
const UPCGMetadata* MetadataB,
int64 TargetKey,
EPCGMetadataOp Op,
int64& OutKey
)

 Blueprint-friend versions
Public function void

MergeAttributesSubset ( PCGMetadataEntryKey InKeyA,
const UPCGMetadata* InMetadataA,
const UPCGMetadata* InMetadataSubetA,
PCGMetadataEntryKey InKeyB,
const UPCGMetadata* InMetadataB,
const UPCGMetadata* InMetadataSubsetb,
PCGMetadataEntryKey& OutKey,
EPCGMetadataOp Op
)

 Attributes operations
Public function UFunction BlueprintCallable, Category void

MergePointAttributes ( const FPCGPoint& PointA,
const UPCGMetadata* MetadataA,
const FPCGPoint& PointB,
const UPCGMetadata* MetadataB,
FPCGPoint& TargetPoint,
EPCGMetadataOp Op
)

  
Public function void

MergePointAttributes ( const FPCGPoint& InPointA,
const FPCGPoint& InPointB,
FPCGPoint& OutPoint,
EPCGMetadataOp Op
)

 Attributes operations - shorthand for points
Public function void

MergePointAttributesSubset ( const FPCGPoint& InPointA,
const UPCGMetadata* InMetadataA,
const UPCGMetadata* InMetadataSubetA,
const FPCGPoint& InPointB,
const UPCGMetadata* InMetadataB,
const UPCGMetadata* InMetadataSubsetb,
FPCGPoint& OutPoint,
EPCGMetadataOp Op
)

 Attributes operations - shorthand for points
Protected function Const bool

ParentHasAttribute ( FName AttributeName
)

  
Protected function void

RemoveAttributeInternal ( FName AttributeName
)

  
Public function UFunction BlueprintCallable, Category bool

RenameAttribute ( FName AttributeToRename,
FName NewAttributeName
)

 Rename attribute
Public function UFunction BlueprintCallable, Category void  
Public function void  
Public function UFunction BlueprintCallable, Category void

ResetWeightedAttributesByKey ( int64 TargetKey,
int64& OutKey
)

  
Public function bool

SetAttributeFromDataProperty ( FName AttributeName,
PCGMetadataEntryKey& EntryKey,
const void* Data,
const FProperty* Property,
bool bCreate
)

 Set an attribute given a property and its value.
Public function bool

SetAttributeFromProperty ( FName AttributeName,
PCGMetadataEntryKey& EntryKey,
const UObject* Object,
const FProperty* Property,
bool bCreate
)

 Set an attribute given a property and its value.
Public function void

SetAttributes ( PCGMetadataEntryKey InKey,
const UPCGMetadata* InMetadata,
PCGMetadataEntryKey& OutKey
)

  
Public function void

SetAttributes ( const TArrayView< PCGMetadataEntryKey >& InKeys,
const UPCGMetadata* InMetadata,
const TArrayView< PCGMetadataEntryKey >& OutKeys
)

  
Public function UFunction BlueprintCallable, Category void

SetAttributesByKey ( int64 Key,
const UPCGMetadata* InMetadata,
int64 TargetKey,
int64& OutKey
)

  
Protected function void  
Public function void

SetPointAttributes ( const TArrayView< const FPCGPoint >& InPoints,
const UPCGMetadata* InMetadata,
const TArrayView< FPCGPoint >& OutPoints
)

  
Public function UFunction BlueprintCallable, Category void

SetPointAttributes ( const FPCGPoint& Point,
const UPCGMetadata* Metadata,
FPCGPoint& OutPoint
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page