#include <PI_ResourceTemplate.h>

Inheritance diagram for PI_StateTemplate:

Public Member Functions
	PI_StateTemplate (const char name, const char english, const char icon_name, void constructor, PRM_Template templates, PI_ViewerType viewer_type, unsigned network_types, bool op_independent=true, const char volatile_hotkey=0, OP_Operator *op=0)

	~PI_StateTemplate () override

void	initialize (const char name, const char english, const char icon_name, void constructor, PRM_Template templates, PI_ViewerType viewer_type, unsigned network_types, int op_independent=1, const char volatile_hotkey=0, bool hidden=false)

void	rebuildVolatileKeys (UT_Array< int > injectionKeys=0, UT_Array< int > injectionKeysModifiers=0)

virtual PRM_Template *	templates ()

virtual const PRM_Template *	templates () const

PI_ViewerType	viewerType () const

unsigned	networkTypes () const

const char *	getIconName () const

bool	opIndependent () const

const UT_Array< int > &	volatileKeys ()

const UT_Array< int > &	volatileKeysModifiers ()

const char *	getHotkeyString () const

OP_Operator *	getOperator () const

void	setSupportsSelectionChange (bool supports_change)

bool	getSupportsSelectionChange () const

void	setHidden (bool hide)

bool	getHidden () const

virtual bool	forceStateToEnter () const

Public Member Functions inherited from PI_ResourceTemplate
	PI_ResourceTemplate (const char name, const char english, void *constructor)

virtual	~PI_ResourceTemplate ()

void	initialize (const char name, const char english, void *constructor)

const UT_String &	name () const

const UT_String &	englishName () const

void *	constructor () const

void	constructor (void *c)

Protected Member Functions
void	setVolatileKeys (const UT_Array< int > &keys, const UT_Array< int > &modifiers)

Detailed Description

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

Definition at line 89 of file PI_ResourceTemplate.h.

Constructor & Destructor Documentation

PI_StateTemplate::PI_StateTemplate	(	const char *	name,
		const char *	english,
		const char *	icon_name,
		void *	constructor,
		PRM_Template *	templates,
		PI_ViewerType	viewer_type,
		unsigned	network_types,
		bool	op_independent = `true`,
		const char *	volatile_hotkey = `0`,
		OP_Operator *	op = `0`
	)

PI_StateTemplate::~PI_StateTemplate ( )

override

Member Function Documentation

virtual bool PI_StateTemplate::forceStateToEnter ( ) const

inlinevirtual

Definition at line 160 of file PI_ResourceTemplate.h.

bool PI_StateTemplate::getHidden ( ) const

inline

Definition at line 156 of file PI_ResourceTemplate.h.

const char* PI_StateTemplate::getHotkeyString ( ) const

inline

Definition at line 141 of file PI_ResourceTemplate.h.

const char* PI_StateTemplate::getIconName ( ) const

inline

Definition at line 133 of file PI_ResourceTemplate.h.

OP_Operator* PI_StateTemplate::getOperator ( ) const

inline

Definition at line 143 of file PI_ResourceTemplate.h.

bool PI_StateTemplate::getSupportsSelectionChange ( ) const

inline

Definition at line 151 of file PI_ResourceTemplate.h.

void PI_StateTemplate::initialize	(	const char *	name,
		const char *	english,
		const char *	icon_name,
		void *	constructor,
		PRM_Template *	templates,
		PI_ViewerType	viewer_type,
		unsigned	network_types,
		int	op_independent = `1`,
		const char *	volatile_hotkey = `0`,
		bool	hidden = `false`
	)

unsigned PI_StateTemplate::networkTypes ( ) const

inline

Definition at line 131 of file PI_ResourceTemplate.h.

bool PI_StateTemplate::opIndependent ( ) const

inline

Definition at line 135 of file PI_ResourceTemplate.h.

void PI_StateTemplate::rebuildVolatileKeys	(	UT_Array< int > *	injectionKeys = `0`,
		UT_Array< int > *	injectionKeysModifiers = `0`
	)

void PI_StateTemplate::setHidden ( bool hide )

inline

Definition at line 154 of file PI_ResourceTemplate.h.

void PI_StateTemplate::setSupportsSelectionChange ( bool supports_change )

inline

Definition at line 149 of file PI_ResourceTemplate.h.

void PI_StateTemplate::setVolatileKeys	(	const UT_Array< int > &	keys,
		const UT_Array< int > &	modifiers
	)

inlineprotected

Definition at line 164 of file PI_ResourceTemplate.h.

virtual PRM_Template* PI_StateTemplate::templates ( )

inlinevirtual

Definition at line 126 of file PI_ResourceTemplate.h.

virtual const PRM_Template* PI_StateTemplate::templates ( ) const

inlinevirtual

Definition at line 127 of file PI_ResourceTemplate.h.

PI_ViewerType PI_StateTemplate::viewerType ( ) const

inline

Definition at line 129 of file PI_ResourceTemplate.h.

const UT_Array<int>& PI_StateTemplate::volatileKeys ( )

inline

Definition at line 137 of file PI_ResourceTemplate.h.

const UT_Array<int>& PI_StateTemplate::volatileKeysModifiers ( )

inline

Definition at line 139 of file PI_ResourceTemplate.h.

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

PI/PI_ResourceTemplate.h

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation