All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PRM_Utils Class Reference

A set of useful functions for working with parameters. More...

#include <PRM_Utils.h>

Public Types

typedef void(* TraverseParmFunc )(const PRM_ParmList &, PRM_Parm *, int, void *data)

Static Public Member Functions

static int traverseFolder (PRM_ParmList &parmlist, PRM_Parm *switcher, int folder, int folder_start_index, bool traverse_multi_instances, TraverseParmFunc function, void *data)
static void flagMultiParmInstances (const PRM_ParmList &parmlist, PRM_Parm *multi, UT_BitArray &flags)

Detailed Description

A set of useful functions for working with parameters.

Definition at line 22 of file PRM_Utils.h.

Member Typedef Documentation

typedef void(* PRM_Utils::TraverseParmFunc)(const PRM_ParmList &, PRM_Parm *, int, void *data)

Definition at line 25 of file PRM_Utils.h.

Member Function Documentation

static void PRM_Utils::flagMultiParmInstances ( const PRM_ParmList parmlist,
PRM_Parm multi,
UT_BitArray flags 
static int PRM_Utils::traverseFolder ( PRM_ParmList parmlist,
PRM_Parm switcher,
int  folder,
int  folder_start_index,
bool  traverse_multi_instances,
TraverseParmFunc  function,
void data 

Traverse the parameters in the specified folder of the given switcher and optionally execute a function on each parameter.


  • index into the parmlist pointing to first eligible parameter for the folder traverse_multi_instances
  • call the specified function on the instances of any embedded multiparms

Returns the number of parameters to skip in the parmlist to step over the folder. Note that this happens whether or not a traverse function is provided, and does not account for any embedded multiparm instances.

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