Inheritance diagram for MFM::Parameter< CC >:

Public Member Functions
u32	GetType () const

s32	GetMin () const

s32	GetDefault () const

s32	GetMax () const

u32	GetRange () const

u32	MapValue (u32 max, s32 val) const

virtual void	Print (ByteSink &bs)

void	PrintValue (ByteSink &bs, const T &atom)

virtual bool	ReadValue (ByteSource &bs, T &atom)

s32	GetBitsAsS32 (const T &atom) const
	Un-type-checked access treating all bit fields as s32.

void	SetBitsAsS32 (T &atom, const s32 val) const

u64	GetBitsAsU64 (const T &atom) const
	Un-type-checked access treating all bit fields as u64.

void	SetBitsAsU64 (T &atom, const u64 val) const

bool	LoadU32 (const T &atom, u32 &store) const
	Routines to (attempt to) apply this parameter to any given atom. More...

void	StoreU32 (T &atom, const u32 val) const

bool	LoadS32 (const T &atom, s32 &store) const
	s32 value

void	StoreS32 (T &atom, const s32 val) const

bool	LoadBool (const T &atom, bool &store) const
	bool value

void	StoreBool (T &atom, const bool val) const

bool	LoadUnary (const T &atom, u32 &store) const
	unary value

void	StoreUnary (T &atom, const u32 val) const

	Parameter (const VD &vd, const char tag, const char name, const char *description)

const VD &	GetVD () const

const char *	GetTag () const

const char *	GetName () const

const char *	GetDescription () const

Public Member Functions inherited from MFM::ByteSerializable
virtual Result	ReadFrom (ByteSource &byteSource, s32 argument=0)=0

virtual Result	PrintTo (ByteSink &byteSink, s32 argument=0)=0

Additional Inherited Members
Public Types inherited from MFM::ByteSerializable
enum	Result { UNSUPPORTED = -1, FAILURE = 0, SUCCESS = 1 }

Constructor & Destructor Documentation

template<class CC >

Constructs a new parameter with specified parameters.

Parameters

c	The Parameters collection to add this Parameter to.
tag	The permanent Tag for this Parameter . This is used for saving this Parameter to a config file, and therefore must be unique within its category (e.g., the parameters of a single Element ).
name	The permanent Name of this Parameter . This will be displayed when any controls for this Parameter are displayed.
description	A permanent description of this Parameter . At the moment, this is not displayed with this Parameter .

Member Function Documentation

template<class CC>

const char* MFM::Parameter< CC >::GetDescription ( ) const

inline

Gets the permanent Description of this Parameter . At the moment, this is not used.

template<class CC>

const char* MFM::Parameter< CC >::GetName ( ) const

inline

Gets the permanent Name of this Parameter , normally used by a GUI system during rendering of this Parameter .

template<class CC>

const char* MFM::Parameter< CC >::GetTag ( ) const

inline

Gets the permanent Tag of this Parameter , usually used to save this Parameter to some non-volatile IO device.

template<class CC>

inline

Routines to (attempt to) apply this parameter to any given atom.

u32 value

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