plPhantomMemberProperty Class Reference

Inheritance diagram for plPhantomMemberProperty:

Public Member Functions
	plPhantomMemberProperty (const plReflectedPropertyDescriptor *pDesc)
virtual const plRTTI *	GetSpecificType () const override
	Returns the type information of the constant property. Use this to cast this property to a specific version of plTypedConstantProperty.
virtual void *	GetPropertyPointer (const void *pInstance) const override
	Returns a pointer to the property data or nullptr. If a valid pointer is returned, that pointer and the information from GetSpecificType() can be used to step deeper into the type (if required).
virtual void	GetValuePtr (const void *pInstance, void *pObject) const override
	Writes the value of this property in pInstance to pObject. pObject needs to point to an instance of this property's type.
virtual void	SetValuePtr (void *pInstance, const void *pObject) const override
	Sets the value of pObject to the property in pInstance. pObject needs to point to an instance of this property's type.
Public Member Functions inherited from plAbstractMemberProperty
	plAbstractMemberProperty (const char *szPropertyName)
	Passes the property name through to plAbstractProperty.
virtual plPropertyCategory::Enum	GetCategory () const override
	Returns plPropertyCategory::Member.
Public Member Functions inherited from plAbstractProperty
	plAbstractProperty (const char *szPropertyName)
	The constructor must get the name of the property. The string must be a compile-time constant.
const char *	GetPropertyName () const
	Returns the name of the property.
const plBitflags< plPropertyFlags > &	GetFlags () const
	Returns the flags of the property.
plAbstractProperty *	AddFlags (plBitflags< plPropertyFlags > flags)
	Adds flags to the property. Returns itself to allow to be called during initialization.
plAbstractProperty *	AddAttributes (plPropertyAttribute *pAttrib1, plPropertyAttribute *pAttrib2=nullptr, plPropertyAttribute *pAttrib3=nullptr, plPropertyAttribute *pAttrib4=nullptr, plPropertyAttribute *pAttrib5=nullptr, plPropertyAttribute *pAttrib6=nullptr)
	Adds attributes to the property. Returns itself to allow to be called during initialization. Allocate an attribute using standard 'new'.
plArrayPtr< const plPropertyAttribute *const >	GetAttributes () const
	Returns the array of property attributes.
template<typename Type >
const Type *	GetAttributeByType () const
	Returns the first attribute that derives from the given type, or nullptr if nothing is found.

Additional Inherited Members
Protected Attributes inherited from plAbstractProperty
plBitflags< plPropertyFlags >	m_Flags
const char *	m_szPropertyName
plHybridArray< const plPropertyAttribute *, 2, plStaticsAllocatorWrapper >	m_Attributes

Member Function Documentation

GetPropertyPointer()

virtual void * plPhantomMemberProperty::GetPropertyPointer ( const void * pInstance ) const

inlineoverridevirtual

Returns a pointer to the property data or nullptr. If a valid pointer is returned, that pointer and the information from GetSpecificType() can be used to step deeper into the type (if required).

You need to pass the pointer to an object on which you are operating. This function is mostly of interest when the property itself is a compound type (a struct or class). If it is a simple type (int, float, etc.) it doesn't make much sense to retrieve the pointer.

For example GetSpecificType() might return that a property is of type plVec3. In that case one might either stop and just use the code to handle plVec3 types, or one might continue and enumerate all sub-properties (x, y and z) as well.

Note

There is no guarantee that this function returns a non-nullptr pointer, independent of the type. When a property uses custom 'accessors' (functions to get / set the property value), it is not possible (or useful) to get the property pointer.

Implements plAbstractMemberProperty.

GetSpecificType()

const plRTTI * plPhantomMemberProperty::GetSpecificType ( ) const

overridevirtual

Returns the type information of the constant property. Use this to cast this property to a specific version of plTypedConstantProperty.

Implements plAbstractProperty.

GetValuePtr()

virtual void plPhantomMemberProperty::GetValuePtr ( const void * pInstance, void * out_pObject ) const

inlineoverridevirtual

Writes the value of this property in pInstance to pObject. pObject needs to point to an instance of this property's type.

Implements plAbstractMemberProperty.

SetValuePtr()

virtual void plPhantomMemberProperty::SetValuePtr ( void * pInstance, const void * pObject ) const

inlineoverridevirtual

Sets the value of pObject to the property in pInstance. pObject needs to point to an instance of this property's type.

Implements plAbstractMemberProperty.

---

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

• Code/Tools/Libs/ToolsFoundation/Reflection/PhantomProperty.h
• Code/Tools/Libs/ToolsFoundation/Reflection/Implementation/PhantomProperty.cpp