PI_ResourceManager Class Reference

#include <PI_ResourceManager.h>

Inheritance diagram for PI_ResourceManager:

List of all members.

Classes
class	PI_OpPIHash
class	PI_StringSetHash
Public Member Functions
	PI_ResourceManager ()
virtual	~PI_ResourceManager ()
virtual int	registerState (PI_StateTemplate *type)
virtual int	registerHandle (PI_HandleTemplate *type)
virtual int	registerOpHandleLink (PI_PITemplate *type)
virtual int	registerSelector (PI_SelectorTemplate *type)
int	containsState (const char *name, PI_ViewerType viewer_type, unsigned netmask) const
int	containsHandle (const char *name) const
int	containsOpHandleLink (const char *name) const
int	containsSelector (const char *name) const
const PI_BindingHandleArray *	getBindingHandles (OP_Operator *op) const
const PI_BindingSelectorArray *	getBindingSelectors (OP_Operator *op) const
const UT_PtrArray < PI_StateTemplate * > &	stateList (PI_ViewerType viewer_type, const char *network_type) const
const UT_PtrArray < PI_StateTemplate * > &	stateList (PI_ViewerType viewer_type, PI_NetworkType net_type) const
PI_StateTemplate *	getStateTemplate (const char *name, PI_ViewerType viewer_type, const char *type) const
PI_StateTemplate *	getStateTemplate (OP_Operator *op, PI_ViewerType viewer_type, const char *type) const
int	unbind (OP_Operator *op, const char *pidescription, const UT_String &opparm)
int	bind (OP_Operator *op, const char *piname, const char *pidescription, const UT_String &opparm, const UT_String &piparm, const char *default_settings)
int	bindScriptOp (OP_Operator *op, const char *piname, const char *pidescription, const UT_String &opparm, const UT_String &piparm, const char *default_settings)
int	unbindSelector (OP_Operator *op, const char *seldescription)
int	bindSelector (OP_Operator *op, const char *sname, const char *seldescription, const char *prompt, const char *opparm, int opinput, int opinputreq, const char *primmask, int allowdrag, const char *menu, int astselall, const char *extrainfo, bool fromScriptOp)
PRM_Template *	getTemplateAndVecId (const UT_String &, OP_Operator *, int &) const
void	getChannelNameFromParmAndVec (UT_String &chan, OP_Operator *op, const char *parmname, int vecidx)
int	checkForPIName (const char *pi_name, const char *pi_parm) const
OP_Operator *	findOperator (PI_NetworkType net_type, const char *op_name, bool display_warning=true) const
OP_Operator *	findOperator (const char *opbindname, UT_String *optype=0) const
virtual void	findVolatileKey (const char *volatile_hotkey_name, int &volatile_key, int &key_modifiers) const
virtual void	updateViewports (int id, const char *opname, bool open_only=false) const
UT_SymbolTable &	getOpHandleLinks ()
PI_PITemplate *	getOpHandleLinkTemplate (const char *pi_name) const
UT_SymbolTable &	getSelectors ()
PI_SelectorTemplate *	getSelectorTemplate (const char *selector_name) const
UT_SymbolTable &	getHandles ()
bool	isPIEthereal (const char *piname, bool *isfloat=0) const
void	ensureStatesExistForAllOperators (const char *net_type_name)
void	ensureStatesExistForAllOperators (PI_NetworkType net_type)
int	writeBindingsFile (const char *fname) const
void	loadPISettingsFromTables (PI_OpHandleLink &pi, bool okay_to_use_last_settings) const
void	savePISettingsToTables (PI_OpHandleLink &pi)
virtual void	removePISettingsFromTables (OP_Operator &op_type)
void	removePISettingsFromTables (const PI_OpHandleLink &pi)
void	recordPISettings (const char *pi_description, const char *pi_type, const OP_Node &op_node, const char *settings)
void	addSaveCallback (PI_SaveCallback callback, void *data)
void	removeSaveCallback (PI_SaveCallback callback, void *data)
Static Public Member Functions
static bool	getViewerType (const char *viewer_type_token, PI_ViewerType &type)
static void	getViewerTypeToken (PI_ViewerType type, UT_String &viewer_type_token)
static int	getNetworkType (const char *network_type_name, PI_NetworkType &type)
static void	getNetworkTypeName (PI_NetworkType type, UT_String &nettypename)
static OP_OperatorTable *	getOpTableFromOperator (const OP_Operator *op)
static PI_NetworkType	getFirstNetworkType (unsigned int network_mask)
static PRM_Template *	findParmTemplate (OP_Operator &op, const char *op_Parm_name, int vec_idx, int *parm_idx)
static int	cacheParms ()
static void	appendToParmsCache (OP_Node *op, PRM_Parm *parm, int vi)
static void	setParmsCacheBehaviour (bool set_keys, bool do_scope, bool append_scope)
static bool	getHideLockedHandleParts ()
static void	setHideLockedHandleParts (bool hide)
static bool	getScopeChannelsOnKey ()
static void	setScopeChannelsOnKey (bool scope)
static bool	getAddScopedChannels ()
static void	setAddScopedChannels (bool add)
static bool	getOpenChannelEditorOnScope ()
static void	setOpenChannelEditorOnScope (bool do_open)
static void	getChannelScopeCommandPrefix (UT_String &str)
Protected Types
typedef UT_Pair < PI_SaveCallback, void * >	PI_SaveCallbackInfo
Protected Member Functions
void	installCommands ()
void	registerOpHandleLinks ()
void	registerCopHandleLinks ()
void	registerOpHandleBindings ()
void	registerOpHandleConstructors ()
void	registerSelectors ()
void	registerSelectorConstructors ()
bool	isValidPiParmName (const UT_String &pi_name, const UT_String &pi_parm)
void	loadHandle (CPP_Manager &cppman, OP_Operator *op, pi_OpHandleBinding *binding)
void	loadSelector (CPP_Manager &cppman, const UT_String &selname, const UT_String &seldescription, pi_OpSelectorBinding *binding)
void	loadOperator (CPP_Manager &cppman, const UT_String &oppath)
void	loadOperator (CPP_Manager &cppman, const UT_String &optype, OP_Operator *op, pi_OpHandleBinding *hbinding, pi_OpSelectorBinding *sbinding)
virtual void	addAutomaticStates (PI_NetworkType net_type)
virtual void	tableUpdated (OP_OperatorTable *table)
virtual void	tableDeleted (OP_OperatorTable *table)
virtual void	templatesUpdated (OP_Operator *op)
virtual void	operatorDeleted (OP_Operator *op)
void	ensureTableInterestExists (PI_NetworkType net_type, OP_OperatorTable *table)
PI_HandleTemplate *	getHandleTemplate (const char *handle_name) const
OP_ERROR	saveSettings (ostream &os) const
const PI_SettingList *	getDefaultPISettings (OP_Operator &op_type, const char *type_name, const char *description) const
PI_SettingList *	getDefaultPISettings (OP_Operator &op_type, const char *type_name, const char *description)
Static Protected Member Functions
static void	startParmsCache ()
static void	stopParmsCache ()
static void	getParmsCache (UT_PtrArray< OP_Node * > *&ops, UT_PtrArray< PRM_Parm * > *&parms, UT_IntArray *&vec_indices)
static void	getParmsCacheBehaviour (bool &set_keys, bool &do_scope, bool &append_scope)
static OP_ERROR	savePIResourceManagerCallback (ostream &os, void *data)
static int	savePISettingTraverser (UT_Thing &thing, const UT_Hash &hash_object, void *data)
Protected Attributes
UT_SymbolTable	myStates
UT_SymbolTable	myHandles
UT_SymbolTable	myOpHandleLinks
UT_SymbolTable	mySelectors
UT_SymbolTable	myOpHandleBindings
UT_SymbolTable	myOpSelectorBindings
UT_HashTable	myPISettingsForOps
UT_HashTable	myLastPISettings
UT_PtrArray< PI_StateTemplate * >	myStateLists [PI_NUM_VIEWER_TYPES][PI_NUM_NETWORK_TYPES]
UT_SymbolTable	myNetworkTypeTable
UT_RefArray< PI_SaveCallbackInfo >	mySaveCallbacks
Static Protected Attributes
static bool	ourSetKeyOnParms
static bool	ourScopeParmChannels
static bool	ourAppendToScope
static int	ourCacheParms
static UT_PtrArray< OP_Node * >	ourParmNodes
static UT_PtrArray< PRM_Parm * >	ourParms
static UT_IntArray	ourParmVecIndices
static bool	theHideLockedHandleParts
static bool	theScopeChannelsOnKey
static bool	theAddScopedChannels
static bool	theOpenChannelEditorOnScope
Friends
PI_API void	PIcreateResourceManager ()

---

Detailed Description

Definition at line 154 of file PI_ResourceManager.h.

---

Member Typedef Documentation

typedef UT_Pair<PI_SaveCallback, void *> PI_ResourceManager::PI_SaveCallbackInfo [protected]

Definition at line 477 of file PI_ResourceManager.h.

---

Constructor & Destructor Documentation

PI_ResourceManager::PI_ResourceManager

(

)

virtual PI_ResourceManager::~PI_ResourceManager

(

)

[virtual]

---

Member Function Documentation

virtual void PI_ResourceManager::addAutomaticStates

(

PI_NetworkType

net_type

)

[protected, virtual]

void PI_ResourceManager::addSaveCallback	(	PI_SaveCallback	callback,
		void *	data
	)

static void PI_ResourceManager::appendToParmsCache	(	OP_Node *	op,
		PRM_Parm *	parm,
		int	vi
	)			[static]

int PI_ResourceManager::bind	(	OP_Operator *	op,
		const char *	piname,
		const char *	pidescription,
		const UT_String &	opparm,
		const UT_String &	piparm,
		const char *	default_settings
	)

int PI_ResourceManager::bindScriptOp	(	OP_Operator *	op,
		const char *	piname,
		const char *	pidescription,
		const UT_String &	opparm,
		const UT_String &	piparm,
		const char *	default_settings
	)

int PI_ResourceManager::bindSelector	(	OP_Operator *	op,
		const char *	sname,
		const char *	seldescription,
		const char *	prompt,
		const char *	opparm,
		int	opinput,
		int	opinputreq,
		const char *	primmask,
		int	allowdrag,
		const char *	menu,
		int	astselall,
		const char *	extrainfo,
		bool	fromScriptOp
	)

Examples:

SOP/MSS_BrushHairLenSelector.C.

static int PI_ResourceManager::cacheParms

(

)

[static]

int PI_ResourceManager::checkForPIName	(	const char *	pi_name,
		const char *	pi_parm
	)			const

int PI_ResourceManager::containsHandle

(

const char *

name

)

const

int PI_ResourceManager::containsOpHandleLink

(

const char *

name

)

const

int PI_ResourceManager::containsSelector

(

const char *

name

)

const

int PI_ResourceManager::containsState	(	const char *	name,
		PI_ViewerType	viewer_type,
		unsigned	netmask
	)			const

void PI_ResourceManager::ensureStatesExistForAllOperators

(

PI_NetworkType

net_type

)

void PI_ResourceManager::ensureStatesExistForAllOperators

(

const char *

net_type_name

)

void PI_ResourceManager::ensureTableInterestExists	(	PI_NetworkType	net_type,
		OP_OperatorTable *	table
	)			[protected]

OP_Operator* PI_ResourceManager::findOperator	(	const char *	opbindname,
		UT_String *	optype = 0
	)			const

OP_Operator* PI_ResourceManager::findOperator	(	PI_NetworkType	net_type,
		const char *	op_name,
		bool	display_warning = true
	)			const

static PRM_Template* PI_ResourceManager::findParmTemplate	(	OP_Operator &	op,
		const char *	op_Parm_name,
		int	vec_idx,
		int *	parm_idx
	)			[static]

virtual void PI_ResourceManager::findVolatileKey	(	const char *	volatile_hotkey_name,
		int &	volatile_key,
		int &	key_modifiers
	)			const [virtual]

Reimplemented in BM_ResourceManager.

static bool PI_ResourceManager::getAddScopedChannels

(

)

[inline, static]

Definition at line 363 of file PI_ResourceManager.h.

const PI_BindingHandleArray* PI_ResourceManager::getBindingHandles

(

OP_Operator *

op

)

const

const PI_BindingSelectorArray* PI_ResourceManager::getBindingSelectors

(

OP_Operator *

op

)

const

void PI_ResourceManager::getChannelNameFromParmAndVec	(	UT_String &	chan,
		OP_Operator *	op,
		const char *	parmname,
		int	vecidx
	)

static void PI_ResourceManager::getChannelScopeCommandPrefix

(

UT_String &

str

)

[static]

PI_SettingList* PI_ResourceManager::getDefaultPISettings	(	OP_Operator &	op_type,
		const char *	type_name,
		const char *	description
	)			[protected]

const PI_SettingList* PI_ResourceManager::getDefaultPISettings	(	OP_Operator &	op_type,
		const char *	type_name,
		const char *	description
	)			const [protected]

static PI_NetworkType PI_ResourceManager::getFirstNetworkType

(

unsigned int

network_mask

)

[static]

UT_SymbolTable& PI_ResourceManager::getHandles

(

)

[inline]

Definition at line 278 of file PI_ResourceManager.h.

PI_HandleTemplate* PI_ResourceManager::getHandleTemplate

(

const char *

handle_name

)

const [protected]

static bool PI_ResourceManager::getHideLockedHandleParts

(

)

[inline, static]

Definition at line 355 of file PI_ResourceManager.h.

static int PI_ResourceManager::getNetworkType	(	const char *	network_type_name,
		PI_NetworkType &	type
	)			[static]

static void PI_ResourceManager::getNetworkTypeName	(	PI_NetworkType	type,
		UT_String &	nettypename
	)			[static]

static bool PI_ResourceManager::getOpenChannelEditorOnScope

(

)

[inline, static]

Definition at line 367 of file PI_ResourceManager.h.

UT_SymbolTable& PI_ResourceManager::getOpHandleLinks

(

)

[inline]

Definition at line 272 of file PI_ResourceManager.h.

PI_PITemplate* PI_ResourceManager::getOpHandleLinkTemplate

(

const char *

pi_name

)

const

static OP_OperatorTable* PI_ResourceManager::getOpTableFromOperator

(

const OP_Operator *

op

)

[static]

static void PI_ResourceManager::getParmsCache	(	UT_PtrArray< OP_Node * > *&	ops,
		UT_PtrArray< PRM_Parm * > *&	parms,
		UT_IntArray *&	vec_indices
	)			[static, protected]

static void PI_ResourceManager::getParmsCacheBehaviour	(	bool &	set_keys,
		bool &	do_scope,
		bool &	append_scope
	)			[static, protected]

static bool PI_ResourceManager::getScopeChannelsOnKey

(

)

[inline, static]

Definition at line 359 of file PI_ResourceManager.h.

UT_SymbolTable& PI_ResourceManager::getSelectors

(

)

[inline]

Definition at line 274 of file PI_ResourceManager.h.

PI_SelectorTemplate* PI_ResourceManager::getSelectorTemplate

(

const char *

selector_name

)

const

PI_StateTemplate* PI_ResourceManager::getStateTemplate	(	OP_Operator *	op,
		PI_ViewerType	viewer_type,
		const char *	type
	)			const

PI_StateTemplate* PI_ResourceManager::getStateTemplate	(	const char *	name,
		PI_ViewerType	viewer_type,
		const char *	type
	)			const

PRM_Template* PI_ResourceManager::getTemplateAndVecId	(	const UT_String &	,
		OP_Operator *	,
		int &
	)			const

static bool PI_ResourceManager::getViewerType	(	const char *	viewer_type_token,
		PI_ViewerType &	type
	)			[static]

static void PI_ResourceManager::getViewerTypeToken	(	PI_ViewerType	type,
		UT_String &	viewer_type_token
	)			[static]

void PI_ResourceManager::installCommands

(

)

[protected]

bool PI_ResourceManager::isPIEthereal	(	const char *	piname,
		bool *	isfloat = 0
	)			const

bool PI_ResourceManager::isValidPiParmName	(	const UT_String &	pi_name,
		const UT_String &	pi_parm
	)			[protected]

void PI_ResourceManager::loadHandle	(	CPP_Manager &	cppman,
		OP_Operator *	op,
		pi_OpHandleBinding *	binding
	)			[protected]

void PI_ResourceManager::loadOperator	(	CPP_Manager &	cppman,
		const UT_String &	optype,
		OP_Operator *	op,
		pi_OpHandleBinding *	hbinding,
		pi_OpSelectorBinding *	sbinding
	)			[protected]

void PI_ResourceManager::loadOperator	(	CPP_Manager &	cppman,
		const UT_String &	oppath
	)			[protected]

void PI_ResourceManager::loadPISettingsFromTables	(	PI_OpHandleLink &	pi,
		bool	okay_to_use_last_settings
	)			const

void PI_ResourceManager::loadSelector	(	CPP_Manager &	cppman,
		const UT_String &	selname,
		const UT_String &	seldescription,
		pi_OpSelectorBinding *	binding
	)			[protected]

virtual void PI_ResourceManager::operatorDeleted

(

OP_Operator *

op

)

[protected, virtual]

Reimplemented from OP_UpdateTemplatesSink.

void PI_ResourceManager::recordPISettings	(	const char *	pi_description,
		const char *	pi_type,
		const OP_Node &	op_node,
		const char *	settings
	)

void PI_ResourceManager::registerCopHandleLinks

(

)

[protected]

virtual int PI_ResourceManager::registerHandle

(

PI_HandleTemplate *

type

)

[virtual]

void PI_ResourceManager::registerOpHandleBindings

(

)

[protected]

void PI_ResourceManager::registerOpHandleConstructors

(

)

[protected]

virtual int PI_ResourceManager::registerOpHandleLink

(

PI_PITemplate *

type

)

[virtual]

void PI_ResourceManager::registerOpHandleLinks

(

)

[protected]

virtual int PI_ResourceManager::registerSelector

(

PI_SelectorTemplate *

type

)

[virtual]

Examples:

SOP/MSS_BrushHairLenSelector.C.

void PI_ResourceManager::registerSelectorConstructors

(

)

[protected]

void PI_ResourceManager::registerSelectors

(

)

[protected]

virtual int PI_ResourceManager::registerState

(

PI_StateTemplate *

type

)

[virtual]

Examples:

SOP/MSS_BrushHairLen.C, and SOP/MSS_CustomBrushState.C.

void PI_ResourceManager::removePISettingsFromTables

(

const PI_OpHandleLink &

pi

)

virtual void PI_ResourceManager::removePISettingsFromTables

(

OP_Operator &

op_type

)

[virtual]

Reimplemented in BM_ResourceManager.

void PI_ResourceManager::removeSaveCallback	(	PI_SaveCallback	callback,
		void *	data
	)

static OP_ERROR PI_ResourceManager::savePIResourceManagerCallback	(	ostream &	os,
		void *	data
	)			[static, protected]

void PI_ResourceManager::savePISettingsToTables

(

PI_OpHandleLink &

pi

)

static int PI_ResourceManager::savePISettingTraverser	(	UT_Thing &	thing,
		const UT_Hash &	hash_object,
		void *	data
	)			[static, protected]

OP_ERROR PI_ResourceManager::saveSettings

(

ostream &

os

)

const [protected]

static void PI_ResourceManager::setAddScopedChannels

(

bool

add

)

[inline, static]

Definition at line 365 of file PI_ResourceManager.h.

static void PI_ResourceManager::setHideLockedHandleParts

(

bool

hide

)

[inline, static]

Definition at line 357 of file PI_ResourceManager.h.

static void PI_ResourceManager::setOpenChannelEditorOnScope

(

bool

do_open

)

[inline, static]

Definition at line 369 of file PI_ResourceManager.h.

static void PI_ResourceManager::setParmsCacheBehaviour	(	bool	set_keys,
		bool	do_scope,
		bool	append_scope
	)			[static]

static void PI_ResourceManager::setScopeChannelsOnKey

(

bool

scope

)

[inline, static]

Definition at line 361 of file PI_ResourceManager.h.

static void PI_ResourceManager::startParmsCache

(

)

[static, protected]

Reimplemented in BM_ResourceManager.

const UT_PtrArray<PI_StateTemplate *>& PI_ResourceManager::stateList	(	PI_ViewerType	viewer_type,
		PI_NetworkType	net_type
	)			const

const UT_PtrArray<PI_StateTemplate *>& PI_ResourceManager::stateList	(	PI_ViewerType	viewer_type,
		const char *	network_type
	)			const

static void PI_ResourceManager::stopParmsCache

(

)

[static, protected]

Reimplemented in BM_ResourceManager.

virtual void PI_ResourceManager::tableDeleted

(

OP_OperatorTable *

table

)

[protected, virtual]

Reimplemented from OP_UpdateTableSink.

virtual void PI_ResourceManager::tableUpdated

(

OP_OperatorTable *

table

)

[protected, virtual]

Implements OP_UpdateTableSink.

virtual void PI_ResourceManager::templatesUpdated

(

OP_Operator *

op

)

[protected, virtual]

Implements OP_UpdateTemplatesSink.

int PI_ResourceManager::unbind	(	OP_Operator *	op,
		const char *	pidescription,
		const UT_String &	opparm
	)

int PI_ResourceManager::unbindSelector	(	OP_Operator *	op,
		const char *	seldescription
	)

virtual void PI_ResourceManager::updateViewports	(	int	id,
		const char *	opname,
		bool	open_only = false
	)			const [virtual]

Reimplemented in BM_ResourceManager.

int PI_ResourceManager::writeBindingsFile

(

const char *

fname

)

const

---

Friends And Related Function Documentation

PI_API void PIcreateResourceManager

(

)

[friend]

---

Member Data Documentation

UT_SymbolTable PI_ResourceManager::myHandles [protected]

Definition at line 480 of file PI_ResourceManager.h.

UT_HashTable PI_ResourceManager::myLastPISettings [protected]

Definition at line 488 of file PI_ResourceManager.h.

UT_SymbolTable PI_ResourceManager::myNetworkTypeTable [protected]

Definition at line 492 of file PI_ResourceManager.h.

UT_SymbolTable PI_ResourceManager::myOpHandleBindings [protected]

Definition at line 484 of file PI_ResourceManager.h.

UT_SymbolTable PI_ResourceManager::myOpHandleLinks [protected]

Definition at line 481 of file PI_ResourceManager.h.

UT_SymbolTable PI_ResourceManager::myOpSelectorBindings [protected]

Definition at line 485 of file PI_ResourceManager.h.

UT_HashTable PI_ResourceManager::myPISettingsForOps [protected]

Definition at line 487 of file PI_ResourceManager.h.

UT_RefArray<PI_SaveCallbackInfo> PI_ResourceManager::mySaveCallbacks [protected]

Definition at line 494 of file PI_ResourceManager.h.

UT_SymbolTable PI_ResourceManager::mySelectors [protected]

Definition at line 482 of file PI_ResourceManager.h.

UT_PtrArray<PI_StateTemplate *> PI_ResourceManager::myStateLists[PI_NUM_VIEWER_TYPES][PI_NUM_NETWORK_TYPES] [protected]

Definition at line 491 of file PI_ResourceManager.h.

UT_SymbolTable PI_ResourceManager::myStates [protected]

Definition at line 479 of file PI_ResourceManager.h.

bool PI_ResourceManager::ourAppendToScope [static, protected]

Definition at line 498 of file PI_ResourceManager.h.

int PI_ResourceManager::ourCacheParms [static, protected]

Definition at line 499 of file PI_ResourceManager.h.

UT_PtrArray<OP_Node *> PI_ResourceManager::ourParmNodes [static, protected]

Definition at line 500 of file PI_ResourceManager.h.

UT_PtrArray<PRM_Parm *> PI_ResourceManager::ourParms [static, protected]

Definition at line 501 of file PI_ResourceManager.h.

UT_IntArray PI_ResourceManager::ourParmVecIndices [static, protected]

Definition at line 502 of file PI_ResourceManager.h.

bool PI_ResourceManager::ourScopeParmChannels [static, protected]

Definition at line 497 of file PI_ResourceManager.h.

bool PI_ResourceManager::ourSetKeyOnParms [static, protected]

Definition at line 496 of file PI_ResourceManager.h.

bool PI_ResourceManager::theAddScopedChannels [static, protected]

Definition at line 506 of file PI_ResourceManager.h.

bool PI_ResourceManager::theHideLockedHandleParts [static, protected]

Definition at line 504 of file PI_ResourceManager.h.

bool PI_ResourceManager::theOpenChannelEditorOnScope [static, protected]

Definition at line 507 of file PI_ResourceManager.h.

bool PI_ResourceManager::theScopeChannelsOnKey [static, protected]

Definition at line 505 of file PI_ResourceManager.h.

---

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

• PI/PI_ResourceManager.h