cinder::params::InterfaceGl Class Reference

#include <Params.h>

List of all members.

Public Member Functions
	InterfaceGl ()
	InterfaceGl (const std::string &title, const Vec2i &size, const ColorA &color=ColorA(0.3f, 0.3f, 0.3f, 0.4f))
	InterfaceGl (cinder::app::WindowRef window, const std::string &title, const Vec2i &size, const ColorA &color=ColorA(0.3f, 0.3f, 0.3f, 0.4f))
void	draw ()
void	show (bool visible=true)
void	hide ()
bool	isVisible () const
void	maximize (bool maximized=true)
void	minimize ()
bool	isMaximized () const
void	addParam (const std::string &name, bool *boolParam, const std::string &optionsStr="", bool readOnly=false)
void	addParam (const std::string &name, float *floatParam, const std::string &optionsStr="", bool readOnly=false)
void	addParam (const std::string &name, double *doubleParam, const std::string &optionsStr="", bool readOnly=false)
void	addParam (const std::string &name, int32_t *intParam, const std::string &optionsStr="", bool readOnly=false)
void	addParam (const std::string &name, Vec3f *vectorParam, const std::string &optionsStr="", bool readOnly=false)
void	addParam (const std::string &name, Quatf *quatParam, const std::string &optionsStr="", bool readOnly=false)
void	addParam (const std::string &name, Color *quatParam, const std::string &optionsStr="", bool readOnly=false)
void	addParam (const std::string &name, ColorA *quatParam, const std::string &optionsStr="", bool readOnly=false)
void	addParam (const std::string &name, std::string *strParam, const std::string &optionsStr="", bool readOnly=false)
void	addParam (const std::string &name, const std::vector< std::string > &enumNames, int *param, const std::string &optionsStr="", bool readOnly=false)
	Adds enumerated parameter. The value corresponds to the indices of enumNames.
void	addSeparator (const std::string &name="", const std::string &optionsStr="")
void	addText (const std::string &name="", const std::string &optionsStr="")
void	addButton (const std::string &name, const std::function< void()> &callback, const std::string &optionsStr="")
void	removeParam (const std::string &name)
void	clear ()
	Removes all the variables, buttons and separators previously added.
void	setOptions (const std::string &name="", const std::string &optionsStr="")
Static Public Member Functions
static InterfaceGlRef	create (const std::string &title, const Vec2i &size, const ColorA &color=ColorA(0.3f, 0.3f, 0.3f, 0.4f))
static InterfaceGlRef	create (cinder::app::WindowRef window, const std::string &title, const Vec2i &size, const ColorA &color=ColorA(0.3f, 0.3f, 0.3f, 0.4f))
Protected Member Functions
void	init (app::WindowRef window, const std::string &title, const Vec2i &size, const ColorA color)
void	implAddParam (const std::string &name, void *param, int type, const std::string &optionsStr, bool readOnly)
Protected Attributes
std::weak_ptr< app::Window >	mWindow
std::shared_ptr< TwBar >	mBar
int	mTwWindowId
std::vector< std::shared_ptr < std::function< void()> > >	mButtonCallbacks

---

Constructor & Destructor Documentation

cinder::params::InterfaceGl::InterfaceGl

(

)

cinder::params::InterfaceGl::InterfaceGl	(	const std::string &	title,
		const Vec2i &	size,
		const ColorA &	color = ColorA( 0.3f, 0.3f, 0.3f, 0.4f )
	)

cinder::params::InterfaceGl::InterfaceGl	(	cinder::app::WindowRef	window,
		const std::string &	title,
		const Vec2i &	size,
		const ColorA &	color = ColorA( 0.3f, 0.3f, 0.3f, 0.4f )
	)

---

Member Function Documentation

InterfaceGlRef cinder::params::InterfaceGl::create	(	const std::string &	title,
		const Vec2i &	size,
		const ColorA &	color = ColorA( 0.3f, 0.3f, 0.3f, 0.4f )
	)		[static]

InterfaceGlRef cinder::params::InterfaceGl::create	(	cinder::app::WindowRef	window,
		const std::string &	title,
		const Vec2i &	size,
		const ColorA &	color = ColorA( 0.3f, 0.3f, 0.3f, 0.4f )
	)		[static]

void cinder::params::InterfaceGl::draw

(

)

void cinder::params::InterfaceGl::show

(

bool

visible = true

)

void cinder::params::InterfaceGl::hide

(

)

bool cinder::params::InterfaceGl::isVisible

(

)

const

void cinder::params::InterfaceGl::maximize

(

bool

maximized = true

)

void cinder::params::InterfaceGl::minimize

(

)

bool cinder::params::InterfaceGl::isMaximized

(

)

const

void cinder::params::InterfaceGl::addParam	(	const std::string &	name,
		bool *	boolParam,
		const std::string &	optionsStr = "",
		bool	readOnly = false
	)

void cinder::params::InterfaceGl::addParam	(	const std::string &	name,
		float *	floatParam,
		const std::string &	optionsStr = "",
		bool	readOnly = false
	)

void cinder::params::InterfaceGl::addParam	(	const std::string &	name,
		double *	doubleParam,
		const std::string &	optionsStr = "",
		bool	readOnly = false
	)

void cinder::params::InterfaceGl::addParam	(	const std::string &	name,
		int32_t *	intParam,
		const std::string &	optionsStr = "",
		bool	readOnly = false
	)

void cinder::params::InterfaceGl::addParam	(	const std::string &	name,
		Vec3f *	vectorParam,
		const std::string &	optionsStr = "",
		bool	readOnly = false
	)

void cinder::params::InterfaceGl::addParam	(	const std::string &	name,
		Quatf *	quatParam,
		const std::string &	optionsStr = "",
		bool	readOnly = false
	)

void cinder::params::InterfaceGl::addParam	(	const std::string &	name,
		Color *	quatParam,
		const std::string &	optionsStr = "",
		bool	readOnly = false
	)

void cinder::params::InterfaceGl::addParam	(	const std::string &	name,
		ColorA *	quatParam,
		const std::string &	optionsStr = "",
		bool	readOnly = false
	)

void cinder::params::InterfaceGl::addParam	(	const std::string &	name,
		std::string *	strParam,
		const std::string &	optionsStr = "",
		bool	readOnly = false
	)

void cinder::params::InterfaceGl::addParam	(	const std::string &	name,
		const std::vector< std::string > &	enumNames,
		int *	param,
		const std::string &	optionsStr = "",
		bool	readOnly = false
	)

Adds enumerated parameter. The value corresponds to the indices of enumNames.

void cinder::params::InterfaceGl::addSeparator	(	const std::string &	name = "",
		const std::string &	optionsStr = ""
	)

void cinder::params::InterfaceGl::addText	(	const std::string &	name = "",
		const std::string &	optionsStr = ""
	)

void cinder::params::InterfaceGl::addButton	(	const std::string &	name,
		const std::function< void()> &	callback,
		const std::string &	optionsStr = ""
	)

void cinder::params::InterfaceGl::removeParam

(

const std::string &

name

)

void cinder::params::InterfaceGl::clear

(

)

Removes all the variables, buttons and separators previously added.

void cinder::params::InterfaceGl::setOptions	(	const std::string &	name = "",
		const std::string &	optionsStr = ""
	)

void cinder::params::InterfaceGl::init	(	app::WindowRef	window,
		const std::string &	title,
		const Vec2i &	size,
		const ColorA	color
	)		[protected]

void cinder::params::InterfaceGl::implAddParam	(	const std::string &	name,
		void *	param,
		int	type,
		const std::string &	optionsStr,
		bool	readOnly
	)		[protected]

---

Member Data Documentation

std::weak_ptr<app::Window> cinder::params::InterfaceGl::mWindow [protected]

std::shared_ptr<TwBar> cinder::params::InterfaceGl::mBar [protected]

int cinder::params::InterfaceGl::mTwWindowId [protected]

std::vector<std::shared_ptr<std::function<void()> > > cinder::params::InterfaceGl::mButtonCallbacks [protected]

---

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

• include/cinder/params/Params.h
• src/cinder/params/Params.cpp