HGL::ControlSource::ParameterFactory Class Reference
[Control source plugins]

Factory for creating parameters to hand over to the interpreter. More...

#include <parameterfactory.h>

List of all members.

Public Member Functions
void	clearParamVector (const ControlSource::IControlSource::PARAMVECTOR &pv) const
	Clears the ControlSource::IControlSource::PARAMVECTOR.
Methods to create parameters
HGL::Type::FloatParam *	createNumericParameter (int i) const
	Creates an FloatParam instance.
HGL::Type::Vector2D *	createNumericParameter (float x, float y) const
	Creates an Vector2D instance.
HGL::Type::FloatParam *	createNumericParameter (float f) const
	Creates an FloatParam instance.
HGL::Type::ReferenceParam *	createReferenceParameter (IType *project, const std::string &ref)
	Creates an ReferenceParam instance.
HGL::Type::StringParam *	createStringParameter (const std::string &s) const
	Creates an StringParam instance.

---

Detailed Description

Factory for creating parameters to hand over to the interpreter.

Author:

Heiko Schäfer <heiko@hgl.rangun.de> BSD License

---

Member Function Documentation

void HGL::ControlSource::ParameterFactory::clearParamVector

(

const ControlSource::IControlSource::PARAMVECTOR &

pv

)

const

Clears the ControlSource::IControlSource::PARAMVECTOR.

Parameters:

pv

a ControlSource::IControlSource::PARAMVECTOR

HGL::Type::FloatParam* HGL::ControlSource::ParameterFactory::createNumericParameter

(

int

i

)

const

Creates an FloatParam instance.

Parameters:

i

the integer value, the FloatParam should represent

Returns:

an FloatParam instance

HGL::Type::Vector2D* HGL::ControlSource::ParameterFactory::createNumericParameter	(	float	x,
		float	y
	)			const

Creates an Vector2D instance.

Parameters:

	x	the x-value, the Vector2DParam should represent
	y	the y-vale, the Vector2DParam should represent

Returns:

an Vector2D instance

HGL::Type::FloatParam* HGL::ControlSource::ParameterFactory::createNumericParameter

(

float

f

)

const

Creates an FloatParam instance.

Parameters:

f

the float value, the FloatParam should represent

Returns:

an FloatParam instance

HGL::Type::ReferenceParam* HGL::ControlSource::ParameterFactory::createReferenceParameter	(	IType *	project,
		const std::string &	ref
	)

Creates an ReferenceParam instance.

Parameters:

	project	TODO
	ref	the reference, the ReferenceParam should represent

Returns:

an ReferenceParam instance

HGL::Type::StringParam* HGL::ControlSource::ParameterFactory::createStringParameter

(

const std::string &

s

)

const

Creates an StringParam instance.

Parameters:

s

the string, the StringParam should represent

Returns:

an StringParam instance