Options /

#include “cinder/params/Params.h”

Class Hierarchy:

cinder::params::InterfaceGl::OptionsBase
cinder::params::InterfaceGl::Options

Provides chainable options, returned from addParam() .

Public Member Functions

Options (const std::string &name, T *target, int type, InterfaceGl *parent)
Options &

min (float minVal)

Sets the maximum value for the associated target param.
Options &

max (float maxVal)

Sets the minimum value for the associated target param.
Options &

step (float stepVal)

Sets step increment for the associated target param.
Options &

precision (int precVal)

Sets the number of significant digits for floating point variables (float or double type only).
Options &

keyIncr (const std::string &keyIncr)

Sets an increment shortcut key.
Options &

keyDecr (const std::string &keyDecr)

Sets a decrement shortcut key.
Options &

key (const std::string &key)

Sets a shortcut key for param types that cannot be incremented / decremented (ex. bool)
Options &

label (const std::string &label)

Sets the param label. A parameter name must be unique, but you can override it with a 'label', which does not have to be unique.
Options &

group (const std::string &group)

Sets the param group.
Options &

optionsStr (const std::string &optionsStr)

Sets other implementation defined options via string.
Options &

accessors (const SetterFn &setterFn, const GetterFn &getterFn)

! Sets setterFn and getterFn as callbacks for this param. the target is ignored in this case.
Options &

updateFn (const UpdateFn &updateFn)

! Sets an update function that will be called after the target param is updated.
Options &

visible (bool visible=true)

Shows or hides this param.
const std::string &

getName () const
void *

getVoidPtr () const
const std::string &

getKeyIncr () const
const std::string &

getKeyDecr () const
void

setVisible (bool visible=true)

Protected Member Functions

void

setMin (float minVal)
void

setMax (float maxVal)
void

setStep (float maxVal)
void

setPrecision (int precVal)
void

setKeyIncr (const std::string &keyIncr)
void

setKeyDecr (const std::string &keyDecr)
void

setKey (const std::string &key)
void

setLabel (const std::string &label)
void

setGroup (const std::string &group)
void

setOptionsStr (const std::string &optionsStr)
void

reAddOptions ()

Protected Attributes

std::string

mName
std::string

mKeyIncr
std::string

mKeyDecr
std::string

mKey
std::string

mLabel
std::string

mGroup
std::string

mOptionsStr
void *

mVoidPtr
float

mMin
float

mMax
float

mStep
int

mPrecision
bool

mMinSet
bool

mMaxSet
bool

mStepSet
bool

mPrecisionSet
InterfaceGl *

mParent

Friends

friend class

InterfaceGl

Namespaces

Classes

Modules

Guides

Reference

Options /

Public Member Functions

Protected Member Functions

Protected Attributes

Friends