OpenVDB 11.0.0
|
Parameter template list that is always terminated. More...
#include <openvdb_houdini/ParmFactory.h>
Public Types | |
using | PrmTemplateVec = std::vector<PRM_Template> |
Public Member Functions | |
ParmList () | |
bool | empty () const |
Return true if this list contains no parameters. | |
size_t | size () const |
Return the number of parameters in this list. | |
void | clear () |
Remove all parameters from this list. | |
ParmList & | beginSwitcher (const std::string &token, const std::string &label="") |
Begin a collection of tabs. | |
ParmList & | beginExclusiveSwitcher (const std::string &token, const std::string &label="") |
Begin an exclusive collection of tabs. Only one tab is "active" at a time. | |
ParmList & | endSwitcher () |
End a collection of tabs. | |
ParmList & | addFolder (const std::string &label) |
Add a tab with the given label to the current tab collection. | |
PRM_Template * | get () const |
Return a heap-allocated copy of this list's array of parameters. | |
ParmList & | add (const PRM_Template &) |
Add a parameter to this list. | |
ParmList & | add (const ParmFactory &) |
Add a parameter to this list. | |
Parameter template list that is always terminated.
using PrmTemplateVec = std::vector<PRM_Template> |
|
inline |
ParmList & add | ( | const ParmFactory & | ) |
Add a parameter to this list.
ParmList & add | ( | const PRM_Template & | ) |
Add a parameter to this list.
ParmList & addFolder | ( | const std::string & | label | ) |
Add a tab with the given label to the current tab collection.
Parameters subsequently added to this ParmList until the next addFolder() or endSwitcher() call will be displayed on the tab.
std::runtime_error | if not inside a switcher |
ParmList & beginExclusiveSwitcher | ( | const std::string & | token, |
const std::string & | label = "" ) |
Begin an exclusive collection of tabs. Only one tab is "active" at a time.
Tabs may be nested.
ParmList & beginSwitcher | ( | const std::string & | token, |
const std::string & | label = "" ) |
Begin a collection of tabs.
Tabs may be nested.
|
inline |
Remove all parameters from this list.
|
inline |
Return true
if this list contains no parameters.
ParmList & endSwitcher | ( | ) |
End a collection of tabs.
std::runtime_error | if not inside a switcher or if no tabs were added to the switcher |
PRM_Template * get | ( | ) | const |
Return a heap-allocated copy of this list's array of parameters.
|
inline |
Return the number of parameters in this list.