ezEngine  Milestone 7
ezTypedMemberProperty< Type > Class Template Referenceabstract

The base class for all typed member properties. I.e. once the type of a property is determined, it can be cast to the proper version of this. More...

#include <MemberProperty.h>

Inheritance diagram for ezTypedMemberProperty< Type >:

Public Member Functions

 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 Type GetValue (const void *pInstance) const =0
 Returns the value of the property. Pass the instance pointer to the surrounding class along.
 
virtual void SetValue (void *pInstance, Type value)=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.
 
virtual void * GetPropertyPointer (const void *pInstance) const =0
 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). More...
 
- 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.
 

Additional Inherited Members

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

Detailed Description

template<typename Type>
class ezTypedMemberProperty< Type >

The base class for all typed member properties. I.e. once the type of a property is determined, it can be cast to the proper version of this.

For example, when you have a pointer to an ezAbstractMemberProperty and it returns that the property is of type 'int', you can cast the pointer to an pointer to ezTypedMemberProperty<int> which then allows you to access its values.

Member Function Documentation

template<typename Type>
virtual void ezTypedMemberProperty< Type >::SetValue ( void *  pInstance,
Type  value 
)
pure virtual

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.

Implemented in ezMemberProperty< Class, Type >.


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