You can nest
BParameterGroup
s
if you want to; however,
BParameter
s
can't be shared among multiple groups.
| Class Overview |
BParameterWeb();
The BParameterWeb
constructor. You'll
usually create one BParameterWeb
object per
BControllable
node; to attach a BParameterWeb
to a
BControllable
node, you should call
BControllable::SetParameterWeb()
.
~BParameterWeb();
Once you've called
BControllable::SetParameterWeb()
,
the node takes responsibility for the parameter web object and you shouldn't delete it.
If you don't call
BControllable::SetParameterWeb()
,
then delete the BParameterWeb
object when you're done with it.
int32 CountGroups();
Returns the number of
BParameterGroup
objects that are currently attached to the BParameterWeb
.
int32 CountParameters();
Returns the number of
BParameter
s
in the entire web, including those in all
BParameterGroup
s
attached to it.
BParameterGroup* GroupAt(int32 index);
Returns the
BParameterGroup
located at the specified index
within the
list of groups contained by the BParameterWeb
.
The first group is numbered 0, so the maximum legal value for index
is
CountGroups()
-1.
If the specified index
is outside that range, NULL
is
returned.
BParameterGroup* MakeGroup(const char* name);
Creates a new
BParameterGroup
object to be used for grouping parameters within the BParameterWeb
,
and attaches it to the BParameterWeb
.
All
BParameter
s
created in the group will belong to that group, and, by
recursion, to the web itself.
You can nest
BParameterGroup
s
if you want to; however,
BParameter
s
can't be shared among multiple groups.
media_node Node();
Returns the
media_node
for the
BControllable
node that owns this BParameterWeb
object.
If the BParameterWeb
hasn't been attached to a
BControllable
node yet, media_node::null
is returned.
BParameter* ParameterAt(int32 index);
Returns the
BParameter
at the specified index
within the entire
BParameterWeb
, including those in all attached groups. The first
parameter is numbered 0, so the maximum legal value for index
is
CountParameters()
-1.
If the specified index
is outside that range, NULL
is returned.