FPropertyVisitorPath Struct Reference

#include <PropertyVisitor.h>

Public Types
using	Iterator = TArray< FPropertyVisitorInfo >::TConstIterator

Public Member Functions
	FPropertyVisitorPath ()=default
	FPropertyVisitorPath (TFunction< void(const FPropertyVisitorInfo &)> InOnPushFunc, TFunction< void(const FPropertyVisitorInfo &)> InOnPopFunc)
	FPropertyVisitorPath (const FPropertyVisitorPath &)=default
	FPropertyVisitorPath (FPropertyVisitorPath &&)=default
FPropertyVisitorPath &	operator= (const FPropertyVisitorPath &)=default
FPropertyVisitorPath &	operator= (FPropertyVisitorPath &&)=default
	FPropertyVisitorPath (const FPropertyVisitorInfo &Info)
	FPropertyVisitorPath (TArrayView< const FPropertyVisitorInfo > InPath)
COREUOBJECT_API	FPropertyVisitorPath (const FPropertyChangedEvent &PropertyEvent, const FEditPropertyChain &PropertyChain)
COREUOBJECT_API	FPropertyVisitorPath (const FArchiveSerializedPropertyChain &PropertyChain)
void	Push (const FPropertyVisitorInfo &Info)
FPropertyVisitorInfo	Pop ()
int32	Num () const
FPropertyVisitorInfo &	Top ()
const FPropertyVisitorInfo &	Top () const
const TArray< FPropertyVisitorInfo > &	GetPath () const
COREUOBJECT_API FString	ToString (const TCHAR *Separator=TEXT(".")) const
COREUOBJECT_API void	ToString (FStringBuilderBase &Out, const TCHAR *Separator=TEXT(".")) const
COREUOBJECT_API void	AppendString (FStringBuilderBase &Out, const TCHAR *Separator=TEXT(".")) const
COREUOBJECT_API bool	Contained (const FPropertyVisitorPath &OtherPath, bool *bIsEqual=nullptr) const
COREUOBJECT_API void *	GetPropertyDataPtr (UObject *Object) const
Iterator	GetRootIterator () const
COREUOBJECT_API FArchiveSerializedPropertyChain	ToSerializedPropertyChain () const

Static Public Member Functions
static COREUOBJECT_API Iterator	InvalidIterator ()

Protected Attributes
TArray< FPropertyVisitorInfo >	Path
TFunction< void(const FPropertyVisitorInfo &)>	OnPushFunc
TFunction< void(const FPropertyVisitorInfo &)>	OnPopFunc

Friends
bool	operator== (const FPropertyVisitorPath &A, const FPropertyVisitorPath &B)
bool	operator!= (const FPropertyVisitorPath &A, const FPropertyVisitorPath &B)
uint32	GetTypeHash (const FPropertyVisitorPath &A)

Member Typedef Documentation

Iterator

using FPropertyVisitorPath::Iterator = TArray<FPropertyVisitorInfo>::TConstIterator

Iterator for a property visitor path

Constructor & Destructor Documentation

FPropertyVisitorPath() [1/8]

FPropertyVisitorPath::FPropertyVisitorPath ( )

default

FPropertyVisitorPath() [2/8]

FPropertyVisitorPath::FPropertyVisitorPath ( TFunction< void(const FPropertyVisitorInfo &)>  InOnPushFunc, TFunction< void(const FPropertyVisitorInfo &)>  InOnPopFunc  )

inline

FPropertyVisitorPath() [3/8]

FPropertyVisitorPath::FPropertyVisitorPath ( const FPropertyVisitorPath &  )

default

FPropertyVisitorPath() [4/8]

FPropertyVisitorPath::FPropertyVisitorPath ( FPropertyVisitorPath &&  )

default

FPropertyVisitorPath() [5/8]

FPropertyVisitorPath::FPropertyVisitorPath ( const FPropertyVisitorInfo &  Info )

inlineexplicit

FPropertyVisitorPath() [6/8]

FPropertyVisitorPath::FPropertyVisitorPath ( TArrayView< const FPropertyVisitorInfo >  InPath )

inlineexplicit

FPropertyVisitorPath() [7/8]

FPropertyVisitorPath::FPropertyVisitorPath ( const FPropertyChangedEvent &  PropertyEvent, const FEditPropertyChain &  PropertyChain  )

explicit

FPropertyVisitorPath() [8/8]

FPropertyVisitorPath::FPropertyVisitorPath ( const FArchiveSerializedPropertyChain &  PropertyChain )

explicit

Member Function Documentation

AppendString()

void FPropertyVisitorPath::AppendString	(	FStringBuilderBase &	Out,
		const TCHAR *	Separator = TEXT(".")
	)		const

Contained()

bool FPropertyVisitorPath::Contained	(	const FPropertyVisitorPath &	OtherPath,
		bool *	bIsEqual = nullptr
	)		const

Is this property path contained in the specified one

Parameters

OtherPath	property path to check if it is contained in
bIsEqual	optional parameter to know if it fully match

Returns

true if it is contained in the specified path

GetPath()

const TArray< FPropertyVisitorInfo > & FPropertyVisitorPath::GetPath ( ) const

inline

GetPropertyDataPtr()

void * FPropertyVisitorPath::GetPropertyDataPtr

(

UObject *

Object

)

const

Retrieves the data using the specified root object

Parameters

Object

to search into

Returns

GetRootIterator()

Iterator FPropertyVisitorPath::GetRootIterator ( ) const

inline

Returns an iterator on the root path node, useful when calling methods that are recursive

Returns

an iterator on the root path node

InvalidIterator()

FPropertyVisitorPath::Iterator FPropertyVisitorPath::InvalidIterator ( )

static

Invalid iterator pointing to an empty path

Returns

an iterator to an empty path

Num()

int32 FPropertyVisitorPath::Num ( ) const

inline

operator=() [1/2]

FPropertyVisitorPath & FPropertyVisitorPath::operator= ( const FPropertyVisitorPath &  )

default

operator=() [2/2]

FPropertyVisitorPath & FPropertyVisitorPath::operator= ( FPropertyVisitorPath &&  )

default

Pop()

FPropertyVisitorInfo FPropertyVisitorPath::Pop ( )

inline

Push()

void FPropertyVisitorPath::Push ( const FPropertyVisitorInfo &  Info )

inline

Top() [1/2]

FPropertyVisitorInfo & FPropertyVisitorPath::Top ( )

inline

Top() [2/2]

const FPropertyVisitorInfo & FPropertyVisitorPath::Top ( ) const

inline

ToSerializedPropertyChain()

FArchiveSerializedPropertyChain FPropertyVisitorPath::ToSerializedPropertyChain

(

)

const

Converts path to an archive serialized property chain This method useful when APIs like in the FOverridableManager are taking in a FArchiveSerializedPropertyChain parameter and would like to use them. It is used in many places in the FProperty::ImportText

Returns

the archive serialized property chain built from the property path

ToString() [1/2]

FString FPropertyVisitorPath::ToString

(

const TCHAR *

Separator = TEXT(".")

)

const

ToString() [2/2]

void FPropertyVisitorPath::ToString	(	FStringBuilderBase &	Out,
		const TCHAR *	Separator = TEXT(".")
	)		const

Friends And Related Symbol Documentation

GetTypeHash

uint32 GetTypeHash ( const FPropertyVisitorPath &  A )

friend

operator!=

bool operator!= ( const FPropertyVisitorPath &  A, const FPropertyVisitorPath &  B  )

friend

operator==

bool operator== ( const FPropertyVisitorPath &  A, const FPropertyVisitorPath &  B  )

friend

Member Data Documentation

OnPopFunc

TFunction<void(const FPropertyVisitorInfo&)> FPropertyVisitorPath::OnPopFunc

protected

OnPushFunc

TFunction<void(const FPropertyVisitorInfo&)> FPropertyVisitorPath::OnPushFunc

protected

Path

TArray<FPropertyVisitorInfo> FPropertyVisitorPath::Path

protected

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/CoreUObject/Public/UObject/PropertyVisitor.h
• Engine/Source/Runtime/CoreUObject/Private/UObject/PropertyVisitor.cpp