1. Epic GamesDeveloper
  3. FPropertyBindingBindingCollection

FPropertyBindingBindingCollection

Base structure to inherit from to facilitate operations on property bindings.

API > API/Plugins > API/Plugins/PropertyBindingUtils

Base structure to inherit from to facilitate operations on property bindings.

   
Name FPropertyBindingBindingCollection
Type struct
Header File /Engine/Plugins/Runtime/PropertyBindingUtils/Source/PropertyBindingUtils/Public/PropertyBindingBindingCollection.h
Include Path #include "PropertyBindingBindingCollection.h"

Syntax

USTRUCT ()  
struct FPropertyBindingBindingCollection

Derived Classes

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FPropertyBindingBindingCollection()

   PropertyBindingBindingCollection.h  

Enums

Public

Name Remarks
ESearchMode Enum describing what is required for a binding path to be considered a match for a binding
EVisitResult Result returned from a visitor functor indicating to continue or to quit early

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bBindingsResolved bool Flag indicating if the properties has been resolved successfully . PropertyBindingBindingCollection.h  
PropertyIndirections TArray< FPropertyBindingPropertyIndirection > Array of property indirections, indexed by accesses PropertyBindingBindingCollection.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddBinding ( const FPropertyBindingPath& InSourcePath,
const FPropertyBindingPath& InTargetPath
)

 Adds binding between source and destination paths. PropertyBindingBindingCollection.h  
  PropertyBindingBindingCollection.h  

bool ContainsAnyStruct ( const TSet< const UStruct* >& InStructs
) const

   PropertyBindingBindingCollection.h  

void CopyBindings ( const FGuid InFromStructID,
const FGuid InToStructID
)

 Copies property bindings from an existing struct to another. PropertyBindingBindingCollection.h  

bool CopyProperty ( const FPropertyBindingCopyInfo& Copy,
FPropertyBindingDataView SourceStructView,
FPropertyBindingDataView TargetStructView
) const

 Copies a property from Source to Target based on the provided Copy. PropertyBindingBindingCollection.h  

const FPropertyBindingBinding * FindBinding ( const FPropertyBindingPath& InTargetPath,
ESearchMode InSearchMode
) const

   PropertyBindingBindingCollection.h  

virtual void ForEachBinding ( FPropertyBindingIndex16 InBegin,
FPropertyBindingIndex16 InEnd,
TFunctionRef< void(const FPropertyBindingBinding&Binding, const int32 BindingIndex)> InFunction
) const

 Iterates through all bindings between indices [Begin, End[ and calls the provided function on each non-mutable binding. To be able to modify the binding, use ForEachMutableBinding To be able to break iteration, use VisitBindings or VisitMutableBindings PropertyBindingBindingCollection.h  

virtual void ForEachBinding ( TFunctionRef< void(const FPropertyBindingBinding&Binding)> InFunction
) const

 Iterates through all bindings and calls the provided function on each non-mutable binding. PropertyBindingBindingCollection.h  
Iterates through all bindings and calls the provided function on each mutable binding. PropertyBindingBindingCollection.h  

const FPropertyBindingCopyInfoBatch & GetBatch ( const FPropertyBindingIndex16 TargetBatchIndex
) const

   PropertyBindingBindingCollection.h  

TConstArrayView< FPropertyBindingCopyInfo > GetBatchCopies ( const FPropertyBindingCopyInfoBatch& Batch
) const

   PropertyBindingBindingCollection.h  

TConstArrayView< FPropertyBindingCopyInfo > GetBatchCopies ( const FPropertyBindingIndex16 TargetBatchIndex
) const

   PropertyBindingBindingCollection.h  

virtual const FPropertyBindingBindableStructDescriptor * GetBindableStructDescriptorFromHandle ( FConstStructView InSourceHandleView
) const

   PropertyBindingBindingCollection.h  

void GetBindingsFor ( const FGuid InStructID,
TArray< const FPropertyBindingBinding* >& OutBindings
) const

 Returns all pointers to bindings for a specified structs based in struct ID. PropertyBindingBindingCollection.h  

const FPropertyBindingPath * GetBindingSource ( const FPropertyBindingPath& InTargetPath
) const

   PropertyBindingBindingCollection.h  
Get the associated bindings owner. PropertyBindingBindingCollection.h  

const TArray< FPropertyBindingCopyInfoBatch > & GetCopyBatches()

   PropertyBindingBindingCollection.h  

TArray< FPropertyBindingCopyInfoBatch > & GetMutableCopyBatches()

   PropertyBindingBindingCollection.h  

virtual int32 GetNumBindableStructDescriptors()

   PropertyBindingBindingCollection.h  

virtual int32 GetNumBindings()

   PropertyBindingBindingCollection.h  

int32 GetNumCopyBatches()

   PropertyBindingBindingCollection.h  

bool HasBinding ( const FPropertyBindingPath& InTargetPath,
ESearchMode InSearchMode
) const

 Has any binding to the target path. PropertyBindingBindingCollection.h  

bool IsValid()

   PropertyBindingBindingCollection.h  

virtual void OnBindingsOwnerSet ( TScriptInterface< IPropertyBindingBindingCollectionOwner > InBindingsOwner
)

 Can be overridden by derived classed to track newly assigned bindings owner interface. PropertyBindingBindingCollection.h  

virtual void OnReset()

 Optional virtual that derived classes could override to when bindings should be reset. PropertyBindingBindingCollection.h  

virtual bool OnResolvingPaths()

 Optional virtual that derived classes could override to resolve additional paths. PropertyBindingBindingCollection.h  

void RemoveBindings ( const FPropertyBindingPath& InTargetPath,
ESearchMode InSearchMode
)

 Removes all bindings to target path. PropertyBindingBindingCollection.h  

void RemoveBindings ( TFunctionRef< bool(FPropertyBindingBinding&)> InPredicate
)

 Removes all bindings that match the predicate PropertyBindingBindingCollection.h  

void RemoveInvalidBindings ( const TMap< FGuid, const FPropertyBindingDataView >& InValidStructs
)

 Removes bindings which do not point to valid structs IDs. PropertyBindingBindingCollection.h  

void Reset()

 Clears all bindings and related data. PropertyBindingBindingCollection.h  

bool ResetObjects ( const FPropertyBindingIndex16 TargetBatchIndex,
FPropertyBindingDataView TargetStructView
) const

 Resets copied properties in TargetStructView. PropertyBindingBindingCollection.h  

bool ResolvePaths()

 Resolves paths to indirections. PropertyBindingBindingCollection.h  

void SetBindingsOwner ( TScriptInterface< IPropertyBindingBindingCollectionOwner > InBindingsOwner
)

 Sets associated bindings owner, used to validate added property paths. PropertyBindingBindingCollection.h  

virtual void VisitBindings ( TFunctionRef< EVisitResult(const FPropertyBindingBinding&Binding)> InFunction
) const

 Iterates through all bindings and calls the provided function on each non-mutable binding. PropertyBindingBindingCollection.h  
Iterates through all bindings and calls the provided function on each mutable binding. PropertyBindingBindingCollection.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual FPropertyBindingBinding * AddBindingInternal ( const FPropertyBindingPath& InSourcePath,
const FPropertyBindingPath& InTargetPath
)

   PropertyBindingBindingCollection.h  

void CopyBindingsImplementation ( const FGuid InFromStructID,
const FGuid InToStructID,
TFunctionRef< bool(const FPropertyBindingBinding&Binding)> CanCopy
)

 Copies property bindings from an existing struct to another. PropertyBindingBindingCollection.h  

virtual void CopyBindingsInternal ( const FGuid InFromStructID,
const FGuid InToStructID
)

   PropertyBindingBindingCollection.h  

FString DebugAsString()

   PropertyBindingBindingCollection.h  

virtual const FPropertyBindingBinding * FindBindingInternal ( TFunctionRef< bool(const FPropertyBindingBinding&)> InPredicate
) const

   PropertyBindingBindingCollection.h  

uint8 * GetAddress ( FPropertyBindingDataView InStructView,
const FPropertyBindingPropertyIndirection& FirstIndirection,
const FProperty* LeafProperty
) const

   PropertyBindingBindingCollection.h  

const UObject * GetLogOwner()

   PropertyBindingBindingCollection.h  

virtual bool HasBindingInternal ( TFunctionRef< bool(const FPropertyBindingBinding&)> InPredicate
) const

   PropertyBindingBindingCollection.h  

bool PerformCopy ( const FPropertyBindingCopyInfo& Copy,
uint8* SourceAddress,
uint8* TargetAddress
) const

   PropertyBindingBindingCollection.h  

void PerformResetObjects ( const FPropertyBindingCopyInfo& Copy,
uint8* TargetAddress
) const

   PropertyBindingBindingCollection.h  

virtual void RemoveBindingsInternal ( TFunctionRef< bool(FPropertyBindingBinding&)> InPredicate
)

   PropertyBindingBindingCollection.h  

bool ResolvePath ( const UStruct* Struct,
const FPropertyBindingPath& Path,
FPropertyBindingPropertyIndirection& OutFirstIndirection,
FPropertyBindingPathIndirection& OutLeafIndirection
)

   PropertyBindingBindingCollection.h  

bool ResolvePath ( const FPropertyBindingDataView DataView,
const FPropertyBindingPath& Path,
FPropertyBindingPropertyIndirection& OutFirstIndirection,
FPropertyBindingPathIndirection& OutLeafIndirection
)

   PropertyBindingBindingCollection.h  

virtual void VisitSourceStructDescriptorInternal ( TFunctionRef< EVisitResult(const FPropertyBindingBindableStructDescriptor&Descriptor)> InFunction
) const

   PropertyBindingBindingCollection.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool ResolveCopyType ( const FPropertyBindingPathIndirection& SourceIndirection,
const FPropertyBindingPathIndirection& TargetIndirection,
FPropertyBindingCopyInfo& OutCopy,
const UScriptStruct* StructReferenceType
)

 Resolves what kind of copy type to use between specified property indirections. PropertyBindingBindingCollection.h  

See Also

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page