Specifies collections of pre-defined spare parameter definitions. More...

#include <PI_SpareProperty.h>

Static Public Member Functions
static void	list (UT_String &errors, UT_WorkBuffer &wbuf, const char class_pattern=0, const char category=0, bool quiet=false)

static bool	addProperty (OP_Node node, const char top_level_folder, const char class_pattern, const char parameter, UT_String &errors, PI_SPARE_PROPERTY_FILTER ignore_filter, PI_SPARE_PROPERTY_PACKAGE repackage, const char *category_override=nullptr)

static bool	addProperty (PI_EditScriptedParms &editparms, const char top_level_folder, const char class_pattern, const char parameter, UT_String &errors, OP_Node node, PI_SPARE_PROPERTY_FILTER ignore_filter, PI_SPARE_PROPERTY_PACKAGE repackage, const char *category_override=nullptr)

static bool	initialize (UT_String &errors)

static bool	addClassFile (UT_String &errors, const char *path, int pathvar=-1)

static int	getClassFiles (UT_StringArray &list)
	Get a list of the class files. More...

static int	getClasses (UT_StringArray &list, const char filter_tags="")

static const char *	getClassLabel (const char *name)

static bool	isClass (const char *name)

static int	getCategories (UT_StringArray &list, const char *class_pattern)

static int	getParameters (UT_StringArray &list, const char class_pattern, const char category)

static const PRM_ScriptParm *	getParmDefinition (const char classname, const char parameter)

static bool	getClassName (const PRM_ScriptParm *property, UT_String &classname)


static void	getClassAsParameters (PI_EditScriptedParms &parms, const char *class_name)

static void	getCategoryAsParameters (PI_EditScriptedParms &parms, const char class_name, const char category_name)

static void	getCategoryPropertiesAsParameters (PI_EditScriptedParms &parms, const char class_name, const char category_name)

Detailed Description

Specifies collections of pre-defined spare parameter definitions.

This class manages all the spare property lists. These property lists are used by Houdini to quickly add pre-defined parameters to parameter dialogs.

Parameters are collected into "classes". These class collections store parameters that have a common purpose. These classes correspond to the parameter definitions in $HH/soho/parameters.

Each class has a set of "categories". Each category corresponds to a folder of properties. For example, "Shading".

So, the hierarchy is: class.category.property

Definition at line 77 of file PI_SpareProperty.h.

Member Function Documentation

static bool PI_SpareProperty::addClassFile	(	UT_String &	errors,
		const char *	path,
		int	pathvar = `-1`
	)

static

static bool PI_SpareProperty::addProperty	(	OP_Node *	node,
		const char *	top_level_folder,
		const char *	class_pattern,
		const char *	parameter,
		UT_String &	errors,
		PI_SPARE_PROPERTY_FILTER	ignore_filter,
		PI_SPARE_PROPERTY_PACKAGE	repackage,
		const char *	category_override = `nullptr`
	)

static

static bool PI_SpareProperty::addProperty	(	PI_EditScriptedParms &	editparms,
		const char *	top_level_folder,
		const char *	class_pattern,
		const char *	parameter,
		UT_String &	errors,
		OP_Node *	node,
		PI_SPARE_PROPERTY_FILTER	ignore_filter,
		PI_SPARE_PROPERTY_PACKAGE	repackage,
		const char *	category_override = `nullptr`
	)

static

static int PI_SpareProperty::getCategories	(	UT_StringArray &	list,
		const char *	class_pattern
	)

static

static void PI_SpareProperty::getCategoryAsParameters	(	PI_EditScriptedParms &	parms,
		const char *	class_name,
		const char *	category_name
	)

static

Populate parms with a set of parameters representing a class, or a category, or the properties in a category.

static void PI_SpareProperty::getCategoryPropertiesAsParameters	(	PI_EditScriptedParms &	parms,
		const char *	class_name,
		const char *	category_name
	)

static

Populate parms with a set of parameters representing a class, or a category, or the properties in a category.

static void PI_SpareProperty::getClassAsParameters	(	PI_EditScriptedParms &	parms,
		const char *	class_name
	)

static

Populate parms with a set of parameters representing a class, or a category, or the properties in a category.

static int PI_SpareProperty::getClasses	(	UT_StringArray &	list,
		const char *	filter_tags = `"*"`
	)

static

Get a list of all the classes defined by the files Each class has a list of tags associated with it (defined in the .ds file). You can filter the class selection based on the tag expression.

static int PI_SpareProperty::getClassFiles ( UT_StringArray & list )

static

Get a list of the class files.

static const char* PI_SpareProperty::getClassLabel ( const char * name )

static

Each parameter class as properties. This method returns the "label" for the class.

static bool PI_SpareProperty::getClassName	(	const PRM_ScriptParm *	property,
		UT_String &	classname
	)

static

static int PI_SpareProperty::getParameters	(	UT_StringArray &	list,
		const char *	class_pattern,
		const char *	category
	)

static

static const PRM_ScriptParm* PI_SpareProperty::getParmDefinition	(	const char *	classname,
		const char *	parameter
	)

static

static bool PI_SpareProperty::initialize ( UT_String & errors )

static

static bool PI_SpareProperty::isClass ( const char * name )

static

static void PI_SpareProperty::list	(	UT_String &	errors,
		UT_WorkBuffer &	wbuf,
		const char *	class_pattern = `0`,
		const char *	category = `0`,
		bool	quiet = `false`
	)

static

If the class_pattern is nil, the list of classes will be returned. If the category is nil, the list of categories for matching classes will be returned.

All parameters which are contained within the class pattern and category pattern will be returned. If the quiet flag is false, the associated category of each parameter will also be printed, otherwise, just the parameter name will be listed.

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

PI/PI_SpareProperty.h

Static Public Member Functions

Detailed Description

Member Function Documentation