reference

This documentation is automatically generated from the openFrameworks source code using doxygen and refers to the most recent release, version 0.12.0.

#include <ofParameter.h>

Inheritance diagram for ofParameterGroup:
ofAbstractParameter

Public Member Functions

 ofParameterGroup ()
 
template<typename ... Args>
 ofParameterGroup (const std::string &name)
 
template<typename ... Args>
 ofParameterGroup (const std::string &name, Args &... p)
 
template<typename ... Args>
void add (ofAbstractParameter &p, Args &... parameters)
 
void add (ofAbstractParameter &param)
 
std::string valueType () const
 
void remove (ofAbstractParameter &param)
 
void remove (std::size_t index)
 
void remove (const std::string &name)
 
void clear ()
 
const ofParameter< void > & getVoid (const std::string &name) const
 
const ofParameter< bool > & getBool (const std::string &name) const
 
const ofParameter< int > & getInt (const std::string &name) const
 
const ofParameter< float > & getFloat (const std::string &name) const
 
const ofParameter< char > & getChar (const std::string &name) const
 
const ofParameter< std::string > & getString (const std::string &name) const
 
const ofParameter< ofPoint > & getPoint (const std::string &name) const
 
const ofParameter< ofDefaultVec2 > & getVec2f (const std::string &name) const
 
const ofParameter< ofDefaultVec3 > & getVec3f (const std::string &name) const
 
const ofParameter< ofDefaultVec4 > & getVec4f (const std::string &name) const
 
const ofParameter< ofColor > & getColor (const std::string &name) const
 
const ofParameter< ofShortColor > & getShortColor (const std::string &name) const
 
const ofParameter< ofFloatColor > & getFloatColor (const std::string &name) const
 
const ofParameter< ofRectangle > & getRectangle (const std::string &name) const
 
const ofParameterGroupgetGroup (const std::string &name) const
 
const ofParameter< void > & getVoid (std::size_t pos) const
 
const ofParameter< bool > & getBool (std::size_t pos) const
 
const ofParameter< int > & getInt (std::size_t pos) const
 
const ofParameter< float > & getFloat (std::size_t pos) const
 
const ofParameter< char > & getChar (std::size_t pos) const
 
const ofParameter< std::string > & getString (std::size_t pos) const
 
const ofParameter< ofPoint > & getPoint (std::size_t pos) const
 
const ofParameter< ofDefaultVec2 > & getVec2f (std::size_t pos) const
 
const ofParameter< ofDefaultVec3 > & getVec3f (std::size_t pos) const
 
const ofParameter< ofDefaultVec4 > & getVec4f (std::size_t pos) const
 
const ofParameter< ofColor > & getColor (std::size_t pose) const
 
const ofParameter< ofShortColor > & getShortColor (std::size_t pos) const
 
const ofParameter< ofFloatColor > & getFloatColor (std::size_t pos) const
 
const ofParameter< ofRectangle > & getRectangle (std::size_t pos) const
 
const ofParameterGroupgetGroup (std::size_t pos) const
 
ofParameter< void > & getVoid (const std::string &name)
 
ofParameter< bool > & getBool (const std::string &name)
 
ofParameter< int > & getInt (const std::string &name)
 
ofParameter< float > & getFloat (const std::string &name)
 
ofParameter< char > & getChar (const std::string &name)
 
ofParameter< std::string > & getString (const std::string &name)
 
ofParameter< ofPoint > & getPoint (const std::string &name)
 
ofParameter< ofDefaultVec2 > & getVec2f (const std::string &name)
 
ofParameter< ofDefaultVec3 > & getVec3f (const std::string &name)
 
ofParameter< ofDefaultVec4 > & getVec4f (const std::string &name)
 
ofParameter< ofColor > & getColor (const std::string &name)
 
ofParameter< ofShortColor > & getShortColor (const std::string &name)
 
ofParameter< ofFloatColor > & getFloatColor (const std::string &name)
 
ofParameter< ofRectangle > & getRectangle (const std::string &name)
 
ofParameterGroupgetGroup (const std::string &name)
 
ofParameter< void > & getVoid (std::size_t pos)
 
ofParameter< bool > & getBool (std::size_t pos)
 
ofParameter< int > & getInt (std::size_t pos)
 
ofParameter< float > & getFloat (std::size_t pos)
 
ofParameter< char > & getChar (std::size_t pos)
 
ofParameter< std::string > & getString (std::size_t pos)
 
ofParameter< ofPoint > & getPoint (std::size_t pos)
 
ofParameter< ofDefaultVec2 > & getVec2f (std::size_t pos)
 
ofParameter< ofDefaultVec3 > & getVec3f (std::size_t pos)
 
ofParameter< ofDefaultVec4 > & getVec4f (std::size_t pos)
 
ofParameter< ofColor > & getColor (std::size_t pose)
 
ofParameter< ofShortColor > & getShortColor (std::size_t pos)
 
ofParameter< ofFloatColor > & getFloatColor (std::size_t pos)
 
ofParameter< ofRectangle > & getRectangle (std::size_t pos)
 
ofParameterGroupgetGroup (std::size_t pos)
 
const ofAbstractParameterget (const std::string &name) const
 
const ofAbstractParameterget (std::size_t pos) const
 
const ofAbstractParameteroperator[] (const std::string &name) const
 
const ofAbstractParameteroperator[] (std::size_t pos) const
 
ofAbstractParameterget (const std::string &name)
 
ofAbstractParameterget (std::size_t pos)
 
ofAbstractParameteroperator[] (const std::string &name)
 
ofAbstractParameteroperator[] (std::size_t pos)
 
template<typename ParameterType >
const ofParameter< ParameterType > & get (const std::string &name) const
 
template<typename ParameterType >
const ofParameter< ParameterType > & get (std::size_t pos) const
 
template<typename ParameterType >
ofParameter< ParameterType > & get (const std::string &name)
 
template<typename ParameterType >
ofParameter< ParameterType > & get (std::size_t pos)
 
template<typename ParameterType , typename Friend >
const ofReadOnlyParameter< ParameterType, Friend > & getReadOnly (const std::string &name) const
 
template<typename ParameterType , typename Friend >
const ofReadOnlyParameter< ParameterType, Friend > & getReadOnly (std::size_t pos) const
 
template<typename ParameterType , typename Friend >
ofReadOnlyParameter< ParameterType, Friend > & getReadOnly (const std::string &name)
 
template<typename ParameterType , typename Friend >
ofReadOnlyParameter< ParameterType, Friend > & getReadOnly (std::size_t pos)
 
std::size_t size () const
 
std::string getName (std::size_t position) const
 
std::string getType (std::size_t position) const
 
bool getIsReadOnly (int position) const
 
int getPosition (const std::string &name) const
 
std::string getName () const
 
void setName (const std::string &name)
 
std::string getEscapedName () const
 
std::string toString () const
 
void fromString (const std::string &name)
 
bool contains (const std::string &name) const
 
ofAbstractParameterback ()
 
ofAbstractParameterfront ()
 
const ofAbstractParameterback () const
 
const ofAbstractParameterfront () const
 
void setSerializable (bool serializable)
 
bool isSerializable () const
 
bool isReadOnly () const
 
std::shared_ptr< ofAbstractParameternewReference () const
 
void setParent (ofParameterGroup &parent)
 
 operator bool () const
 
ofEvent< ofAbstractParameter > & parameterChangedE ()
 
std::vector< std::shared_ptr< ofAbstractParameter > >::iterator begin ()
 
std::vector< std::shared_ptr< ofAbstractParameter > >::iterator end ()
 
std::vector< std::shared_ptr< ofAbstractParameter > >::const_iterator begin () const
 
std::vector< std::shared_ptr< ofAbstractParameter > >::const_iterator end () const
 
std::vector< std::shared_ptr< ofAbstractParameter > >::reverse_iterator rbegin ()
 
std::vector< std::shared_ptr< ofAbstractParameter > >::reverse_iterator rend ()
 
std::vector< std::shared_ptr< ofAbstractParameter > >::const_reverse_iterator rbegin () const
 
std::vector< std::shared_ptr< ofAbstractParameter > >::const_reverse_iterator rend () const
 
- Public Member Functions inherited from ofAbstractParameter
virtual ~ofAbstractParameter ()
 
virtual std::string type () const
 
std::vector< std::string > getGroupHierarchyNames () const
 
template<typename ParameterType >
ofParameter< ParameterType > & cast ()
 
template<typename ParameterType >
const ofParameter< ParameterType > & cast () const
 
template<typename ParameterType , typename Friend >
ofReadOnlyParameter< ParameterType, Friend > & castReadOnly ()
 
template<typename ParameterType , typename Friend >
const ofReadOnlyParameter< ParameterType, Friend > & castReadOnly () const
 
ofParameterGroupcastGroup ()
 
const ofParameterGroupcastGroup () const
 
virtual bool isReferenceTo (const ofAbstractParameter &other) const
 

Protected Member Functions

const void * getInternalObject () const
 
- Protected Member Functions inherited from ofAbstractParameter
virtual std::string escape (const std::string &str) const
 

Friends

template<typename T >
class ofParameter
 
template<typename T , typename F >
class ofReadOnlyParameter
 
std::ostream & operator<< (std::ostream &os, const ofParameterGroup &group)
 

Detailed Description

A collection of parameters with events to notify if a parameter changed and serialization facilities

Constructor & Destructor Documentation

◆ ofParameterGroup() [1/3]

ofParameterGroup::ofParameterGroup ( )

◆ ofParameterGroup() [2/3]

template<typename ... Args>
ofParameterGroup::ofParameterGroup ( const std::string &  name)
inline

◆ ofParameterGroup() [3/3]

template<typename ... Args>
ofParameterGroup::ofParameterGroup ( const std::string &  name,
Args &...  p 
)
inline

Member Function Documentation

◆ add() [1/2]

template<typename ... Args>
void ofParameterGroup::add ( ofAbstractParameter p,
Args &...  parameters 
)
inline

◆ add() [2/2]

void ofParameterGroup::add ( ofAbstractParameter param)

◆ back() [1/2]

ofAbstractParameter & ofParameterGroup::back ( )

◆ back() [2/2]

const ofAbstractParameter & ofParameterGroup::back ( ) const

◆ begin() [1/2]

vector< shared_ptr< ofAbstractParameter > >::iterator ofParameterGroup::begin ( )

◆ begin() [2/2]

vector< shared_ptr< ofAbstractParameter > >::const_iterator ofParameterGroup::begin ( ) const

◆ clear()

void ofParameterGroup::clear ( )

◆ contains()

bool ofParameterGroup::contains ( const std::string &  name) const

◆ end() [1/2]

vector< shared_ptr< ofAbstractParameter > >::iterator ofParameterGroup::end ( )

◆ end() [2/2]

vector< shared_ptr< ofAbstractParameter > >::const_iterator ofParameterGroup::end ( ) const

◆ fromString()

void ofParameterGroup::fromString ( const std::string &  name)
virtual

Implements ofAbstractParameter.

◆ front() [1/2]

ofAbstractParameter & ofParameterGroup::front ( )

◆ front() [2/2]

const ofAbstractParameter & ofParameterGroup::front ( ) const

◆ get() [1/8]

ofAbstractParameter & ofParameterGroup::get ( const std::string &  name)

◆ get() [2/8]

template<typename ParameterType >
ofParameter< ParameterType > & ofParameterGroup::get ( const std::string &  name)

◆ get() [3/8]

const ofAbstractParameter & ofParameterGroup::get ( const std::string &  name) const

◆ get() [4/8]

template<typename ParameterType >
const ofParameter< ParameterType > & ofParameterGroup::get ( const std::string &  name) const

◆ get() [5/8]

ofAbstractParameter & ofParameterGroup::get ( std::size_t  pos)

◆ get() [6/8]

template<typename ParameterType >
ofParameter< ParameterType > & ofParameterGroup::get ( std::size_t  pos)

◆ get() [7/8]

const ofAbstractParameter & ofParameterGroup::get ( std::size_t  pos) const

◆ get() [8/8]

template<typename ParameterType >
const ofParameter< ParameterType > & ofParameterGroup::get ( std::size_t  pos) const

◆ getBool() [1/4]

ofParameter< bool > & ofParameterGroup::getBool ( const std::string &  name)

◆ getBool() [2/4]

const ofParameter< bool > & ofParameterGroup::getBool ( const std::string &  name) const

◆ getBool() [3/4]

ofParameter< bool > & ofParameterGroup::getBool ( std::size_t  pos)

◆ getBool() [4/4]

const ofParameter< bool > & ofParameterGroup::getBool ( std::size_t  pos) const

◆ getChar() [1/4]

ofParameter< char > & ofParameterGroup::getChar ( const std::string &  name)

◆ getChar() [2/4]

const ofParameter< char > & ofParameterGroup::getChar ( const std::string &  name) const

◆ getChar() [3/4]

ofParameter< char > & ofParameterGroup::getChar ( std::size_t  pos)

◆ getChar() [4/4]

const ofParameter< char > & ofParameterGroup::getChar ( std::size_t  pos) const

◆ getColor() [1/4]

ofParameter< ofColor > & ofParameterGroup::getColor ( const std::string &  name)

◆ getColor() [2/4]

const ofParameter< ofColor > & ofParameterGroup::getColor ( const std::string &  name) const

◆ getColor() [3/4]

ofParameter< ofColor > & ofParameterGroup::getColor ( std::size_t  pose)

◆ getColor() [4/4]

const ofParameter< ofColor > & ofParameterGroup::getColor ( std::size_t  pose) const

◆ getEscapedName()

string ofParameterGroup::getEscapedName ( ) const
virtual

Reimplemented from ofAbstractParameter.

◆ getFloat() [1/4]

ofParameter< float > & ofParameterGroup::getFloat ( const std::string &  name)

◆ getFloat() [2/4]

const ofParameter< float > & ofParameterGroup::getFloat ( const std::string &  name) const

◆ getFloat() [3/4]

ofParameter< float > & ofParameterGroup::getFloat ( std::size_t  pos)

◆ getFloat() [4/4]

const ofParameter< float > & ofParameterGroup::getFloat ( std::size_t  pos) const

◆ getFloatColor() [1/4]

ofParameter< ofFloatColor > & ofParameterGroup::getFloatColor ( const std::string &  name)

◆ getFloatColor() [2/4]

const ofParameter< ofFloatColor > & ofParameterGroup::getFloatColor ( const std::string &  name) const

◆ getFloatColor() [3/4]

ofParameter< ofFloatColor > & ofParameterGroup::getFloatColor ( std::size_t  pos)

◆ getFloatColor() [4/4]

const ofParameter< ofFloatColor > & ofParameterGroup::getFloatColor ( std::size_t  pos) const

◆ getGroup() [1/4]

ofParameterGroup & ofParameterGroup::getGroup ( const std::string &  name)

◆ getGroup() [2/4]

const ofParameterGroup & ofParameterGroup::getGroup ( const std::string &  name) const

◆ getGroup() [3/4]

ofParameterGroup & ofParameterGroup::getGroup ( std::size_t  pos)

◆ getGroup() [4/4]

const ofParameterGroup & ofParameterGroup::getGroup ( std::size_t  pos) const

◆ getInt() [1/4]

ofParameter< int > & ofParameterGroup::getInt ( const std::string &  name)

◆ getInt() [2/4]

const ofParameter< int > & ofParameterGroup::getInt ( const std::string &  name) const

◆ getInt() [3/4]

ofParameter< int > & ofParameterGroup::getInt ( std::size_t  pos)

◆ getInt() [4/4]

const ofParameter< int > & ofParameterGroup::getInt ( std::size_t  pos) const

◆ getInternalObject()

const void * ofParameterGroup::getInternalObject ( ) const
protectedvirtual

Implements ofAbstractParameter.

◆ getIsReadOnly()

bool ofParameterGroup::getIsReadOnly ( int  position) const

◆ getName() [1/2]

string ofParameterGroup::getName ( ) const
virtual

Implements ofAbstractParameter.

◆ getName() [2/2]

string ofParameterGroup::getName ( std::size_t  position) const

◆ getPoint() [1/4]

ofParameter< ofPoint > & ofParameterGroup::getPoint ( const std::string &  name)

◆ getPoint() [2/4]

const ofParameter< ofPoint > & ofParameterGroup::getPoint ( const std::string &  name) const

◆ getPoint() [3/4]

ofParameter< ofPoint > & ofParameterGroup::getPoint ( std::size_t  pos)

◆ getPoint() [4/4]

const ofParameter< ofPoint > & ofParameterGroup::getPoint ( std::size_t  pos) const

◆ getPosition()

int ofParameterGroup::getPosition ( const std::string &  name) const

◆ getReadOnly() [1/4]

template<typename ParameterType , typename Friend >
ofReadOnlyParameter< ParameterType, Friend > & ofParameterGroup::getReadOnly ( const std::string &  name)

◆ getReadOnly() [2/4]

template<typename ParameterType , typename Friend >
const ofReadOnlyParameter< ParameterType, Friend > & ofParameterGroup::getReadOnly ( const std::string &  name) const

◆ getReadOnly() [3/4]

template<typename ParameterType , typename Friend >
ofReadOnlyParameter< ParameterType, Friend > & ofParameterGroup::getReadOnly ( std::size_t  pos)

◆ getReadOnly() [4/4]

template<typename ParameterType , typename Friend >
const ofReadOnlyParameter< ParameterType, Friend > & ofParameterGroup::getReadOnly ( std::size_t  pos) const

◆ getRectangle() [1/4]

ofParameter< ofRectangle > & ofParameterGroup::getRectangle ( const std::string &  name)

◆ getRectangle() [2/4]

const ofParameter< ofRectangle > & ofParameterGroup::getRectangle ( const std::string &  name) const

◆ getRectangle() [3/4]

ofParameter< ofRectangle > & ofParameterGroup::getRectangle ( std::size_t  pos)

◆ getRectangle() [4/4]

const ofParameter< ofRectangle > & ofParameterGroup::getRectangle ( std::size_t  pos) const

◆ getShortColor() [1/4]

ofParameter< ofShortColor > & ofParameterGroup::getShortColor ( const std::string &  name)

◆ getShortColor() [2/4]

const ofParameter< ofShortColor > & ofParameterGroup::getShortColor ( const std::string &  name) const

◆ getShortColor() [3/4]

ofParameter< ofShortColor > & ofParameterGroup::getShortColor ( std::size_t  pos)

◆ getShortColor() [4/4]

const ofParameter< ofShortColor > & ofParameterGroup::getShortColor ( std::size_t  pos) const

◆ getString() [1/4]

ofParameter< std::string > & ofParameterGroup::getString ( const std::string &  name)

◆ getString() [2/4]

const ofParameter< std::string > & ofParameterGroup::getString ( const std::string &  name) const

◆ getString() [3/4]

ofParameter< string > & ofParameterGroup::getString ( std::size_t  pos)

◆ getString() [4/4]

const ofParameter< string > & ofParameterGroup::getString ( std::size_t  pos) const

◆ getType()

string ofParameterGroup::getType ( std::size_t  position) const

◆ getVec2f() [1/4]

ofParameter< ofDefaultVec2 > & ofParameterGroup::getVec2f ( const std::string &  name)

◆ getVec2f() [2/4]

const ofParameter< ofDefaultVec2 > & ofParameterGroup::getVec2f ( const std::string &  name) const

◆ getVec2f() [3/4]

ofParameter< ofDefaultVec2 > & ofParameterGroup::getVec2f ( std::size_t  pos)

◆ getVec2f() [4/4]

const ofParameter< ofDefaultVec2 > & ofParameterGroup::getVec2f ( std::size_t  pos) const

◆ getVec3f() [1/4]

ofParameter< ofDefaultVec3 > & ofParameterGroup::getVec3f ( const std::string &  name)

◆ getVec3f() [2/4]

const ofParameter< ofDefaultVec3 > & ofParameterGroup::getVec3f ( const std::string &  name) const

◆ getVec3f() [3/4]

ofParameter< ofDefaultVec3 > & ofParameterGroup::getVec3f ( std::size_t  pos)

◆ getVec3f() [4/4]

const ofParameter< ofDefaultVec3 > & ofParameterGroup::getVec3f ( std::size_t  pos) const

◆ getVec4f() [1/4]

ofParameter< ofDefaultVec4 > & ofParameterGroup::getVec4f ( const std::string &  name)

◆ getVec4f() [2/4]

const ofParameter< ofDefaultVec4 > & ofParameterGroup::getVec4f ( const std::string &  name) const

◆ getVec4f() [3/4]

ofParameter< ofDefaultVec4 > & ofParameterGroup::getVec4f ( std::size_t  pos)

◆ getVec4f() [4/4]

const ofParameter< ofDefaultVec4 > & ofParameterGroup::getVec4f ( std::size_t  pos) const

◆ getVoid() [1/4]

ofParameter< void > & ofParameterGroup::getVoid ( const std::string &  name)

◆ getVoid() [2/4]

const ofParameter< void > & ofParameterGroup::getVoid ( const std::string &  name) const

◆ getVoid() [3/4]

ofParameter< void > & ofParameterGroup::getVoid ( std::size_t  pos)

◆ getVoid() [4/4]

const ofParameter< void > & ofParameterGroup::getVoid ( std::size_t  pos) const

◆ isReadOnly()

bool ofParameterGroup::isReadOnly ( ) const
virtual

Implements ofAbstractParameter.

◆ isSerializable()

bool ofParameterGroup::isSerializable ( ) const
virtual

Implements ofAbstractParameter.

◆ newReference()

shared_ptr< ofAbstractParameter > ofParameterGroup::newReference ( ) const
virtual

Implements ofAbstractParameter.

◆ operator bool()

ofParameterGroup::operator bool ( ) const

◆ operator[]() [1/4]

ofAbstractParameter & ofParameterGroup::operator[] ( const std::string &  name)

◆ operator[]() [2/4]

const ofAbstractParameter & ofParameterGroup::operator[] ( const std::string &  name) const

◆ operator[]() [3/4]

ofAbstractParameter & ofParameterGroup::operator[] ( std::size_t  pos)

◆ operator[]() [4/4]

const ofAbstractParameter & ofParameterGroup::operator[] ( std::size_t  pos) const

◆ parameterChangedE()

ofEvent< ofAbstractParameter > & ofParameterGroup::parameterChangedE ( )

◆ rbegin() [1/2]

vector< shared_ptr< ofAbstractParameter > >::reverse_iterator ofParameterGroup::rbegin ( )

◆ rbegin() [2/2]

vector< shared_ptr< ofAbstractParameter > >::const_reverse_iterator ofParameterGroup::rbegin ( ) const

◆ remove() [1/3]

void ofParameterGroup::remove ( const std::string &  name)

◆ remove() [2/3]

void ofParameterGroup::remove ( ofAbstractParameter param)

◆ remove() [3/3]

void ofParameterGroup::remove ( std::size_t  index)

◆ rend() [1/2]

vector< shared_ptr< ofAbstractParameter > >::reverse_iterator ofParameterGroup::rend ( )

◆ rend() [2/2]

vector< shared_ptr< ofAbstractParameter > >::const_reverse_iterator ofParameterGroup::rend ( ) const

◆ setName()

void ofParameterGroup::setName ( const std::string &  name)
virtual

Implements ofAbstractParameter.

◆ setParent()

void ofParameterGroup::setParent ( ofParameterGroup parent)
virtual

Implements ofAbstractParameter.

◆ setSerializable()

void ofParameterGroup::setSerializable ( bool  serializable)
virtual

Implements ofAbstractParameter.

◆ size()

std::size_t ofParameterGroup::size ( ) const

◆ toString()

string ofParameterGroup::toString ( ) const
virtual

Implements ofAbstractParameter.

◆ valueType()

string ofParameterGroup::valueType ( ) const
virtual

Implements ofAbstractParameter.

Friends And Related Symbol Documentation

◆ ofParameter

template<typename T >
friend class ofParameter
friend

◆ ofReadOnlyParameter

template<typename T , typename F >
friend class ofReadOnlyParameter
friend

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
const ofParameterGroup group 
)
friend

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