Detailed Description

The color parameter class.

The color processing uses the Util::StringToColor() syntax.

Inheritance diagram for Murl::Util::Environment::ColorParameter:

Public Member Functions
	ColorParameter (ParameterType type, const String &longId, const String &shortId, const String &description, const Color &defaultValue=Color(0.0f))
	The constructor taking an optional default value,. More...

SInt32	Process (SInt32 currentIndex, SInt32 argC, const char **argV) override
	Overload of Parameter::Process() converting the mValue. More...

Public Member Functions inherited from Murl::Util::Environment::Parameter
	Parameter (ParameterType type, const String &longId, const String &shortId, const String &description, SInt32 skip, Bool isArray)
	The constructor. More...

virtual	~Parameter ()
	The destructor.

Public Attributes
Color	mValue
	The processed argument value.

Public Attributes inherited from Murl::Util::Environment::Parameter
ParameterType	mType
	The parameter type.

String	mLongId
	The long parameter identifier string.

String	mShortId
	The short parameter identifier string.

String	mDescription
	The parameter description string.

Bool	mIsSet
	Flag if the parameter is set.

SInt32	mSkip
	The number of arguments used by the parameter.

Bool	mIsArray
	Signature for parameter arrays.

Additional Inherited Members
Public Types inherited from Murl::Util::Environment::Parameter
using	AutoPtr = AutoPointer< Parameter >
	Definition of the parameter auto pointer.

Constructor & Destructor Documentation

Murl::Util::Environment::ColorParameter::ColorParameter	(	ParameterType	type,
		const String &	longId,
		const String &	shortId,
		const String &	description,
		const Color &	defaultValue = `Color(0.0f)`
	)

The constructor taking an optional default value,.

Parameters

type	The type of the parameter.
longId	The long parameter identifier string.
shortId	The short parameter identifier string.
description	The parameter description string.
defaultValue	The default value.

SInt32 Murl::Util::Environment::ColorParameter::Process	(	SInt32	currentIndex,
		SInt32	argC,
		const char **	argV
	)

overridevirtual

Overload of Parameter::Process() converting the mValue.

Parameters

currentIndex	The zero-based index to the current argument.
argC	The number of arguments.
argV	The argument string values.

Returns: The number of arguments processed or -1 if parsing the argument failed.

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