PRM_ChoiceList Class Reference

#include <PRM_ChoiceList.h>

Public Member Functions
	PRM_ChoiceList (PRM_ChoiceListType thetype, PRM_Name *thechoicenames)
	PRM_ChoiceList (PRM_ChoiceListType thetype, PRM_ChoiceGenFunc thefunc)
	PRM_ChoiceList (PRM_ChoiceListType thetype, PRM_Item *thechoiceitem)
	PRM_ChoiceList (PRM_ChoiceListType thetype, PRM_ChoiceItemGenFunc thefunc)
	PRM_ChoiceList (PRM_ChoiceListType thetype, const char *thescript, CH_ScriptLanguage language=CH_HSCRIPT)
bool	usesItems () const
PRM_Name *	choiceNamesPtr ()
PRM_Item *	choiceItemsPtr ()
PRM_Item const *	choiceItemsPtr () const
void	getChoiceNames (const PRM_Name *&thechoicenames, void *thedata=0, const PRM_SpareData *theSparePtr=0, const PRM_Parm *theParm=0, bool block_errors=false) const
void	getChoiceItems (const PRM_Item *&thechoiceitems, void *thedata=0, const PRM_SpareData *theSparePtr=0, const PRM_Parm *theParm=0, bool block_errors=false) const
bool	tokenFromIndex (UT_String &result, exint index, void *data=nullptr, const PRM_SpareData *spare=nullptr, const PRM_Parm *parm=nullptr) const
const UT_String &	getScript () const
CH_ScriptLanguage	getScriptLanguage () const
bool	isDynamic () const
PRM_ChoiceListType	getType () const
PRM_ChoiceGenFunc	getChoiceGenerator () const
int	getSize (const PRM_Parm *parm) const
int64	getMemoryUsage (bool inclusive) const
void	updateStaticChoiceSize ()
	Recompute myStaticChoiceSize from myChoiceNames or myChoiceItems. More...

Detailed Description

Examples:

CHOP/CHOP_Blend.C, CHOP/CHOP_Spring.C, CHOP/CHOP_Stair.C, COP2/COP2_MultiInputWipe.C, field3d/ROP_Field3D.C, SOP/MSS_BrushHairLen.C, SOP/MSS_BrushHairLen.h, SOP/SOP_BrushHairLen.C, SOP/SOP_CopRaster.C, SOP/SOP_CustomBrush.C, SOP/SOP_PrimVOP.C, and VOP/VOP_Switch.C.

Definition at line 77 of file PRM_ChoiceList.h.

Constructor & Destructor Documentation

PRM_ChoiceList::PRM_ChoiceList	(	PRM_ChoiceListType	thetype,
		PRM_Name *	thechoicenames
	)

PRM_ChoiceList::PRM_ChoiceList	(	PRM_ChoiceListType	thetype,
		PRM_ChoiceGenFunc	thefunc
	)

PRM_ChoiceList::PRM_ChoiceList	(	PRM_ChoiceListType	thetype,
		PRM_Item *	thechoiceitem
	)

PRM_ChoiceList::PRM_ChoiceList	(	PRM_ChoiceListType	thetype,
		PRM_ChoiceItemGenFunc	thefunc
	)

PRM_ChoiceList::PRM_ChoiceList	(	PRM_ChoiceListType	thetype,
		const char *	thescript,
		CH_ScriptLanguage	language = CH_HSCRIPT
	)

Member Function Documentation

PRM_Item* PRM_ChoiceList::choiceItemsPtr ( )

inline

Definition at line 98 of file PRM_ChoiceList.h.

PRM_Item const* PRM_ChoiceList::choiceItemsPtr ( ) const

inline

Definition at line 103 of file PRM_ChoiceList.h.

PRM_Name* PRM_ChoiceList::choiceNamesPtr ( )

inline

Definition at line 95 of file PRM_ChoiceList.h.

PRM_ChoiceGenFunc PRM_ChoiceList::getChoiceGenerator ( ) const

inline

Definition at line 132 of file PRM_ChoiceList.h.

void PRM_ChoiceList::getChoiceItems	(	const PRM_Item *&	thechoiceitems,
		void *	thedata = 0,
		const PRM_SpareData *	theSparePtr = 0,
		const PRM_Parm *	theParm = 0,
		bool	block_errors = false
	)		const

void PRM_ChoiceList::getChoiceNames	(	const PRM_Name *&	thechoicenames,
		void *	thedata = 0,
		const PRM_SpareData *	theSparePtr = 0,
		const PRM_Parm *	theParm = 0,
		bool	block_errors = false
	)		const

int64 PRM_ChoiceList::getMemoryUsage ( bool  inclusive ) const

inline

NOTE: Based on the lack of destructor, PRM_ChoiceList does NOT own *myChoiceNames or *myChoiceItems, but ownership semantics are bonkers in these mysterious lands of PRM.

Definition at line 147 of file PRM_ChoiceList.h.

const UT_String& PRM_ChoiceList::getScript

(

)

const

CH_ScriptLanguage PRM_ChoiceList::getScriptLanguage

(

)

const

int PRM_ChoiceList::getSize ( const PRM_Parm *  parm ) const

inline

Definition at line 134 of file PRM_ChoiceList.h.

PRM_ChoiceListType PRM_ChoiceList::getType ( ) const

inline

Definition at line 130 of file PRM_ChoiceList.h.

bool PRM_ChoiceList::isDynamic

(

)

const

bool PRM_ChoiceList::tokenFromIndex	(	UT_String &	result,
		exint	index,
		void *	data = nullptr,
		const PRM_SpareData *	spare = nullptr,
		const PRM_Parm *	parm = nullptr
	)		const

void PRM_ChoiceList::updateStaticChoiceSize

(

)

Recompute myStaticChoiceSize from myChoiceNames or myChoiceItems.

bool PRM_ChoiceList::usesItems ( ) const

inline

Definition at line 93 of file PRM_ChoiceList.h.

Member Data Documentation

PRM_ChoiceGenFunc PRM_ChoiceList::myChoiceGenerator

Definition at line 183 of file PRM_ChoiceList.h.

PRM_ChoiceItemGenFunc PRM_ChoiceList::myChoiceItemGenerator

Definition at line 184 of file PRM_ChoiceList.h.

PRM_Item* PRM_ChoiceList::myChoiceItems

Definition at line 178 of file PRM_ChoiceList.h.

PRM_Name* PRM_ChoiceList::myChoiceNames

Definition at line 177 of file PRM_ChoiceList.h.

---

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

• PRM/PRM_ChoiceList.h