HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | List of all members
PRM_Template Class Reference

#include <PRM_Template.h>

Public Types

enum  PRM_Export { PRM_EXPORT_MIN, PRM_EXPORT_MED, PRM_EXPORT_MAX, PRM_EXPORT_TBX }
 
enum  { MAX_VECTOR_SIZE = 31 }
 

Public Member Functions

 PRM_Template (PRM_Type thetype=PRM_LIST_TERMINATOR, int thevectorsize=1, PRM_Name *thenameptr=0, PRM_Default *thedefaults=0, PRM_ChoiceList *thechoicelistptr=0, PRM_Range *therangeptr=0, PRM_Callback thecallbackfunc=0, PRM_SpareData *thespareptr=0, int theparmgroup=1, const char *thehelptext=0, PRM_ConditionalBase *thecondptr=0)
 
 PRM_Template (PRM_Type thetype, PRM_Export theexportlevel, int thevectorsize=1, PRM_Name *thenameptr=0, PRM_Default *thedefaults=0, PRM_ChoiceList *thechoicelistptr=0, PRM_Range *therangeptr=0, PRM_Callback thecallbackfunc=0, PRM_SpareData *thespareptr=0, int theparmgroup=1, const char *thehelptext=0, PRM_ConditionalBase *thecondptr=0)
 
 PRM_Template (PRM_Type thetype, PRM_TypeExtended thetype_ext, int thevectorsize=1, PRM_Name *thenameptr=0, PRM_Default *thedefaults=0, PRM_ChoiceList *thechoicelistptr=0, PRM_Range *therangeptr=0, PRM_Callback thecallbackfunc=0, PRM_SpareData *thespareptr=0, int theparmgroup=1, const char *thehelptext=0, PRM_ConditionalBase *thecondptr=0)
 
 PRM_Template (PRM_Type thetype, PRM_TypeExtended thetype_ext, PRM_Export theexportlevel, int thevectorsize=1, PRM_Name *thenameptr=0, PRM_Default *thedefaults=0, PRM_ChoiceList *thechoicelistptr=0, PRM_Range *therangeptr=0, PRM_Callback thecallbackfunc=0, PRM_SpareData *thespareptr=0, int theparmgroup=1, const char *thehelptext=0, PRM_ConditionalBase *thecondptr=0)
 
 PRM_Template (PRM_MultiType thetype, PRM_Template *thetemplates, PRM_Export theexportlevel, fpreal multisize, PRM_Name *thenameptr, PRM_Default *thedefaultsize=0, PRM_Range *thedefaultrange=0, PRM_SpareData *thespareptr=0, const char *thehelptext=0, PRM_ConditionalBase *thecondptr=0, PRM_Callback thecallbackfunc=0)
 
 PRM_Template (PRM_MultiType thetype, PRM_Template *thetemplates, fpreal multisize, PRM_Name *thenameptr, PRM_Default *thedefaultsize=0, PRM_Range *thedefaultrange=0, PRM_SpareData *thespareptr=0, const char *thehelptext=0, PRM_ConditionalBase *thecondptr=0, PRM_Callback thecallbackfunc=0)
 
 PRM_Template (const PRM_Template &src)
 
 ~PRM_Template ()
 
int64 getMemoryUsage (bool inclusive) const
 
const PRM_Template & operator= (const PRM_Template &src)
 
void initialize (PRM_Type thetype, PRM_TypeExtended thetype_ext, PRM_Export theexportlevel, int thevectorsize, PRM_Name *thenameptr, PRM_Default *thedefaults, PRM_ChoiceList *thechoicelistptr, PRM_Range *therangeptr, PRM_Callback thecallbackfunc, PRM_SpareData *thespareptr, int theparmgroup, const char *thehelptext, PRM_ConditionalBase *thecondptr)
 
void initMulti (PRM_MultiType thetype, PRM_Template *thetemplates, PRM_Export theexportlevel, fpreal multisize, PRM_Name *thenameptr, PRM_Default *thedefaultsize, PRM_Range *thedefaultrange, PRM_Callback thecallbackfunc, PRM_SpareData *thespareptr, const char *thehelptext, PRM_ConditionalBase *thecondptr)
 
void assign (const PRM_Template &src, int thevectorsize, PRM_Default *thedefaults)
 
const PRM_Type & getType () const
 
PRM_MultiType getMultiType () const
 
bool isMultiType () const
 
bool isRampType () const
 
bool isRampTypeColor () const
 
PRM_TypeExtended getTypeExtended () const
 
int getVectorSize () const
 
fpreal getMultiSize () const
 
void setNamePtr (PRM_Name *name)
 
PRM_Name * getNamePtr ()
 
const PRM_Name * getNamePtr () const
 
PRM_SpareData * getSparePtr ()
 
const PRM_SpareData * getSparePtr () const
 
PRM_SpareData * getOrCreateSparePtr ()
 
void setSparePtr (PRM_SpareData *spare)
 
PRM_Conditional * getConditionalPtr (PRM_ConditionalType type)
 
const PRM_Conditional * getConditionalPtr (PRM_ConditionalType type) const
 
PRM_ConditionalBase * getConditionalBasePtr ()
 
const PRM_ConditionalBase * getConditionalBasePtr () const
 
PRM_Template & setConditionalBasePtr (PRM_ConditionalBase *conditional)
 
PRM_Conditional * getDisablePtr ()
 
const PRM_Conditional * getDisablePtr () const
 
const PRM_ChoiceList * getChoiceListPtr () const
 
PRM_ChoiceList * getChoiceListPtr ()
 
void setChoiceListPtr (PRM_ChoiceList *list)
 
const PRM_Range * getRangePtr () const
 
PRM_Range * getRangePtr ()
 
PRM_Callback getCallback () const
 
void setCallback (PRM_Callback callback)
 
const UT_StringHolder & getHelpText () const
 
unsigned int getAutoScopeField ()
 
const PRM_Template * getMultiParmTemplate () const
 
PRM_Template * getMultiParmTemplate ()
 
void setMultiParmTemplate (PRM_Template *tplate)
 
int getMultiStartOffset () const
 
PRM_Default * getDefault (int index)
 
const PRM_Default * getDefault (int index) const
 
PRM_Default * getFactoryDefaults () const
 
void setFactoryDefaults (PRM_Default *defaults)
 
void restoreFactoryDefaults ()
 
void setFloatDefault (int index, fpreal v)
 
void setOrdinalDefault (int index, int v)
 
void setStringDefault (int index, const char *v)
 
void setDefault (int index, const PRM_Default &d)
 
void setNoResim (bool noresim)
 
void setNoCook (bool nocook)
 
bool setNoCook (const PRM_SpareData *spare, bool force=false)
 
void setBaseParm (bool baseparm)
 
void setInvisible (bool invisible)
 
bool getInvisible () const
 
void setJoinNext (bool joinnext)
 
bool getJoinNext () const
 
void setLabelNone (bool labelnone)
 
bool getLabelNone () const
 
void setTypeExtended (PRM_TypeExtended type_ext)
 
PRM_Export exportLevel () const
 
void setExportLevel (PRM_Export level)
 
int getParmGroup () const
 
int findSubIndex (const UT_StringRef &thechannelname) const
 
const UT_StringHolder * getChannelTokens () const
 
void getChannelToken (UT_String &s, int vi) const
 
const UT_StringHolder & getChannelToken (int vi) const
 
const UT_StringHolder & getDecodedChannelToken (int vi) const
 
bool hasChannelToken (const UT_StringRef &s, int vi) const
 
void getChannelLabel (UT_String &thestrref, int theindex) const
 
void getToken (UT_String &thestrref) const
 
void getLabel (UT_String &thestrref) const
 
int getExpressionFlag () const
 
const char * getToken () const
 
const UT_StringRef & getTokenRef () const
 
const char * getLabel () const
 
unsigned getTokenHash () const
 
bool isAutomaticallyGeneratedChoiceList () const
 
int findSwitcherFolderWithLabel (const char *label) const
 
unsigned int getAutoSelectField ()
 

Static Public Member Functions

static bool matchMultiInstance (const char *name, const char *multi_name, int start_offset, int &index, const UT_IntArray *instance_index)
 
static int countTemplates (const PRM_Template *templates, bool for_switcher=false, bool for_joins=false, bool for_rows=false)
 
static int getTemplateIndexByToken (const PRM_Template *templates, const char *token)
 
static const PRM_Template * getEndOfSwitcher (const PRM_Template *templates)
 
static int getEndOfSwitcher (const UT_Array< const PRM_Template * > &templates, int switcher_index)
 
static void getSwitcherStats (const PRM_Template *templates, UT_IntArray &numswitchersonpages, UT_IntArray &numnonswitchersonpages)
 
static bool getEnclosingSwitcherFolder (const PRM_Template *tplates, const int index, int &switcher, int &folder)
 
static PRM_Export getHighestExportLevel (const PRM_Template *tplates)
 

Detailed Description

Examples:
CHOP/CHOP_Blend.C, CHOP/CHOP_Blend.h, CHOP/CHOP_Spring.C, CHOP/CHOP_Spring.h, CHOP/CHOP_Stair.C, CHOP/CHOP_Stair.h, COP2/COP2_FullImageFilter.C, COP2/COP2_FullImageFilter.h, COP2/COP2_MultiInputWipe.C, COP2/COP2_MultiInputWipe.h, COP2/COP2_PixelAdd.C, COP2/COP2_PixelAdd.h, COP2/COP2_SampleFilter.C, COP2/COP2_SampleFilter.h, COP2/COP2_SampleGenerator.C, COP2/COP2_SampleGenerator.h, DOP/DOP_GroupAndApply.C, DOP/DOP_GroupAndApply.h, euclid/SOP_Euclid.C, euclid/SOP_Euclid.h, field3d/ROP_Field3D.C, HOM/SOP_HOMWave.C, HOM/SOP_HOMWave.h, OBJ/OBJ_Shake.C, OBJ/OBJ_WorldAlign.C, ROP/ROP_Dumper.C, SHOP/SHOP_Multi.C, SHOP/SHOP_POVMaterial.C, SIM/GAS_NetVDBSliceExchange.C, SIM/SIM_ElectricalProperties.C, SIM/SIM_ForceOrbit.C, SIM/SIM_GasAdd.C, SIM/SIM_RadialEmit.C, SIM/SIM_SolverHair.C, SIM/SNOW_Solver.C, SOP/MSS_BrushHairLen.C, SOP/MSS_BrushHairLen.h, SOP/MSS_CustomBrushState.C, SOP/MSS_CustomBrushState.h, SOP/SOP_ArrayAttrib.C, SOP/SOP_ArrayAttrib.h, SOP/SOP_BlindData.C, SOP/SOP_BlindData.h, SOP/SOP_BouncyAgent.C, SOP/SOP_BouncyAgent.h, SOP/SOP_BrushHairLen.C, SOP/SOP_BrushHairLen.h, SOP/SOP_CopRaster.C, SOP/SOP_CopRaster.h, SOP/SOP_CPPWave.C, SOP/SOP_CPPWave.h, SOP/SOP_CustomBrush.C, SOP/SOP_CustomBrush.h, SOP/SOP_DetailAttrib.C, SOP/SOP_DetailAttrib.h, SOP/SOP_DualStar.C, SOP/SOP_DualStar.h, SOP/SOP_Flatten.C, SOP/SOP_Flatten.h, SOP/SOP_GroupRename.C, SOP/SOP_GroupRename.h, SOP/SOP_HDKObject.C, SOP/SOP_HDKObject.h, SOP/SOP_IKSample.C, SOP/SOP_IKSample.h, SOP/SOP_NURBS.C, SOP/SOP_NURBS.h, SOP/SOP_PointWave.C, SOP/SOP_PointWave.h, SOP/SOP_PrimVOP.C, SOP/SOP_PrimVOP.h, SOP/SOP_SParticle.C, SOP/SOP_SParticle.h, SOP/SOP_Surface.C, SOP/SOP_Surface.h, SOP/SOP_TimeCompare.C, SOP/SOP_TimeCompare.h, tetprim/SOP_Tetra.C, tetprim/SOP_Tetra.h, VOP/VOP_CustomContext.C, VOP/VOP_CustomContext.h, VOP/VOP_Switch.C, and VOP/VOP_Switch.h.

Definition at line 49 of file PRM_Template.h.

Member Enumeration Documentation

anonymous enum
Enumerator
MAX_VECTOR_SIZE 

Definition at line 65 of file PRM_Template.h.

enum PRM_Template::PRM_Export
Enumerator
PRM_EXPORT_MIN 
PRM_EXPORT_MED 
PRM_EXPORT_MAX 
PRM_EXPORT_TBX 

Definition at line 57 of file PRM_Template.h.

Constructor & Destructor Documentation

PRM_Template::PRM_Template ( PRM_Type  thetype = PRM_LIST_TERMINATOR,
int  thevectorsize = 1,
PRM_Name *  thenameptr = 0,
PRM_Default *  thedefaults = 0,
PRM_ChoiceList *  thechoicelistptr = 0,
PRM_Range *  therangeptr = 0,
PRM_Callback  thecallbackfunc = 0,
PRM_SpareData *  thespareptr = 0,
int  theparmgroup = 1,
const char *  thehelptext = 0,
PRM_ConditionalBase *  thecondptr = 0 
)
PRM_Template::PRM_Template ( PRM_Type  thetype,
PRM_Export  theexportlevel,
int  thevectorsize = 1,
PRM_Name *  thenameptr = 0,
PRM_Default *  thedefaults = 0,
PRM_ChoiceList *  thechoicelistptr = 0,
PRM_Range *  therangeptr = 0,
PRM_Callback  thecallbackfunc = 0,
PRM_SpareData *  thespareptr = 0,
int  theparmgroup = 1,
const char *  thehelptext = 0,
PRM_ConditionalBase *  thecondptr = 0 
)
PRM_Template::PRM_Template ( PRM_Type  thetype,
PRM_TypeExtended  thetype_ext,
int  thevectorsize = 1,
PRM_Name *  thenameptr = 0,
PRM_Default *  thedefaults = 0,
PRM_ChoiceList *  thechoicelistptr = 0,
PRM_Range *  therangeptr = 0,
PRM_Callback  thecallbackfunc = 0,
PRM_SpareData *  thespareptr = 0,
int  theparmgroup = 1,
const char *  thehelptext = 0,
PRM_ConditionalBase *  thecondptr = 0 
)
PRM_Template::PRM_Template ( PRM_Type  thetype,
PRM_TypeExtended  thetype_ext,
PRM_Export  theexportlevel,
int  thevectorsize = 1,
PRM_Name *  thenameptr = 0,
PRM_Default *  thedefaults = 0,
PRM_ChoiceList *  thechoicelistptr = 0,
PRM_Range *  therangeptr = 0,
PRM_Callback  thecallbackfunc = 0,
PRM_SpareData *  thespareptr = 0,
int  theparmgroup = 1,
const char *  thehelptext = 0,
PRM_ConditionalBase *  thecondptr = 0 
)
PRM_Template::PRM_Template ( PRM_MultiType  thetype,
PRM_Template *  thetemplates,
PRM_Export  theexportlevel,
fpreal  multisize,
PRM_Name *  thenameptr,
PRM_Default *  thedefaultsize = 0,
PRM_Range *  thedefaultrange = 0,
PRM_SpareData *  thespareptr = 0,
const char *  thehelptext = 0,
PRM_ConditionalBase *  thecondptr = 0,
PRM_Callback  thecallbackfunc = 0 
)
PRM_Template::PRM_Template ( PRM_MultiType  thetype,
PRM_Template *  thetemplates,
fpreal  multisize,
PRM_Name *  thenameptr,
PRM_Default *  thedefaultsize = 0,
PRM_Range *  thedefaultrange = 0,
PRM_SpareData *  thespareptr = 0,
const char *  thehelptext = 0,
PRM_ConditionalBase *  thecondptr = 0,
PRM_Callback  thecallbackfunc = 0 
)
PRM_Template::PRM_Template ( const PRM_Template &  src)
PRM_Template::~PRM_Template ( )

Member Function Documentation

void PRM_Template::assign ( const PRM_Template &  src,
int  thevectorsize,
PRM_Default *  thedefaults 
)
static int PRM_Template::countTemplates ( const PRM_Template *  templates,
bool  for_switcher = false,
bool  for_joins = false,
bool  for_rows = false 
)
static
Examples:
field3d/ROP_Field3D.C, and OBJ/OBJ_WorldAlign.C.
PRM_Export PRM_Template::exportLevel ( ) const
inline
Examples:
OBJ/OBJ_WorldAlign.C.

Definition at line 355 of file PRM_Template.h.

int PRM_Template::findSubIndex ( const UT_StringRef &  thechannelname) const
inline

Definition at line 362 of file PRM_Template.h.

int PRM_Template::findSwitcherFolderWithLabel ( const char *  label) const
unsigned int PRM_Template::getAutoScopeField ( )
inline

Definition at line 268 of file PRM_Template.h.

unsigned int PRM_Template::getAutoSelectField ( )
inline

Definition at line 518 of file PRM_Template.h.

PRM_Callback PRM_Template::getCallback ( ) const
inline
Examples:
OBJ/OBJ_WorldAlign.C.

Definition at line 264 of file PRM_Template.h.

void PRM_Template::getChannelLabel ( UT_String &  thestrref,
int  theindex 
) const
void PRM_Template::getChannelToken ( UT_String &  s,
int  vi 
) const
inline

Definition at line 381 of file PRM_Template.h.

const UT_StringHolder& PRM_Template::getChannelToken ( int  vi) const
inline

Definition at line 397 of file PRM_Template.h.

const UT_StringHolder* PRM_Template::getChannelTokens ( ) const
inline

Definition at line 375 of file PRM_Template.h.

const PRM_ChoiceList* PRM_Template::getChoiceListPtr ( ) const
inline
Examples:
OBJ/OBJ_WorldAlign.C.

Definition at line 235 of file PRM_Template.h.

PRM_ChoiceList* PRM_Template::getChoiceListPtr ( )
inline

Definition at line 246 of file PRM_Template.h.

PRM_ConditionalBase* PRM_Template::getConditionalBasePtr ( )
inline
Examples:
OBJ/OBJ_WorldAlign.C.

Definition at line 224 of file PRM_Template.h.

const PRM_ConditionalBase* PRM_Template::getConditionalBasePtr ( ) const
inline

Definition at line 226 of file PRM_Template.h.

PRM_Conditional* PRM_Template::getConditionalPtr ( PRM_ConditionalType  type)
const PRM_Conditional* PRM_Template::getConditionalPtr ( PRM_ConditionalType  type) const
const UT_StringHolder& PRM_Template::getDecodedChannelToken ( int  vi) const
inline

Definition at line 409 of file PRM_Template.h.

PRM_Default* PRM_Template::getDefault ( int  index)
inline

Definition at line 301 of file PRM_Template.h.

const PRM_Default* PRM_Template::getDefault ( int  index) const
inline

Definition at line 307 of file PRM_Template.h.

PRM_Conditional* PRM_Template::getDisablePtr ( )
inline

Definition at line 231 of file PRM_Template.h.

const PRM_Conditional* PRM_Template::getDisablePtr ( ) const
inline

Definition at line 233 of file PRM_Template.h.

static bool PRM_Template::getEnclosingSwitcherFolder ( const PRM_Template *  tplates,
const int  index,
int &  switcher,
int &  folder 
)
static
static const PRM_Template* PRM_Template::getEndOfSwitcher ( const PRM_Template *  templates)
static
static int PRM_Template::getEndOfSwitcher ( const UT_Array< const PRM_Template * > &  templates,
int  switcher_index 
)
static
int PRM_Template::getExpressionFlag ( ) const
inline
Examples:
OBJ/OBJ_WorldAlign.C.

Definition at line 440 of file PRM_Template.h.

PRM_Default* PRM_Template::getFactoryDefaults ( ) const
inline
Examples:
OBJ/OBJ_WorldAlign.C.

Definition at line 313 of file PRM_Template.h.

const UT_StringHolder& PRM_Template::getHelpText ( ) const
inline
Examples:
OBJ/OBJ_WorldAlign.C.

Definition at line 267 of file PRM_Template.h.

static PRM_Export PRM_Template::getHighestExportLevel ( const PRM_Template *  tplates)
static
bool PRM_Template::getInvisible ( ) const
inline

Definition at line 343 of file PRM_Template.h.

bool PRM_Template::getJoinNext ( ) const
inline

Definition at line 346 of file PRM_Template.h.

void PRM_Template::getLabel ( UT_String &  thestrref) const
inline
Examples:
OBJ/OBJ_WorldAlign.C.

Definition at line 435 of file PRM_Template.h.

const char* PRM_Template::getLabel ( ) const
inline

Definition at line 455 of file PRM_Template.h.

bool PRM_Template::getLabelNone ( ) const
inline

Definition at line 349 of file PRM_Template.h.

int64 PRM_Template::getMemoryUsage ( bool  inclusive) const
const PRM_Template* PRM_Template::getMultiParmTemplate ( ) const
inline

Definition at line 275 of file PRM_Template.h.

PRM_Template* PRM_Template::getMultiParmTemplate ( )
inline

Definition at line 277 of file PRM_Template.h.

fpreal PRM_Template::getMultiSize ( ) const
inline

Definition at line 213 of file PRM_Template.h.

int PRM_Template::getMultiStartOffset ( ) const
PRM_MultiType PRM_Template::getMultiType ( ) const
inline

Definition at line 207 of file PRM_Template.h.

PRM_Name* PRM_Template::getNamePtr ( )
inline

Definition at line 215 of file PRM_Template.h.

const PRM_Name* PRM_Template::getNamePtr ( ) const
inline

Definition at line 216 of file PRM_Template.h.

PRM_SpareData* PRM_Template::getOrCreateSparePtr ( )
int PRM_Template::getParmGroup ( ) const
inline
Examples:
OBJ/OBJ_WorldAlign.C.

Definition at line 359 of file PRM_Template.h.

const PRM_Range* PRM_Template::getRangePtr ( ) const
inline
Examples:
OBJ/OBJ_WorldAlign.C.

Definition at line 262 of file PRM_Template.h.

PRM_Range* PRM_Template::getRangePtr ( )
inline

Definition at line 263 of file PRM_Template.h.

PRM_SpareData* PRM_Template::getSparePtr ( )
inline
Examples:
OBJ/OBJ_WorldAlign.C.

Definition at line 217 of file PRM_Template.h.

const PRM_SpareData* PRM_Template::getSparePtr ( ) const
inline

Definition at line 218 of file PRM_Template.h.

static void PRM_Template::getSwitcherStats ( const PRM_Template *  templates,
UT_IntArray &  numswitchersonpages,
UT_IntArray &  numnonswitchersonpages 
)
static
static int PRM_Template::getTemplateIndexByToken ( const PRM_Template *  templates,
const char *  token 
)
static
void PRM_Template::getToken ( UT_String &  thestrref) const
inline
Examples:
OBJ/OBJ_WorldAlign.C.

Definition at line 431 of file PRM_Template.h.

const char* PRM_Template::getToken ( ) const
inline

Definition at line 447 of file PRM_Template.h.

unsigned PRM_Template::getTokenHash ( ) const
inline

Definition at line 459 of file PRM_Template.h.

const UT_StringRef& PRM_Template::getTokenRef ( ) const
inline

Definition at line 451 of file PRM_Template.h.

const PRM_Type& PRM_Template::getType ( ) const
inline
Examples:
OBJ/OBJ_WorldAlign.C.

Definition at line 206 of file PRM_Template.h.

PRM_TypeExtended PRM_Template::getTypeExtended ( ) const
inline
Examples:
OBJ/OBJ_WorldAlign.C.

Definition at line 211 of file PRM_Template.h.

int PRM_Template::getVectorSize ( ) const
inline
Examples:
OBJ/OBJ_WorldAlign.C.

Definition at line 212 of file PRM_Template.h.

bool PRM_Template::hasChannelToken ( const UT_StringRef &  s,
int  vi 
) const
inline

Definition at line 421 of file PRM_Template.h.

void PRM_Template::initialize ( PRM_Type  thetype,
PRM_TypeExtended  thetype_ext,
PRM_Export  theexportlevel,
int  thevectorsize,
PRM_Name *  thenameptr,
PRM_Default *  thedefaults,
PRM_ChoiceList *  thechoicelistptr,
PRM_Range *  therangeptr,
PRM_Callback  thecallbackfunc,
PRM_SpareData *  thespareptr,
int  theparmgroup,
const char *  thehelptext,
PRM_ConditionalBase *  thecondptr 
)
Examples:
OBJ/OBJ_WorldAlign.C.
void PRM_Template::initMulti ( PRM_MultiType  thetype,
PRM_Template *  thetemplates,
PRM_Export  theexportlevel,
fpreal  multisize,
PRM_Name *  thenameptr,
PRM_Default *  thedefaultsize,
PRM_Range *  thedefaultrange,
PRM_Callback  thecallbackfunc,
PRM_SpareData *  thespareptr,
const char *  thehelptext,
PRM_ConditionalBase *  thecondptr 
)
bool PRM_Template::isAutomaticallyGeneratedChoiceList ( ) const
bool PRM_Template::isMultiType ( ) const
bool PRM_Template::isRampType ( ) const
bool PRM_Template::isRampTypeColor ( ) const
static bool PRM_Template::matchMultiInstance ( const char *  name,
const char *  multi_name,
int  start_offset,
int &  index,
const UT_IntArray *  instance_index 
)
static

matchMultiInstance() tests the given name and returns true if it might be an instance parm of the multiparm token (with # characters).

  • If the result is true, then the parsed instance index (relative to start_offset) is returned.
  • If the index in the name is less that start_offset, then it will be rejected.
  • For nested multiparms, the instance_index array contains an array of the parent multiparm instance indices that you want to match against. If it is nullptr, then those checks will be skipped.
const PRM_Template& PRM_Template::operator= ( const PRM_Template &  src)
void PRM_Template::restoreFactoryDefaults ( )
void PRM_Template::setBaseParm ( bool  baseparm)
void PRM_Template::setCallback ( PRM_Callback  callback)
inline

Definition at line 265 of file PRM_Template.h.

void PRM_Template::setChoiceListPtr ( PRM_ChoiceList *  list)
inline

Definition at line 258 of file PRM_Template.h.

PRM_Template& PRM_Template::setConditionalBasePtr ( PRM_ConditionalBase *  conditional)
inline

Definition at line 228 of file PRM_Template.h.

void PRM_Template::setDefault ( int  index,
const PRM_Default &  d 
)
void PRM_Template::setExportLevel ( PRM_Export  level)
inline

Definition at line 357 of file PRM_Template.h.

void PRM_Template::setFactoryDefaults ( PRM_Default *  defaults)
inline

Definition at line 317 of file PRM_Template.h.

void PRM_Template::setFloatDefault ( int  index,
fpreal  v 
)
void PRM_Template::setInvisible ( bool  invisible)
void PRM_Template::setJoinNext ( bool  joinnext)
void PRM_Template::setLabelNone ( bool  labelnone)
void PRM_Template::setMultiParmTemplate ( PRM_Template *  tplate)
inline

Definition at line 279 of file PRM_Template.h.

void PRM_Template::setNamePtr ( PRM_Name *  name)
inline

Definition at line 214 of file PRM_Template.h.

void PRM_Template::setNoCook ( bool  nocook)
bool PRM_Template::setNoCook ( const PRM_SpareData *  spare,
bool  force = false 
)

Set the no-cook flag based on the "cook_dependent" spare data. If the force flag is set, the no-cook flag will be set to true if the spare data doesn't exist.

Returns
The value of the nocook flag
void PRM_Template::setNoResim ( bool  noresim)
void PRM_Template::setOrdinalDefault ( int  index,
int  v 
)
void PRM_Template::setSparePtr ( PRM_SpareData *  spare)
inline

Definition at line 220 of file PRM_Template.h.

void PRM_Template::setStringDefault ( int  index,
const char *  v 
)
void PRM_Template::setTypeExtended ( PRM_TypeExtended  type_ext)
inline

Definition at line 352 of file PRM_Template.h.

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