Phosphorus::EnumParameter< T > Class Template Reference

Templated enum parameter. Derived from BaseEnumParameter. More...

#include <GameObject.h>

Inheritance diagram for Phosphorus::EnumParameter< T >:

Collaboration diagram for Phosphorus::EnumParameter< T >:

Public Member Functions
	EnumParameter (const String &name, const T &defaultValue)
void	Bind (const T &value, const WideString &text)
	Sets binding for given enum value.
void	SetEnum (const T &value)
	Casts enum to integer and sets it.
T	GetEnum () const
	Casts integer to enum and returns.
Public Member Functions inherited from Phosphorus::BaseEnumParameter
WideString	GetBinding (int32 index) const
	Returns bound name for enum value.
int32	GetBindingCount () const
	Returns binding count.
Public Member Functions inherited from Phosphorus::IParameter< int32 >
	IParameter (const String &name, const int32 &defaultValue)
void	SetValue (const int32 &value)
	Sets value.
int32	GetValue () const
	Returns value.
void	SetDisplayName (const String &name) override
String	GetName () const override
	Returns parameter name.
String	GetDisplayName () const override
	Returns parameter display name.

Additional Inherited Members
Protected Member Functions inherited from Phosphorus::BaseEnumParameter
	BaseEnumParameter (const String &name, int32 defaultValue)
int32	Write (nlohmann::json &target) const override
	Writes text representation of data to JSON object.
int32	Read (nlohmann::json &target) override
	Parses text representation of data from JSON object.
Protected Attributes inherited from Phosphorus::BaseEnumParameter
std::unordered_map< int32, WideString >	m_Bindings
	Enum bindings.
Protected Attributes inherited from Phosphorus::IParameter< int32 >
int32	m_Value
String	m_Name
String	m_DisplayName

Detailed Description

template<typename T>
class Phosphorus::EnumParameter< T >

Templated enum parameter. Derived from BaseEnumParameter.

Template Parameters

T

Enum

Member Function Documentation

Bind()

template<typename T>

void Phosphorus::EnumParameter< T >::Bind ( const T & value, const WideString & text )

inline

Sets binding for given enum value.

Parameters

value	Enum value.
text	Text

SetEnum()

template<typename T>

void Phosphorus::EnumParameter< T >::SetEnum ( const T & value )

inline

Casts enum to integer and sets it.

Parameters

value

---

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

• phosphorus/GameObject.h