Namespaces

InterfaceGl /

#include “cinder/params/Params.h”

Typedefs:

InterfaceGlRef

Classes:

Options
OptionsBase

Interface for adding params to your window. Wraps AntTweakBar.

Public Member Functions

InterfaceGl ()

Deprecated
{ use create() }
InterfaceGl (const std::string &title, const ivec2 &size, const ColorA &color=ColorA(0.3f, 0.3f, 0.3f, 0.4f))

Deprecated
{ use create() }
InterfaceGl (const cinder::app::WindowRef &window, const std::string &title, const ivec2 &size, const ColorA &color=ColorA(0.3f, 0.3f, 0.3f, 0.4f))

Deprecated
{ use create() }
void

draw ()

Draw the interface.
void

show (bool visible=true)

Shows the interface. If visible is false , hides the interface.
void

hide ()

Hides the interface.
bool

isVisible () const

Returns whether the interface is visible or not.

See Also

show() , hide() .
void

maximize (bool maximized=true)

Maximizes the interface, making it visible in its default presentation mode. If maximized is false , minimizes the interface.

See Also

minimize()
void

minimize ()

Minimizes the interface face to the bottom left corner of the window.
bool

isMaximized () const

Returns whether the interface is maximized or not.

See Also

maximize() , minimize()
ivec2

getPosition () const

Gets the position of this interface instance.
void

setPosition (const ci::ivec2 &pos)

Sets the position of this interface instance.
int

getWidth () const

Gets the width of this interface instance.
int

getHeight () const

Gets the height of this interface instance.
ivec2

getSize () const

Gets the size of this interface instance.
void

setSize (const ci::ivec2 &size)

Sets the size of this interface instance.
Options< T >

addParam (const std::string &name, T *target, bool readOnly=false)

Adds target as a param to the interface, referring to it with name .

Options<T> for chaining options to the param.
Options< T >

addParam (const std::string &name, const std::function< void(T)> &setterFn, const std::function< T()> &getterFn)

Adds a param to the interface with no target, but is instead accessed with setterFn and getterFn .

Options<T> for chaining options to the param.
Options< int >

addParam (const std::string &name, const std::vector< std::string > &enumNames, int *param, bool readOnly=false)

Adds enumerated parameter. The value corresponds to the indices of enumNames .
Options< int >

addParam (const std::string &name, const std::vector< std::string > &enumNames, const std::function< void(int)> &setterFn, const std::function< int()> &getterFn)

Adds an enumerated param to the interface with no target, but is instead accessed with setterFn and getterFn . The input parameter of setterFn and the return value of getterFn correspond to the indices of enumNames .

Options<T> for chaining options to the param.
void

addSeparator (const std::string &name="", const std::string &optionsStr="")

Adds a separator to the interface.
void

addText (const std::string &name="", const std::string &optionsStr="")

Adds text to the interface.
void

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

Adds a button that fires callback when clicked.
void

removeParam (const std::string &name)

Removes the param referred to by name .
void

setOptions (const std::string &name="", const std::string &optionsStr="")

Sets runtime options on the param referred to by name .
void

clear ()

Removes all the variables, buttons and separators previously added.
void

addParam (const std::string &name, bool *boolParam, const std::string &optionsStr, bool readOnly=false)

Deprecated
use addParam<T>() instead.
void

addParam (const std::string &name, bool *boolParam, const char *optionsStr, bool readOnly=false)

Deprecated
use addParam<T>() instead.
void

addParam (const std::string &name, float *floatParam, const std::string &optionsStr, bool readOnly=false)

Deprecated
use addParam<T>() instead.
void

addParam (const std::string &name, float *floatParam, const char *optionsStr, bool readOnly=false)

Deprecated
use addParam<T>() instead.
void

addParam (const std::string &name, double *doubleParam, const std::string &optionsStr, bool readOnly=false)

Deprecated
use addParam<T>() instead.
void

addParam (const std::string &name, double *doubleParam, const char *optionsStr, bool readOnly=false)

Deprecated
use addParam<T>() instead.
void

addParam (const std::string &name, int32_t *intParam, const std::string &optionsStr, bool readOnly=false)

Deprecated
use addParam<T>() instead.
void

addParam (const std::string &name, int32_t *intParam, const char *optionsStr, bool readOnly=false)

Deprecated
use addParam<T>() instead.
void

addParam (const std::string &name, vec3 *vectorParam, const std::string &optionsStr, bool readOnly=false)

Deprecated
use addParam<T>() instead.
void

addParam (const std::string &name, vec3 *vectorParam, const char *optionsStr, bool readOnly=false)

Deprecated
use addParam<T>() instead.
void

addParam (const std::string &name, quat *quatParam, const std::string &optionsStr, bool readOnly=false)

Deprecated
use addParam<T>() instead.
void

addParam (const std::string &name, quat *quatParam, const char *optionsStr, bool readOnly=false)

Deprecated
use addParam<T>() instead.
void

addParam (const std::string &name, Color *colorParam, const std::string &optionsStr, bool readOnly=false)

Deprecated
use addParam<T>() instead.
void

addParam (const std::string &name, Color *colorParam, const char *optionsStr, bool readOnly=false)

Deprecated
use addParam<T>() instead.
void

addParam (const std::string &name, ColorA *colorParam, const std::string &optionsStr, bool readOnly=false)

Deprecated
use addParam<T>() instead.
void

addParam (const std::string &name, ColorA *colorParam, const char *optionsStr, bool readOnly=false)

Deprecated
use addParam<T>() instead.
void

addParam (const std::string &name, std::string *strParam, const std::string &optionsStr, bool readOnly=false)

Deprecated
use addParam<T>() instead.
void

addParam (const std::string &name, std::string *strParam, const char *optionsStr, bool readOnly=false)

Deprecated
use addParam<T>() instead.
void

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

Deprecated
use addParam() variant that returns Options<int> instead.
void

addParam (const std::string &name, const std::vector< std::string > &enumNames, int *param, const char *optionsStr, bool readOnly=false)

Deprecated
use addParam() variant that returns Options<int> instead.
void

addParamCallbackImpl (const function< void(T)> &setter, const function< T()> &getter, const Options< T > &options)
CI_API InterfaceGl::Options< bool >

addParam (const std::string &name, bool *param, bool readOnly)
CI_API InterfaceGl::Options< char >

addParam (const std::string &name, char *param, bool readOnly)
CI_API InterfaceGl::Options< int8_t >

addParam (const std::string &name, int8_t *param, bool readOnly)
CI_API InterfaceGl::Options< uint8_t >

addParam (const std::string &name, uint8_t *param, bool readOnly)
CI_API InterfaceGl::Options< int16_t >

addParam (const std::string &name, int16_t *param, bool readOnly)
CI_API InterfaceGl::Options< uint16_t >

addParam (const std::string &name, uint16_t *param, bool readOnly)
CI_API InterfaceGl::Options< int32_t >

addParam (const std::string &name, int32_t *param, bool readOnly)
CI_API InterfaceGl::Options< uint32_t >

addParam (const std::string &name, uint32_t *param, bool readOnly)
CI_API InterfaceGl::Options< float >

addParam (const std::string &name, float *param, bool readOnly)
CI_API InterfaceGl::Options< double >

addParam (const std::string &name, double *param, bool readOnly)
CI_API InterfaceGl::Options< string >

addParam (const std::string &name, string *param, bool readOnly)
CI_API InterfaceGl::Options< Color >

addParam (const std::string &name, Color *param, bool readOnly)
CI_API InterfaceGl::Options< ColorA >

addParam (const std::string &name, ColorA *param, bool readOnly)
CI_API InterfaceGl::Options< quat >

addParam (const std::string &name, quat *param, bool readOnly)
CI_API InterfaceGl::Options< dquat >

addParam (const std::string &name, dquat *param, bool readOnly)
CI_API InterfaceGl::Options< vec3 >

addParam (const std::string &name, vec3 *param, bool readOnly)
CI_API InterfaceGl::Options< dvec3 >

addParam (const std::string &name, dvec3 *param, bool readOnly)

Static Public Member Functions

InterfaceGlRef

create (const std::string &title, const ivec2 &size, const ColorA &color=ColorA(0.3f, 0.3f, 0.3f, 0.4f))

Creates and returns an InterfaceGl referenced by title and with size dimensions. Optionally takes color .
InterfaceGlRef

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

Creates and returns an InterfaceGl referenced by title that belongs to window , and with size dimensions. Optionally takes color .

Protected Member Functions

void

init (app::WindowRef window, const std::string &title, const ivec2 &size, const ColorA color)
void

implAddParamDeprecated (const std::string &name, void *param, int type, const std::string &optionsStr, bool readOnly)
Options< T >

addParamImpl (const std::string &name, T *param, int type, bool readOnly)
void

addParamCallbackImpl (const std::function< void(T)> &setter, const std::function< T()> &getter, const Options< T > &options)

Protected Attributes

std::weak_ptr< app::Window >

mWindow
std::shared_ptr< TwBar >

mBar
int

mTwWindowId
std::map< std::string, std::shared_ptr< void > >

mStoredCallbacks

Namespaces

Classes

Modules

Guides

Reference

InterfaceGl /

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes