#include <BM_ResourceManager.h>

Inheritance diagram for BM_ResourceManager:

Public Member Functions
BM_State *	newState (BM_View &view, PI_StateTemplate &templ, BM_SceneManager *scene=0) const

virtual BM_State *	newState (BM_View &view, const char name, const char type, BM_SceneManager *scene=0) const

BM_State *	newState (BM_View &view, PI_NetworkType nettype, int state_idx, BM_SceneManager *scene=0) const

BM_Handle *	newHandle (BM_SceneManager &sm, const char *name) const

virtual BM_OpHandleLink *	newOpHandleLink (BM_SceneManager &sm, const char name, const char description) const

BM_InputSelector *	newSelector (BM_View &view, const char *name) const

void	deleteState (BM_State *state)

void	deleteHandle (BM_Handle *handle)

virtual void	deleteOpHandleLink (BM_OpHandleLink *link)

void	deleteSelector (BM_InputSelector *selector)

void	findVolatileKeys (const char *volatile_hotkey_name, UT_Array< int > &volatile_keys, UT_Array< int > &keys_modifiers) const override

void	updateViewports (int id, const char *opname, bool open_only=false) const override

void	removePISettingsFromTables (OP_Operator &op_type) override

virtual void	onPIDescriptionChange (BM_OpHandleLink const &, const char *old_description)

virtual void	onPIPersistentChange (BM_OpHandleLink const &, bool old_state)

virtual void	addPIProxyIndex (BM_OpHandleLink const &)

virtual int	queryPIProxyIndex (BM_SceneManager const &scene_manager, char const *pi_name, bool pi_persistent=true)

void	stashHUDUpdateForNewState (const UT_HUDInfoArgs &args)

Public Member Functions inherited from PI_ResourceManager
	PI_ResourceManager ()

	~PI_ResourceManager () override

virtual int	registerState (PI_StateTemplate *type)

virtual int	registerHandle (PI_HandleTemplate *type)

virtual int	registerOpHandleLink (PI_PITemplate *type)

virtual int	registerSelector (PI_SelectorTemplate *type)

bool	containsState (const char *name, PI_ViewerType viewer_type, unsigned netmask) const

bool	containsHandle (const char *name) const

bool	containsOpHandleLink (const char *name) const

bool	containsSelector (const char *name) const

const PI_BindingHandleArray *	getBindingHandles (OP_Operator *op) const

const PI_BindingSelectorArray *	getBindingSelectors (OP_Operator *op) const

const UT_ValArray < PI_StateTemplate * > &	stateList (PI_ViewerType viewer_type, const char *network_type) const

const UT_ValArray < 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

void	rebuildVolatileKeys ()

virtual PI_PythonResource::RegisterStatus	getViewerStateRegisterStatus (const char state_name, PI_ViewerType viewer_type, const char type) const

virtual void	fireResourceEvent (PI_PythonResource::ResourceType res_type, PI_PythonResource::EventMessage::Type event_type, PI_PythonResource::EventMessage::Data const &event_data)

bool	validStateTemplateName (const char *name) const

virtual PI_PythonResource::Status	unregisterViewerState (const char *name)

virtual bool	isRegisteredViewerState (const char *name) const

virtual PI_PythonState::Template const *	viewerStateTemplate (const char *state_name) const

virtual PI_PythonState::Template *	viewerStateTemplate (const char *state_name)

virtual PI_PythonResource::Status	unbindVolatileViewerHandles (const char *state_name)

virtual PI_PythonResource::Status	unregisterViewerHandle (const char *name)

virtual bool	isRegisteredViewerHandle (const char *name) const

virtual PI_PythonHandle::Template const *	viewerHandleTemplate (const char *handle_name) const

virtual UT_StringArray const &	getViewerHandleTypeNames () 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	bind (OP_Operator op, const char piname, const char pidescription, 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)

virtual bool	bindOperatorToViewerState (const char state_name, OP_Operator op)

bool	operatorStateMandatory (const char op_name, const char op_type) const

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

const PI_OpHandleLinkMap &	getOpHandleLinks () const

PI_PITemplate *	getOpHandleLinkTemplate (const char *pi_name) const

const PI_SelectorTemplateMap &	getSelectors () const

PI_SelectorTemplate *	getSelectorTemplate (const char *selector_name) const

const UT_StringArray &	getBuiltinOpHandleNames ()

const PI_HandleTemplateMap &	getHandles () const

bool	isPIEthereal (const char piname, bool isfloat=0) const

void	ensureStatesExistForAllOperators (const char *net_type_name)

virtual 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)

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)

void	registerOpHandleBindings ()

virtual void	removeAllBindings (OP_Operator *op)

char const *	stateToCreate () const

void	setPythonResourceSupport (void *res_support)

void *	getPythonResourceSupport ()

Public Member Functions inherited from OP_UpdateTableSink
	OP_UpdateTableSink ()

virtual	~OP_UpdateTableSink ()

Public Member Functions inherited from OP_UpdateTemplatesSink
	OP_UpdateTemplatesSink ()

virtual	~OP_UpdateTemplatesSink ()

Static Public Member Functions
static void	startParmsCache ()

static void	stopParmsCache ()

static void	lookupVolatileKeys (const char *volatile_hotkey_name, UT_Array< int > &volatile_keys, UT_Array< int > &keys_modifiers)

Static Public Member Functions inherited from PI_ResourceManager
static bool	getViewerType (const char *viewer_type_token, PI_ViewerType &type)

static void	getViewerTypeToken (PI_ViewerType type, UT_String &viewer_type_token)

static bool	getNetworkType (const char *network_type_name, PI_NetworkType &type)

static const UT_StringHolder &	getNetworkTypeName (PI_NetworkType type)

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 Member Functions
	BM_ResourceManager ()

	~BM_ResourceManager () override

Protected Member Functions inherited from PI_ResourceManager
void	saveStateToCreate (char const *state)

void	installCommands ()

void	registerOpHandleLinks ()

void	registerCop2HandleLinks ()

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)

void	tableUpdated (OP_OperatorTable *table) override

void	tableDeleted (OP_OperatorTable *table) override

void	templatesUpdated (OP_Operator *op) override

void	operatorDeleted (OP_Operator *op) override

void	ensureTableInterestExists (PI_NetworkType net_type, OP_OperatorTable *table)

PI_HandleTemplate *	getHandleTemplate (const char *handle_name) const

OP_ERROR	saveSettings (std::ostream &os) const

OP_ERROR	save (std::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)

virtual PI_SettingList const *	onUpdatePISettings (PI_SettingList const &pi_settings, OP_Operator &op, char const pi_type, char const pi_name) const

Protected Member Functions inherited from OP_UpdateTableSink
void	addUpdateTableSink (OP_OperatorTable *table)

void	removeUpdateTableSink (OP_OperatorTable *table)

void	removeAllTableSinks ()

Protected Member Functions inherited from OP_UpdateTemplatesSink
void	addUpdateTemplatesSink (OP_Operator *op)

bool	hasTemplatesSink (OP_Operator *op)

void	removeUpdateTemplatesSink (OP_Operator *op)

void	removeAllTemplatesSinks ()

Additional Inherited Members
Protected Types inherited from PI_ResourceManager
using	PI_SaveCallbackInfo = std::pair< PI_SaveCallback, void * >

Static Protected Member Functions inherited from PI_ResourceManager
static void	startParmsCache ()

static void	stopParmsCache ()

static void	getParmsCache (UT_ValArray< OP_Node * > &ops, UT_ValArray< PRM_Parm > &parms, UT_IntArray &vec_indices)

static void	getParmsCacheBehaviour (bool &set_keys, bool &do_scope, bool &append_scope)

static OP_ERROR	savePIResourceManagerCallback (std::ostream &os, void *data)

Protected Attributes inherited from PI_ResourceManager
UT_StringArray	myBuiltinOpHandleNames

UT_StringHolder	myStateBeingCreated

UT_StringSet	myStates

PI_HandleTemplateMap	myHandles

PI_OpHandleLinkMap	myOpHandleLinks

PI_SelectorTemplateMap	mySelectors

UT_SymbolMap < pi_OpHandleBinding * >	myOpHandleBindings

UT_SymbolMap < pi_OpSelectorBinding * >	myOpSelectorBindings

UT_Map< PI_OpPIKey, OpPISettingInfo, PI_OpPIKey::Hasher >	myPISettingsForOps

UT_StringMap< PI_SettingList * >	myLastPISettings

UT_ValArray< PI_StateTemplate * >	myStateLists [PI_NUM_VIEWER_TYPES][PI_NUM_NETWORK_TYPES]

UT_SymbolMap< PI_NetworkType >	myNetworkTypeTable

UT_Array< PI_SaveCallbackInfo >	mySaveCallbacks

void *	myCurrentPythonSupport = nullptr

Static Protected Attributes inherited from PI_ResourceManager
static bool	ourSetKeyOnParms

static bool	ourScopeParmChannels

static bool	ourAppendToScope

static int	ourCacheParms

static UT_ValArray< OP_Node * >	ourParmNodes

static UT_ValArray< PRM_Parm * >	ourParms

static UT_IntArray	ourParmVecIndices

static bool	theHideLockedHandleParts

static bool	theScopeChannelsOnKey

static bool	theAddScopedChannels

static bool	theOpenChannelEditorOnScope

Detailed Description

Examples:: SOP/MSS_BrushHairLen.C, SOP/MSS_BrushHairLenSelector.C, and SOP/MSS_CustomBrushState.C.

Definition at line 41 of file BM_ResourceManager.h.

Constructor & Destructor Documentation

BM_ResourceManager::BM_ResourceManager ( )

protected

BM_ResourceManager::~BM_ResourceManager ( )

overrideprotected

Member Function Documentation

virtual void BM_ResourceManager::addPIProxyIndex ( BM_OpHandleLink const & )

virtual

void BM_ResourceManager::deleteHandle ( BM_Handle * handle )

virtual void BM_ResourceManager::deleteOpHandleLink ( BM_OpHandleLink * link )

virtual

void BM_ResourceManager::deleteSelector ( BM_InputSelector * selector )

void BM_ResourceManager::deleteState ( BM_State * state )

void BM_ResourceManager::findVolatileKeys	(	const char *	volatile_hotkey_name,
		UT_Array< int > &	volatile_keys,
		UT_Array< int > &	keys_modifiers
	)		const

overridevirtual

Reimplemented from PI_ResourceManager.

static void BM_ResourceManager::lookupVolatileKeys	(	const char *	volatile_hotkey_name,
		UT_Array< int > &	volatile_keys,
		UT_Array< int > &	keys_modifiers
	)

static

BM_Handle* BM_ResourceManager::newHandle	(	BM_SceneManager &	sm,
		const char *	name
	)		const

virtual BM_OpHandleLink* BM_ResourceManager::newOpHandleLink	(	BM_SceneManager &	sm,
		const char *	name,
		const char *	description
	)		const

virtual

BM_InputSelector* BM_ResourceManager::newSelector	(	BM_View &	view,
		const char *	name
	)		const

BM_State* BM_ResourceManager::newState	(	BM_View &	view,
		PI_StateTemplate &	templ,
		BM_SceneManager *	scene = `0`
	)		const

virtual BM_State* BM_ResourceManager::newState	(	BM_View &	view,
		const char *	name,
		const char *	type,
		BM_SceneManager *	scene = `0`
	)		const

virtual

BM_State* BM_ResourceManager::newState	(	BM_View &	view,
		PI_NetworkType	nettype,
		int	state_idx,
		BM_SceneManager *	scene = `0`
	)		const

virtual void BM_ResourceManager::onPIDescriptionChange	(	BM_OpHandleLink const &	,
		const char *	old_description
	)

virtual

virtual void BM_ResourceManager::onPIPersistentChange	(	BM_OpHandleLink const &	,
		bool	old_state
	)

virtual

virtual int BM_ResourceManager::queryPIProxyIndex	(	BM_SceneManager const &	scene_manager,
		char const *	pi_name,
		bool	pi_persistent = `true`
	)

virtual

void BM_ResourceManager::removePISettingsFromTables ( OP_Operator & op_type )

overridevirtual

Reimplemented from PI_ResourceManager.

static void BM_ResourceManager::startParmsCache ( )

static

void BM_ResourceManager::stashHUDUpdateForNewState ( const UT_HUDInfoArgs & args )

static void BM_ResourceManager::stopParmsCache ( )

static

void BM_ResourceManager::updateViewports	(	int	id,
		const char *	opname,
		bool	open_only = `false`
	)		const

overridevirtual

Reimplemented from PI_ResourceManager.

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

BM/BM_ResourceManager.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation