Plasma Engine  2.0
Loading...
Searching...
No Matches
plTypedEnumProperty< EnumType > Class Template Reference

[internal] Base class for enum / bitflags properties that already defines the type. More...

#include <EnumProperty.h>

Inheritance diagram for plTypedEnumProperty< EnumType >:

Public Member Functions

 plTypedEnumProperty (const char *szPropertyName)
 Passes the property name through to plAbstractEnumerationProperty.
 
virtual const plRTTIGetSpecificType () const override
 Returns the actual type of the property. You can then test whether it derives from plEnumBase or plBitflagsBase to determine whether we are dealing with an enum or bitflags property.
 
- Public Member Functions inherited from plAbstractEnumerationProperty
 plAbstractEnumerationProperty (const char *szPropertyName)
 Passes the property name through to plAbstractMemberProperty.
 
virtual plInt64 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, plInt64 value) const =0
 Modifies the value of the property. Pass the instance pointer to the surrounding class along.
 
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.
 
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).
 
- 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.
 
plAbstractPropertyAddFlags (plBitflags< plPropertyFlags > flags)
 Adds flags to the property. Returns itself to allow to be called during initialization.
 
plAbstractPropertyAddAttributes (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< plPropertyFlagsm_Flags
 
const char * m_szPropertyName
 
plHybridArray< const plPropertyAttribute *, 2, plStaticsAllocatorWrapperm_Attributes
 

Detailed Description

template<typename EnumType>
class plTypedEnumProperty< EnumType >

[internal] Base class for enum / bitflags properties that already defines the type.

Member Function Documentation

◆ GetSpecificType()

template<typename EnumType >
virtual const plRTTI * plTypedEnumProperty< EnumType >::GetSpecificType ( ) const
inlineoverridevirtual

Returns the actual type of the property. You can then test whether it derives from plEnumBase or plBitflagsBase to determine whether we are dealing with an enum or bitflags property.

Implements plAbstractProperty.


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