ezEngine  Milestone 7
ezAccessorProperty< Class, Type > Class Template Reference

[internal] An implementation of ezTypedMemberProperty that uses custom getter / setter functions to access a property. More...

#include <MemberProperty.h>

Inheritance diagram for ezAccessorProperty< Class, Type >:

Public Types

typedef ezTypeTraits< Type >
::NonConstReferenceType 
RealType
 
typedef Type(Class::* GetterFunc )() const
 
typedef void(Class::* SetterFunc )(Type value)
 

Public Member Functions

 ezAccessorProperty (const char *szPropertyName, GetterFunc getter, SetterFunc setter)
 Constructor.
 
virtual void * GetPropertyPointer (const void *pInstance) const override
 Always returns nullptr; once a property is modified through accessors, there is no point in giving more direct access to others.
 
virtual RealType GetValue (const void *pInstance) const override
 Returns the value of the property. Pass the instance pointer to the surrounding class along.
 
virtual void SetValue (void *pInstance, RealType value) override
 Modifies the value of the property. Pass the instance pointer to the surrounding class along. More...
 
- Public Member Functions inherited from ezTypedMemberProperty< ezTypeTraits< Type >::NonConstReferenceType >
 ezTypedMemberProperty (const char *szPropertyName)
 Passes the property name through to ezAbstractMemberProperty.
 
virtual const ezRTTIGetSpecificType () const override
 Returns the actual type of the property. You can then compare that with known types, eg. compare it to ezGetStaticRTTI<int>() to see whether this is an int property.
 
virtual void SetValue (void *pInstance, ezTypeTraits< Type >::NonConstReferenceTypevalue)=0
 Modifies the value of the property. Pass the instance pointer to the surrounding class along. More...
 
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, void *pObject) 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 ezAbstractMemberProperty
 ezAbstractMemberProperty (const char *szPropertyName)
 Passes the property name through to ezAbstractProperty.
 
virtual ezPropertyCategory::Enum GetCategory () const override
 Returns ezPropertyCategory::Member.
 
- Public Member Functions inherited from ezAbstractProperty
 ezAbstractProperty (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 ezBitflags
< ezPropertyFlags > & 
GetFlags () const
 Returns the flags of the property.
 
ezAbstractPropertyAddFlags (ezBitflags< ezPropertyFlags > flags)
 Adds flags to the property. Returns itself to allow to be called during initialization.
 
ezAbstractPropertyAddAttributes (ezPropertyAttribute *pAttrib1, ezPropertyAttribute *pAttrib2=nullptr, ezPropertyAttribute *pAttrib3=nullptr, ezPropertyAttribute *pAttrib4=nullptr, ezPropertyAttribute *pAttrib5=nullptr, ezPropertyAttribute *pAttrib6=nullptr)
 Adds attributes to the property. Returns itself to allow to be called during initialization. Allocate an attribute using standard 'new'.
 
const ezArrayPtr
< ezPropertyAttribute *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.
 

Private Attributes

GetterFunc m_Getter
 
SetterFunc m_Setter
 

Additional Inherited Members

- Protected Attributes inherited from ezAbstractProperty
ezBitflags< ezPropertyFlagsm_Flags
 
const char * m_szPropertyName
 
ezHybridArray
< ezPropertyAttribute *, 2 > 
m_Attributes
 

Detailed Description

template<typename Class, typename Type>
class ezAccessorProperty< Class, Type >

[internal] An implementation of ezTypedMemberProperty that uses custom getter / setter functions to access a property.

Member Function Documentation

template<typename Class , typename Type >
virtual void ezAccessorProperty< Class, Type >::SetValue ( void *  pInstance,
RealType  value 
)
inlineoverridevirtual

Modifies the value of the property. Pass the instance pointer to the surrounding class along.

Note
Make sure the property is not read-only before calling this, otherwise an assert will fire.

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