ezEngine Release 25.08
Loading...
Searching...
No Matches
ezConstantProperty< Type > Class Template Reference

[internal] An implementation of ezTypedConstantProperty that accesses the property data directly. More...

#include <ConstantProperty.h>

Inheritance diagram for ezConstantProperty< Type >:

Public Member Functions

 ezConstantProperty (const char *szPropertyName, Type value)
 Constructor.
 
virtual void * GetPropertyPointer () const override
 Returns a pointer to the member property.
 
virtual Type GetValue () const override
 Returns the value of the property. Pass the instance pointer to the surrounding class along.
 
virtual ezVariant GetConstant () const override
 Returns the constant value as an ezVariant.
 
- Public Member Functions inherited from ezTypedConstantProperty< Type >
 ezTypedConstantProperty (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.
 
- Public Member Functions inherited from ezAbstractConstantProperty
 ezAbstractConstantProperty (const char *szPropertyName)
 Passes the property name through to ezAbstractProperty.
 
virtual ezPropertyCategory::Enum GetCategory () const override
 Returns ezPropertyCategory::Constant.
 
- 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'.
 
ezArrayPtr< const 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< const ezPropertyAttribute *, 2, ezStaticsAllocatorWrapperm_Attributes
 

Detailed Description

template<typename Type>
class ezConstantProperty< Type >

[internal] An implementation of ezTypedConstantProperty that accesses the property data directly.

Member Function Documentation

◆ GetConstant()

template<typename Type >
virtual ezVariant ezConstantProperty< Type >::GetConstant ( ) const
inlineoverridevirtual

Returns the constant value as an ezVariant.

Implements ezAbstractConstantProperty.

◆ GetPropertyPointer()

template<typename Type >
virtual void * ezConstantProperty< Type >::GetPropertyPointer ( ) const
inlineoverridevirtual

Returns a pointer to the member property.

Implements ezAbstractConstantProperty.

◆ GetValue()

template<typename Type >
virtual Type ezConstantProperty< Type >::GetValue ( ) const
inlineoverridevirtual

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

Implements ezTypedConstantProperty< Type >.


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