This documentation is automatically generated from the openFrameworks source code using doxygen and refers to the most recent release, version 0.12.0.
ofParameter holds a value and notifies its listeners when it changes. More...
#include <ofParameter.h>

Public Member Functions | |
ofParameter () | |
ofParameter (const ofParameter< ParameterType > &v) | |
ofParameter (const ParameterType &v) | |
ofParameter (const std::string &name, const ParameterType &v) | |
ofParameter (const std::string &name, const ParameterType &v, const ParameterType &min, const ParameterType &max) | |
const ParameterType & | get () const |
const ParameterType * | operator-> () const |
operator const ParameterType & () const | |
void | setName (const std::string &name) |
std::string | getName () const |
ParameterType | getMin () const |
ParameterType | getMax () const |
ParameterType | getInit () const |
void | reInit () |
std::string | toString () const |
void | fromString (const std::string &name) |
template<class ListenerClass , typename ListenerMethod > | |
void | addListener (ListenerClass *listener, ListenerMethod method, int prio=OF_EVENT_ORDER_AFTER_APP) |
template<class ListenerClass , typename ListenerMethod > | |
void | removeListener (ListenerClass *listener, ListenerMethod method, int prio=OF_EVENT_ORDER_AFTER_APP) |
template<typename... Args> | |
std::unique_ptr< of::priv::AbstractEventToken > | newListener (Args...args) |
void | enableEvents () |
void | disableEvents () |
bool | isSerializable () const |
bool | isReadOnly () const |
std::string | valueType () const |
void | makeReferenceTo (ofParameter< ParameterType > &mom) |
ofParameter< ParameterType > & | operator= (const ofParameter< ParameterType > &v) |
const ParameterType & | operator= (const ParameterType &v) |
ParameterType | operator++ (int v) |
ofParameter< ParameterType > & | operator++ () |
ParameterType | operator-- (int v) |
ofParameter< ParameterType > & | operator-- () |
template<typename OtherType > | |
ofParameter< ParameterType > & | operator+= (const OtherType &v) |
template<typename OtherType > | |
ofParameter< ParameterType > & | operator-= (const OtherType &v) |
template<typename OtherType > | |
ofParameter< ParameterType > & | operator*= (const OtherType &v) |
template<typename OtherType > | |
ofParameter< ParameterType > & | operator/= (const OtherType &v) |
template<typename OtherType > | |
ofParameter< ParameterType > & | operator%= (const OtherType &v) |
template<typename OtherType > | |
ofParameter< ParameterType > & | operator&= (const OtherType &v) |
template<typename OtherType > | |
ofParameter< ParameterType > & | operator|= (const OtherType &v) |
template<typename OtherType > | |
ofParameter< ParameterType > & | operator^= (const OtherType &v) |
template<typename OtherType > | |
ofParameter< ParameterType > & | operator<<= (const OtherType &v) |
template<typename OtherType > | |
ofParameter< ParameterType > & | operator>>= (const OtherType &v) |
ofParameter< ParameterType > & | set (const ParameterType &v) |
ofParameter< ParameterType > & | set (const std::string &name, const ParameterType &v) |
ofParameter< ParameterType > & | set (const std::string &name, const ParameterType &v, const ParameterType &min, const ParameterType &max) |
ofParameter< ParameterType > & | setWithoutEventNotifications (const ParameterType &v) |
void | setMin (const ParameterType &min) |
void | setMax (const ParameterType &max) |
void | setInit (const ParameterType &init) |
void | setSerializable (bool serializable) |
std::shared_ptr< ofAbstractParameter > | newReference () const |
void | setParent (ofParameterGroup &_parent) |
const ofParameterGroup | getFirstParent () const |
size_t | getNumListeners () const |
const void * | getInternalObject () const |
![]() | |
virtual | ~ofAbstractParameter () |
virtual std::string | type () const |
virtual std::string | getEscapedName () 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 |
ofParameterGroup & | castGroup () |
const ofParameterGroup & | castGroup () const |
virtual bool | isReferenceTo (const ofAbstractParameter &other) const |
Friends | |
template<typename T , typename F > | |
class | ofReadOnlyParameter |
Additional Inherited Members | |
![]() | |
virtual std::string | escape (const std::string &str) const |
Detailed Description
class ofParameter< ParameterType >
ofParameter holds a value and notifies its listeners when it changes.
ofParameter can be used as the value itself. For example an ofParameter<int>
can be added, multiplied, substracted, etc with another number.
For an ofParameter with a custom object such as ofParameter<MyObject> myObject
, MyObject
's methods can be accessed using pointer syntax, e.g. myObject->myMethod();
.
- Template Parameters
-
ParameterType The data wrapped by the ofParameter.
Constructor & Destructor Documentation
◆ ofParameter() [1/5]
ofParameter< ParameterType >::ofParameter | ( | ) |
◆ ofParameter() [2/5]
ofParameter< ParameterType >::ofParameter | ( | const ofParameter< ParameterType > & | v | ) |
◆ ofParameter() [3/5]
ofParameter< ParameterType >::ofParameter | ( | const ParameterType & | v | ) |
◆ ofParameter() [4/5]
ofParameter< ParameterType >::ofParameter | ( | const std::string & | name, |
const ParameterType & | v | ||
) |
◆ ofParameter() [5/5]
ofParameter< ParameterType >::ofParameter | ( | const std::string & | name, |
const ParameterType & | v, | ||
const ParameterType & | min, | ||
const ParameterType & | max | ||
) |
Member Function Documentation
◆ addListener()
|
inline |
◆ disableEvents()
void ofParameter< ParameterType >::disableEvents | ( | ) |
◆ enableEvents()
void ofParameter< ParameterType >::enableEvents | ( | ) |
◆ fromString()
|
inlinevirtual |
Implements ofAbstractParameter.
◆ get()
|
inline |
◆ getFirstParent()
|
inlinevirtual |
Implements ofAbstractParameter.
◆ getInit()
ParameterType ofParameter< ParameterType >::getInit | ( | ) | const |
◆ getInternalObject()
|
virtual |
Implements ofAbstractParameter.
◆ getMax()
ParameterType ofParameter< ParameterType >::getMax | ( | ) | const |
◆ getMin()
ParameterType ofParameter< ParameterType >::getMin | ( | ) | const |
◆ getName()
|
virtual |
Implements ofAbstractParameter.
◆ getNumListeners()
size_t ofParameter< ParameterType >::getNumListeners | ( | ) | const |
◆ isReadOnly()
|
virtual |
Implements ofAbstractParameter.
◆ isSerializable()
|
virtual |
Implements ofAbstractParameter.
◆ makeReferenceTo()
void ofParameter< ParameterType >::makeReferenceTo | ( | ofParameter< ParameterType > & | mom | ) |
◆ newListener()
|
inline |
◆ newReference()
|
virtual |
Implements ofAbstractParameter.
◆ operator const ParameterType &()
|
inline |
◆ operator%=()
|
inline |
◆ operator&=()
|
inline |
◆ operator*=()
|
inline |
◆ operator++() [1/2]
|
inline |
◆ operator++() [2/2]
|
inline |
◆ operator+=()
|
inline |
◆ operator--() [1/2]
|
inline |
◆ operator--() [2/2]
|
inline |
◆ operator-=()
|
inline |
◆ operator->()
|
inline |
◆ operator/=()
|
inline |
◆ operator<<=()
|
inline |
◆ operator=() [1/2]
|
inline |
◆ operator=() [2/2]
|
inline |
◆ operator>>=()
|
inline |
◆ operator^=()
|
inline |
◆ operator|=()
ofParameter< ParameterType > & ofParameter< ParameterType >::operator|= | ( | const OtherType & | v | ) |
◆ reInit()
void ofParameter< ParameterType >::reInit | ( | ) |
◆ removeListener()
|
inline |
◆ set() [1/3]
|
inline |
◆ set() [2/3]
ofParameter< ParameterType > & ofParameter< ParameterType >::set | ( | const std::string & | name, |
const ParameterType & | v | ||
) |
◆ set() [3/3]
ofParameter< ParameterType > & ofParameter< ParameterType >::set | ( | const std::string & | name, |
const ParameterType & | v, | ||
const ParameterType & | min, | ||
const ParameterType & | max | ||
) |
◆ setInit()
void ofParameter< ParameterType >::setInit | ( | const ParameterType & | init | ) |
◆ setMax()
void ofParameter< ParameterType >::setMax | ( | const ParameterType & | max | ) |
◆ setMin()
void ofParameter< ParameterType >::setMin | ( | const ParameterType & | min | ) |
◆ setName()
|
virtual |
Implements ofAbstractParameter.
◆ setParent()
|
virtual |
Implements ofAbstractParameter.
◆ setSerializable()
|
virtual |
Implements ofAbstractParameter.
◆ setWithoutEventNotifications()
|
inline |
◆ toString()
|
inlinevirtual |
Implements ofAbstractParameter.
◆ valueType()
|
virtual |
Implements ofAbstractParameter.
Friends And Related Symbol Documentation
◆ ofReadOnlyParameter
|
friend |
The documentation for this class was generated from the following file:
- /Users/icq4ever/Desktop/oF0120/libs/openFrameworks/types/ofParameter.h