Helper functions for handling reflection related operations. More...

#include <ReflectionUtils.h>

Classes
struct	EnumConversionMode

struct	EnumKeyValuePair

Static Public Member Functions
static const plRTTI *	GetCommonBaseType (const plRTTI pRtti1, const plRTTI pRtti2)

static bool	IsBasicType (const plRTTI *pRtti)
	Returns whether a type can be stored directly inside a plVariant.

static bool	IsValueType (const plAbstractProperty *pProp)
	Returns whether the property is a non-ptr basic type or custom type.

static const plRTTI *	GetTypeFromVariant (const plVariant &value)
	Returns the RTTI type matching the variant's type.

static const plRTTI *	GetTypeFromVariant (plVariantType::Enum type)

static plUInt32	GetComponentCount (plVariantType::Enum type)
	Sets the Nth component of the vector to the given value.

static void	SetComponent (plVariant &ref_vector, plUInt32 uiComponent, double fValue)

static double	GetComponent (const plVariant &vector, plUInt32 uiComponent)

static plVariant	GetMemberPropertyValue (const plAbstractMemberProperty pProp, const void pObject)

static void	SetMemberPropertyValue (const plAbstractMemberProperty pProp, void pObject, const plVariant &value)

static plVariant	GetArrayPropertyValue (const plAbstractArrayProperty pProp, const void pObject, plUInt32 uiIndex)

static void	SetArrayPropertyValue (const plAbstractArrayProperty pProp, void pObject, plUInt32 uiIndex, const plVariant &value)

static void	InsertSetPropertyValue (const plAbstractSetProperty pProp, void pObject, const plVariant &value)

static void	RemoveSetPropertyValue (const plAbstractSetProperty pProp, void pObject, const plVariant &value)

static plVariant	GetMapPropertyValue (const plAbstractMapProperty pProp, const void pObject, const char *szKey)

static void	SetMapPropertyValue (const plAbstractMapProperty pProp, void pObject, const char *szKey, const plVariant &value)

static void	InsertArrayPropertyValue (const plAbstractArrayProperty pProp, void pObject, const plVariant &value, plUInt32 uiIndex)

static void	RemoveArrayPropertyValue (const plAbstractArrayProperty pProp, void pObject, plUInt32 uiIndex)

static const plAbstractMemberProperty *	GetMemberProperty (const plRTTI *pRtti, plUInt32 uiPropertyIndex)

static const plAbstractMemberProperty *	GetMemberProperty (const plRTTI pRtti, const char szPropertyName)

static void	GatherTypesDerivedFromClass (const plRTTI pRtti, plSet< const plRTTI > &out_types)
	Gathers all RTTI types that are derived from pRtti.

static void	GatherDependentTypes (const plRTTI pRtti, plSet< const plRTTI > &inout_typesAsSet, plDynamicArray< const plRTTI * > *out_pTypesAsStack=nullptr)
	Gathers all RTTI types that pRtti depends on and adds them to inout_types.

static plResult	CreateDependencySortedTypeArray (const plSet< const plRTTI * > &types, plDynamicArray< const plRTTI * > &out_sortedTypes)
	Sorts the input types according to their dependencies.

static bool	EnumerationToString (const plRTTI *pEnumerationRtti, plInt64 iValue, plStringBuilder &out_sOutput, plEnum< EnumConversionMode > conversionMode=EnumConversionMode::Default)
	Converts an enum or bitfield value into its string representation.

template<typename T >
static bool	EnumerationToString (plEnum< T > value, plStringBuilder &out_sOutput, plEnum< EnumConversionMode > conversionMode=EnumConversionMode::Default)
	Helper template to shorten the call for plEnums.

template<typename T >
static bool	BitflagsToString (plBitflags< T > value, plStringBuilder &out_sOutput, plEnum< EnumConversionMode > conversionMode=EnumConversionMode::Default)
	Helper template to shorten the call for plBitflags.

static void	GetEnumKeysAndValues (const plRTTI *pEnumerationRtti, plDynamicArray< EnumKeyValuePair > &ref_entries, plEnum< EnumConversionMode > conversionMode=EnumConversionMode::Default)
	If the given type is an enum, entries will be filled with all available keys (strings) and values (integers).

static bool	StringToEnumeration (const plRTTI pEnumerationRtti, const char szValue, plInt64 &out_iValue)
	Converts an enum or bitfield in its string representation to its value.

template<typename T >
static bool	StringToEnumeration (const char *szValue, plEnum< T > &out_value)
	Helper template to shorten the call for plEnums.

static plInt64	DefaultEnumerationValue (const plRTTI *pEnumerationRtti)
	Returns the default value (Enum::Default) for the given enumeration type.

static plInt64	MakeEnumerationValid (const plRTTI *pEnumerationRtti, plInt64 iValue)
	Makes sure the given value is valid under the given enumeration type.

template<typename T >
static bool	IsEqual (const T pObject, const T pObject2)
	Templated convenience function that calls IsEqual and automatically deduces the type.

static bool	IsEqual (const void pObject, const void pObject2, const plRTTI *pType)
	Compares pObject with pObject2 of type pType and returns whether they are equal.

static bool	IsEqual (const void pObject, const void pObject2, const plAbstractProperty *pProp)
	Compares property pProp of pObject and pObject2 and returns whether it is equal in both.

static void	DeleteObject (void pObject, const plAbstractProperty pOwnerProperty)
	Deletes pObject using the allocator found in the owning property's type.

static plVariant	GetDefaultVariantFromType (plVariant::Type::Enum type)
	Returns a global default initialization value for the given variant type.

static plVariant	GetDefaultVariantFromType (const plRTTI *pRtti)
	Returns the default value for the specific type.

static plVariant	GetDefaultValue (const plAbstractProperty *pProperty, plVariant index=plVariant())
	Returns the default value for the specific type of the given property.

static void	SetAllMemberPropertiesToDefault (const plRTTI pRtti, void pObject)
	Sets all member properties in pObject of type pRtti to the value returned by plToolsReflectionUtils::GetDefaultValue()

static plResult	ClampValue (plVariant &value, const plClampValueAttribute *pAttrib)
	If pAttrib is valid and its min/max values are compatible, value will be clamped to them. Returns false if a clamp attribute exists but no clamp code was executed.

Detailed Description

Helper functions for handling reflection related operations.

Member Function Documentation

◆ CreateDependencySortedTypeArray()

plResult plReflectionUtils::CreateDependencySortedTypeArray	(	const plSet< const plRTTI * > &	types,
		plDynamicArray< const plRTTI * > &	out_sortedTypes )

static

Sorts the input types according to their dependencies.

Types that have no dependences come first in the output followed by types that have their dependencies met by the previous entries in the output. If a dependent type is not in the given types set the function will fail.

◆ EnumerationToString()

bool plReflectionUtils::EnumerationToString	(	const plRTTI *	pEnumerationRtti,
		plInt64	iValue,
		plStringBuilder &	out_sOutput,
		plEnum< EnumConversionMode >	conversionMode = EnumConversionMode::Default )

static

Converts an enum or bitfield value into its string representation.

The type of pEnumerationRtti will be automatically detected. The syntax of out_sOutput equals MSVC debugger output.

◆ GatherDependentTypes()

void plReflectionUtils::GatherDependentTypes	(	const plRTTI *	pRtti,
		plSet< const plRTTI * > &	inout_typesAsSet,
		plDynamicArray< const plRTTI * > *	out_pTypesAsStack = nullptr )

static

Gathers all RTTI types that pRtti depends on and adds them to inout_types.

Dependencies are either member properties or base classes. The output contains the transitive closure of the dependencies. Note that inout_typesAsSet is not cleared when this function is called. out_pTypesAsStack is all the dependencies sorted by their appearance in the dependency chain. The last entry is the lowest in the chain and has no dependencies on its own.

◆ GatherTypesDerivedFromClass()

void plReflectionUtils::GatherTypesDerivedFromClass	(	const plRTTI *	pRtti,
		plSet< const plRTTI * > &	out_types )

static

Gathers all RTTI types that are derived from pRtti.

This includes all classes that have pRtti as a base class, either direct or indirect.

See also: GatherDependentTypes

◆ GetComponentCount()

plUInt32 plReflectionUtils::GetComponentCount ( plVariantType::Enum type )

static

Sets the Nth component of the vector to the given value.

vector's type needs to be in between plVariant::Type::Vector2 and plVariant::Type::Vector4U.

◆ GetEnumKeysAndValues()

void plReflectionUtils::GetEnumKeysAndValues	(	const plRTTI *	pEnumerationRtti,
		plDynamicArray< EnumKeyValuePair > &	ref_entries,
		plEnum< EnumConversionMode >	conversionMode = EnumConversionMode::Default )

static

If the given type is an enum, entries will be filled with all available keys (strings) and values (integers).

Test: This is new.

◆ IsEqual()

bool plReflectionUtils::IsEqual	(	const void *	pObject,
		const void *	pObject2,
		const plRTTI *	pType )

static

Compares pObject with pObject2 of type pType and returns whether they are equal.

In case a class derived from plReflectedClass is passed in the correct derived type will automatically be determined so it is not necessary to put the exact type into pType, any derived class type will do. However, the function will return false pObject and pObject2 actually have a different type.

◆ MakeEnumerationValid()

plInt64 plReflectionUtils::MakeEnumerationValid	(	const plRTTI *	pEnumerationRtti,
		plInt64	iValue )

static

Makes sure the given value is valid under the given enumeration type.

Invalid bitflag bits are removed and an invalid enum value is replaced by the default value.

◆ StringToEnumeration()

bool plReflectionUtils::StringToEnumeration	(	const plRTTI *	pEnumerationRtti,
		const char *	szValue,
		plInt64 &	out_iValue )

static

Converts an enum or bitfield in its string representation to its value.

The type of pEnumerationRtti will be automatically detected. The syntax of szValue must equal the MSVC debugger output.

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

Code/Engine/Foundation/Reflection/ReflectionUtils.h
Code/Engine/Foundation/Reflection/Implementation/ReflectionUtils.cpp

Classes

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ CreateDependencySortedTypeArray()

◆ EnumerationToString()

◆ GatherDependentTypes()

◆ GatherTypesDerivedFromClass()

◆ GetComponentCount()

◆ GetEnumKeysAndValues()

◆ IsEqual()

◆ MakeEnumerationValid()

◆ StringToEnumeration()