OP_Operator Class Reference

#include <OP_Operator.h>

Inheritance diagram for OP_Operator:

List of all members.

Public Types
enum	OP_OperatorCompare { OP_COMPARE_GEN_ENGLISH = 0, OP_COMPARE_GEN_NAME = 1, OP_COMPARE_ENGLISH = 2, OP_COMPARE_NAME = 3 }
Public Member Functions
	OP_Operator (const char *name, const char *english, OP_Constructor construct, PRM_Template *templates, unsigned min_sources, unsigned max_sources=9999, CH_LocalVariable *variables=0, unsigned flags=0, const char **inputlabels=0)
	OP_Operator (const char *name, const char *english, OP_Constructor construct, OP_TemplatePair *template_pair, unsigned min_sources, unsigned max_sources=9999, OP_VariablePair *variable_pair=0, unsigned flags=0, const char **inputlabels=0)
virtual	~OP_Operator ()
OP_Node *	constructNode (OP_Network *net, const char *name)
int	getNumActiveNodes () const
OP_Node *	getActiveNode (int i) const
void	nodeDestroyed (OP_Node *node)
virtual OP_SpecificData *	getOpSpecificData ()
virtual const OP_SpecificData *	getOpSpecificData () const
const UT_String &	getName () const
void	getTableAndName (UT_String &name) const
const UT_String &	getEnglish () const
virtual bool	getHDKHelp (UT_String &) const
virtual bool	getOpHelpURL (UT_String &url)
bool	getOTLHelp (UT_String &str)
void	getEditableSubNodes (UT_String &pattern)
void	getMessageSubNodes (UT_String &pattern)
void	getDiveTarget (UT_String &divetarget)
void	getComment (UT_String &comment)
virtual bool	getVersion (UT_String &version)
void	getHelpFileDirAndName (UT_String &script_dir, UT_String &name)
void	getDefinitionSource (UT_String &defsource) const
OP_Node *	getDefiningNetwork () const
const UT_String &	getIndexPath () const
const UT_String &	getIndexFile () const
bool	getScriptIsSubnet () const
bool	getScriptIsVex () const
bool	getScriptIsRsl () const
VEX_ContextType	getVexContextType () const
RSL_ContextType	getRslContextType () const
int	getModTime () const
bool	getIsDummyDefinition () const
bool	getScriptIsPython () const
void	setScriptIsPython (bool is_python)
const UT_String &	getExtraInfo () const
void	setOTLDefinition (const OP_OTLDefinition &definition)
void	getOTLDefinition (OP_OTLDefinition &definition) const
void	setOTLLibrary (OP_OTLLibrary *library)
OP_OTLLibrary *	getOTLLibrary ()
FS_IndexFile *	getOTLIndexFile ()
bool	hasContentsSection ()
virtual void	clearOTLIndexFile ()
virtual void	forceUpdateParmTemplates ()
FS_IndexFile *	createDefaultOTLIndexFile () const
FS_IndexFile *	createOTLIndexFile (bool reservedsectionsonly, UT_StringArray *externalfiles)
void	getDefinitionSectionName (UT_String &sectname) const
void	constructIndexFileSectionPath (UT_String &path, const char *opdef_or_oplib, const char *section_name=NULL) const
const char *	getIconName () const
void	setIconName (const char *name)
void	setDefaultIconName ()
unsigned	minInputs () const
unsigned	maxInputs () const
virtual unsigned	maxOutputs ()
OP_SpareParms *	loadSpareParms (UT_IStream &is)
virtual bool	hasLoadedParmTemplates () const
virtual int	updateParmTemplates ()
virtual PRM_Template *	getParmTemplates ()
virtual PRM_ScriptImports *	getParmTemplateImports ()
virtual PRM_Template *	getLayoutParmTemplates ()
virtual PRM_ScriptImports *	getLayoutParmTemplateImports ()
virtual const PRM_Template *	getBaseParmTemplates ()
virtual PRM_Template *	getObsoleteTemplates ()
void	setObsoleteTemplates (PRM_Template *tmpl)
CH_LocalVariable *	getVariable (int i) const
CH_LocalVariable *	getVariable (const char *name) const
CH_LocalVariable *	getVariables () const
int	getVariableCount () const
unsigned	isNetwork () const
unsigned	isGenerator () const
unsigned	isScriptedOp () const
bool	isCustomDSO () const
unsigned	unorderedInputs () const
unsigned	isManagementOp () const
bool	getIsPrimarySubnetType () const
bool	isCreatingNode () const
bool	isChangingParmTemplates () const
virtual int	compareOperator (const OP_Operator *other, int method) const
void	changeParmTemplate (PRM_Template *tp)
const UT_String &	getInputLabel (int idx)
const UT_StringArray &	getInputLabels () const
unsigned	getPermissionMask () const
virtual void	getRefreshPICommands (OP_Node *, ostream &)
virtual bool	wantsParametersAnimatable () const
virtual bool	wantsInputEditor () const
virtual bool	wantsParmOrderEditor () const
virtual bool	wantsOutputNameEditor () const
virtual const char *	getOperatorShortHelpString ()
virtual void	getOperatorSpecificInfoText (int verbose, UT_WorkBuffer &text)
void	fillInfoTree (UT_InfoTree &tree)
virtual void	fillInfoTreeOperatorSpecific (UT_InfoTree &tree)
const char *	getTableName () const
OP_OperatorTable *	getTable () const
OP_OTLLicenseType	getLicense ()
void	setDefinition (const char *def)
void	setEnglish (const char *english)
void	informOfTabMenuFlagChange ()
virtual void	setName (const char *name)
void	setMinInputs (int inputs)
void	setMaxInputs (int inputs)
void	setIsGenerator (bool isgen)
void	updatePresetInfo ()
PRM_PresetInfo *	getPresetInfo ()
void	getOpBasedFileName (UT_String &filename)
bool	runEventScript (const char *event, OP_Node *node_arg=NULL, bool full_path=false, UT_Options *extra_args=NULL, bool *node_deleted_by_script=NULL)
PY_EvaluationContext *	getPythonModuleDicts ()
bool	hasLoadedPythonModuleSection () const
void	loadPythonModuleSection ()
bool	isThreadSafe () const
void	setIsThreadSafe (bool is_safe)
Static Public Member Functions
static void	clearOperatorHelpCache ()
static int	loadFromOpType (const char *fname, const char *savedir)
static int	uninstallOpType (const char *path, const char *tablename, const char *opname, const char *indexpath, const char *indexfile)
static void	removeHelpCardOverrides (UT_FileUtil *fu, const char *path, const char *tablename, const char *opname, int flags)
static void	removeRenameOverrides (UT_FileUtil *fu, const char *path, const char *tablename, const char *opname, int flags)
static void	removeIconOverrides (UT_FileUtil *fu, const char *path, const char *tablename, const char *opname, int flags)
static void	removeCmdOverrides (UT_FileUtil *fu, const char *path, const char *tablename, const char *opname, int flags)
static void	getDefaultIconName (const char *tablename, const char *opname, UT_String &iconname)
static const char *	getCurrentPythonModuleKey ()
static const OP_Operator *	mapSecurityKeyToOperator (const char *key)
static void	registerPythonModuleKeyClient (void *client)
static bool	verifyPythonModuleKeyClient (const OP_Operator *op, void *client)
static PRM_Template *	getEmptyTemplateList ()
Protected Member Functions
void	notifyUpdateTemplatesSinksOfUpdate ()
void	notifyUpdateTemplatesSinksOfDelete ()
Static Protected Member Functions
static PRM_Template *	addTemplates (OP_TemplatePair *)
static CH_LocalVariable *	addVariables (OP_VariablePair *)
Protected Attributes
PRM_Template *	myParmTemplates
PRM_Template *	myObsoleteTemplates
UT_StringArray	myInputLabels
CH_LocalVariable *	myVariables
int	myNvariables
OP_OTLDefinition	myOTLDefinition
VEX_ContextType	myVexContextType
RSL_ContextType	myRslContextType
unsigned	myFlags
bool	myHasContentsSection
Friends
class	OP_OperatorTable
class	SHOP_ScriptOperator
class	OP_UpdateTemplatesSink

---

Detailed Description

Examples:

CHOP/CHOP_Blend.C, CHOP/CHOP_Blend.h, CHOP/CHOP_Spring.C, CHOP/CHOP_Spring.h, CHOP/CHOP_Stair.C, CHOP/CHOP_Stair.h, COP2/COP2_FullImageFilter.C, COP2/COP2_FullImageFilter.h, COP2/COP2_MultiInputWipe.C, COP2/COP2_MultiInputWipe.h, COP2/COP2_PixelAdd.C, COP2/COP2_PixelAdd.h, COP2/COP2_SampleFilter.C, COP2/COP2_SampleFilter.h, COP2/COP2_SampleGenerator.C, COP2/COP2_SampleGenerator.h, DOP/DOP_GroupAndApply.C, DOP/DOP_GroupAndApply.h, euclid/SOP_Euclid.C, euclid/SOP_Euclid.h, expr/functions.C, field3d/ROP_Field3D.C, field3d/ROP_Field3D.h, HOM/SOP_HOMWave.C, HOM/SOP_HOMWave.h, OBJ/OBJ_Lamp.C, OBJ/OBJ_Shake.C, OBJ/OBJ_Shake.h, OBJ/OBJ_WorldAlign.C, OBJ/OBJ_WorldAlign.h, POP/POP_CircleForce.C, POP/POP_CircleForce.h, POP/POP_LocalForce.C, POP/POP_LocalForce.h, POP/POP_RadialBirth.C, POP/POP_RadialBirth.h, POP/POP_SpotLight.C, POP/POP_SpotLight.h, ROP/ROP_DopField.C, ROP/ROP_DopField.h, ROP/ROP_Dumper.C, ROP/ROP_Dumper.h, SOP/MSS_BrushHairLenSelector.C, SOP/SOP_BlindData.C, SOP/SOP_BlindData.h, SOP/SOP_BrushHairLen.C, SOP/SOP_BrushHairLen.h, SOP/SOP_CopRaster.C, SOP/SOP_CopRaster.h, SOP/SOP_CPPWave.C, SOP/SOP_CPPWave.h, SOP/SOP_CustomBrush.C, SOP/SOP_CustomBrush.h, SOP/SOP_DetailAttrib.C, SOP/SOP_DetailAttrib.h, SOP/SOP_Flatten.C, SOP/SOP_Flatten.h, SOP/SOP_GroupRename.C, SOP/SOP_GroupRename.h, SOP/SOP_HDKObject.C, SOP/SOP_HDKObject.h, SOP/SOP_IKSample.C, SOP/SOP_IKSample.h, SOP/SOP_NURBS.C, SOP/SOP_NURBS.h, SOP/SOP_PointWave.C, SOP/SOP_PointWave.h, SOP/SOP_PrimVOP.C, SOP/SOP_PrimVOP.h, SOP/SOP_SParticle.C, SOP/SOP_SParticle.h, SOP/SOP_Star.C, SOP/SOP_Star.h, SOP/SOP_Surface.C, SOP/SOP_Surface.h, SOP/SOP_TimeCompare.C, SOP/SOP_TimeCompare.h, tetprim/SOP_Tetra.C, tetprim/SOP_Tetra.h, VOP/VOP_CustomContext.C, VOP/VOP_CustomContext.h, VOP/VOP_Switch.C, and VOP/VOP_Switch.h.

Definition at line 131 of file OP_Operator.h.

---

Member Enumeration Documentation

enum OP_Operator::OP_OperatorCompare

Enumerator:

OP_COMPARE_GEN_ENGLISH
OP_COMPARE_GEN_NAME
OP_COMPARE_ENGLISH
OP_COMPARE_NAME

Definition at line 363 of file OP_Operator.h.

---

Constructor & Destructor Documentation

OP_Operator::OP_Operator	(	const char *	name,
		const char *	english,
		OP_Constructor	construct,
		PRM_Template *	templates,
		unsigned	min_sources,
		unsigned	max_sources = 9999,
		CH_LocalVariable *	variables = 0,
		unsigned	flags = 0,
		const char **	inputlabels = 0
	)

OP_Operator::OP_Operator	(	const char *	name,
		const char *	english,
		OP_Constructor	construct,
		OP_TemplatePair *	template_pair,
		unsigned	min_sources,
		unsigned	max_sources = 9999,
		OP_VariablePair *	variable_pair = 0,
		unsigned	flags = 0,
		const char **	inputlabels = 0
	)

virtual OP_Operator::~OP_Operator

(

)

[virtual]

---

Member Function Documentation

static PRM_Template* OP_Operator::addTemplates

(

OP_TemplatePair *

)

[static, protected]

static CH_LocalVariable* OP_Operator::addVariables

(

OP_VariablePair *

)

[static, protected]

void OP_Operator::changeParmTemplate

(

PRM_Template *

tp

)

static void OP_Operator::clearOperatorHelpCache

(

)

[inline, static]

Definition at line 207 of file OP_Operator.h.

virtual void OP_Operator::clearOTLIndexFile

(

)

[virtual]

Reimplemented in OP_ScriptOperator.

virtual int OP_Operator::compareOperator	(	const OP_Operator *	other,
		int	method
	)			const [virtual]

Reimplemented in SHOP_Operator.

void OP_Operator::constructIndexFileSectionPath	(	UT_String &	path,
		const char *	opdef_or_oplib,
		const char *	section_name = NULL
	)			const

Returns a path that refers to an index file section within an OTL library or an HDA definition (this depends on opdef_or_oplib prefix). If section_name is NULL, then the path will refer only to the library or the HDA definition itself For example, the path may be "opdef:/Object/hda?section" or "opdef:/artistAObject/hda::2.0?section, etc

OP_Node* OP_Operator::constructNode	(	OP_Network *	net,
		const char *	name
	)

FS_IndexFile* OP_Operator::createDefaultOTLIndexFile

(

)

const

FS_IndexFile* OP_Operator::createOTLIndexFile	(	bool	reservedsectionsonly,
		UT_StringArray *	externalfiles
	)

void OP_Operator::fillInfoTree

(

UT_InfoTree &

tree

)

Fill in 'tree' with details that are common to all operator types. Then call fillInfoTreeOperatorSpecific() to get specific details about this specific operator

virtual void OP_Operator::fillInfoTreeOperatorSpecific

(

UT_InfoTree &

tree

)

[virtual]

Triggered by 'fillInfoTree()', this virtual function adds all operator- specific info to 'tree'. All child classes must create their own branches under 'tree' to place their info

Reimplemented in OP_ScriptOperator.

virtual void OP_Operator::forceUpdateParmTemplates

(

)

[virtual]

Reimplemented in OP_ScriptOperator.

OP_Node* OP_Operator::getActiveNode

(

int

i

)

const

virtual const PRM_Template* OP_Operator::getBaseParmTemplates

(

)

[inline, virtual]

Reimplemented in OP_ScriptOperator, and VOP_ScriptOperator.

Definition at line 314 of file OP_Operator.h.

void OP_Operator::getComment

(

UT_String &

comment

)

static const char* OP_Operator::getCurrentPythonModuleKey

(

)

[static]

static void OP_Operator::getDefaultIconName	(	const char *	tablename,
		const char *	opname,
		UT_String &	iconname
	)			[static]

OP_Node* OP_Operator::getDefiningNetwork

(

)

const

void OP_Operator::getDefinitionSectionName

(

UT_String &

sectname

)

const

Returns an official name of the library section that contains the HDA definition eg "Object/hda".

void OP_Operator::getDefinitionSource

(

UT_String &

defsource

)

const

void OP_Operator::getDiveTarget

(

UT_String &

divetarget

)

void OP_Operator::getEditableSubNodes

(

UT_String &

pattern

)

static PRM_Template* OP_Operator::getEmptyTemplateList

(

)

[static]

const UT_String& OP_Operator::getEnglish

(

)

const [inline]

Definition at line 179 of file OP_Operator.h.

const UT_String& OP_Operator::getExtraInfo

(

)

const [inline]

Definition at line 240 of file OP_Operator.h.

virtual bool OP_Operator::getHDKHelp

(

UT_String &

)

const [inline, virtual]

Definition at line 182 of file OP_Operator.h.

void OP_Operator::getHelpFileDirAndName	(	UT_String &	script_dir,
		UT_String &	name
	)

const char* OP_Operator::getIconName

(

)

const

const UT_String& OP_Operator::getIndexFile

(

)

const [inline]

Definition at line 216 of file OP_Operator.h.

const UT_String& OP_Operator::getIndexPath

(

)

const [inline]

Definition at line 214 of file OP_Operator.h.

const UT_String& OP_Operator::getInputLabel

(

int

idx

)

Reimplemented in VOP_ScriptOperator.

const UT_StringArray& OP_Operator::getInputLabels

(

)

const [inline]

Definition at line 379 of file OP_Operator.h.

bool OP_Operator::getIsDummyDefinition

(

)

const [inline]

Definition at line 230 of file OP_Operator.h.

bool OP_Operator::getIsPrimarySubnetType

(

)

const [inline]

Test to see if this is the primary "subnet" operator for the table. This is the operator type which is used as a default container for nodes. There should only be one of these defined.

Definition at line 350 of file OP_Operator.h.

virtual PRM_ScriptImports* OP_Operator::getLayoutParmTemplateImports

(

)

[inline, virtual]

Reimplemented in OP_ScriptOperator.

Definition at line 313 of file OP_Operator.h.

virtual PRM_Template* OP_Operator::getLayoutParmTemplates

(

)

[inline, virtual]

Reimplemented in OP_ScriptOperator.

Definition at line 312 of file OP_Operator.h.

OP_OTLLicenseType OP_Operator::getLicense

(

)

void OP_Operator::getMessageSubNodes

(

UT_String &

pattern

)

int OP_Operator::getModTime

(

)

const [inline]

Definition at line 228 of file OP_Operator.h.

const UT_String& OP_Operator::getName

(

void

)

const [inline]

Examples:

expr/functions.C, and VOP/VOP_CustomContext.C.

Definition at line 169 of file OP_Operator.h.

int OP_Operator::getNumActiveNodes

(

)

const

virtual PRM_Template* OP_Operator::getObsoleteTemplates

(

)

[inline, virtual]

Definition at line 316 of file OP_Operator.h.

void OP_Operator::getOpBasedFileName

(

UT_String &

filename

)

Returns a file name corresponding to the operator name. In most cases, the file name is the same as the operator name, but since it has to be acceptable by all file systems, some invalid characters may be converted to dashes (eg, the namespace semicolons which cause problems on Windows).

virtual const char* OP_Operator::getOperatorShortHelpString

(

)

[virtual]

Reimplemented in OP_ScriptOperator.

virtual void OP_Operator::getOperatorSpecificInfoText	(	int	verbose,
		UT_WorkBuffer &	text
	)			[virtual]

Reimplemented in DOP_Operator, and OP_ScriptOperator.

virtual bool OP_Operator::getOpHelpURL

(

UT_String &

url

)

[virtual]

virtual const OP_SpecificData* OP_Operator::getOpSpecificData

(

)

const [inline, virtual]

Reimplemented in DOP_Operator, SHOP_Operator, VOP_Operator, and VOP_ScriptOperator.

Definition at line 166 of file OP_Operator.h.

virtual OP_SpecificData* OP_Operator::getOpSpecificData

(

)

[inline, virtual]

Reimplemented in DOP_Operator, SHOP_Operator, VOP_Operator, and VOP_ScriptOperator.

Definition at line 164 of file OP_Operator.h.

void OP_Operator::getOTLDefinition

(

OP_OTLDefinition &

definition

)

const [inline]

Definition at line 245 of file OP_Operator.h.

bool OP_Operator::getOTLHelp

(

UT_String &

str

)

FS_IndexFile* OP_Operator::getOTLIndexFile

(

)

OP_OTLLibrary* OP_Operator::getOTLLibrary

(

)

[inline]

Definition at line 251 of file OP_Operator.h.

virtual PRM_ScriptImports* OP_Operator::getParmTemplateImports

(

)

[inline, virtual]

Reimplemented in OP_ScriptOperator.

Definition at line 311 of file OP_Operator.h.

virtual PRM_Template* OP_Operator::getParmTemplates

(

)

[inline, virtual]

Reimplemented in OP_ScriptOperator.

Definition at line 310 of file OP_Operator.h.

unsigned OP_Operator::getPermissionMask

(

)

const

PRM_PresetInfo* OP_Operator::getPresetInfo

(

)

PY_EvaluationContext* OP_Operator::getPythonModuleDicts

(

)

[inline]

Definition at line 510 of file OP_Operator.h.

virtual void OP_Operator::getRefreshPICommands	(	OP_Node *	,
		ostream &
	)			[inline, virtual]

Reimplemented in PI_ScriptOperator.

Definition at line 386 of file OP_Operator.h.

RSL_ContextType OP_Operator::getRslContextType

(

)

const [inline]

Definition at line 226 of file OP_Operator.h.

bool OP_Operator::getScriptIsPython

(

)

const [inline]

Definition at line 234 of file OP_Operator.h.

bool OP_Operator::getScriptIsRsl

(

)

const [inline]

Definition at line 222 of file OP_Operator.h.

bool OP_Operator::getScriptIsSubnet

(

)

const [inline]

Definition at line 218 of file OP_Operator.h.

bool OP_Operator::getScriptIsVex

(

)

const [inline]

Definition at line 220 of file OP_Operator.h.

OP_OperatorTable* OP_Operator::getTable

(

)

const

void OP_Operator::getTableAndName

(

UT_String &

name

)

const [inline]

Get the op table name and the op name concatenated together to get a unique name. Returns full name with table, including namespace and version tags if there are any, eg "artistA::table/op::2.0"

Definition at line 176 of file OP_Operator.h.

const char* OP_Operator::getTableName

(

)

const

CH_LocalVariable* OP_Operator::getVariable

(

const char *

name

)

const

CH_LocalVariable* OP_Operator::getVariable

(

int

i

)

const

int OP_Operator::getVariableCount

(

)

const [inline]

Definition at line 324 of file OP_Operator.h.

CH_LocalVariable* OP_Operator::getVariables

(

)

const [inline]

Definition at line 323 of file OP_Operator.h.

virtual bool OP_Operator::getVersion

(

UT_String &

version

)

[virtual]

For HDAs, getVersion will return the version number defined by its HDA definition, or the empty string if it does not exist. For non-HDA's (ie. native or HDK node types), it will return the Houdini version X.Y.Z.W string that we were compiled with. Subclasses may override this to provide different numbering. One of the uses of this function to determine if loading a node's parameters needs to be upgraded.

VEX_ContextType OP_Operator::getVexContextType

(

)

const [inline]

Definition at line 224 of file OP_Operator.h.

bool OP_Operator::hasContentsSection

(

)

virtual bool OP_Operator::hasLoadedParmTemplates

(

)

const [virtual]

Reimplemented in OP_ScriptOperator.

bool OP_Operator::hasLoadedPythonModuleSection

(

)

const [inline]

Definition at line 512 of file OP_Operator.h.

void OP_Operator::informOfTabMenuFlagChange

(

)

bool OP_Operator::isChangingParmTemplates

(

)

const [inline]

Definition at line 358 of file OP_Operator.h.

bool OP_Operator::isCreatingNode

(

)

const [inline]

Definition at line 354 of file OP_Operator.h.

bool OP_Operator::isCustomDSO

(

)

const

unsigned OP_Operator::isGenerator

(

)

const [inline]

Definition at line 330 of file OP_Operator.h.

unsigned OP_Operator::isManagementOp

(

)

const [inline]

Definition at line 343 of file OP_Operator.h.

unsigned OP_Operator::isNetwork

(

)

const [inline]

Definition at line 326 of file OP_Operator.h.

unsigned OP_Operator::isScriptedOp

(

)

const [inline]

Definition at line 334 of file OP_Operator.h.

bool OP_Operator::isThreadSafe

(

)

const [inline]

Is this operator type thread-safe for cooking? OP_Node::cook() calls this to determine if serialization is needed. DEFAULT: false

Definition at line 519 of file OP_Operator.h.

static int OP_Operator::loadFromOpType	(	const char *	fname,
		const char *	savedir
	)			[static]

void OP_Operator::loadPythonModuleSection

(

)

OP_SpareParms* OP_Operator::loadSpareParms

(

UT_IStream &

is

)

static const OP_Operator* OP_Operator::mapSecurityKeyToOperator

(

const char *

key

)

[static]

unsigned OP_Operator::maxInputs

(

)

const [inline]

Definition at line 297 of file OP_Operator.h.

virtual unsigned OP_Operator::maxOutputs

(

)

[inline, virtual]

Reimplemented in DOP_Operator, SHOP_Operator, VOP_Operator, and VOP_ScriptOperator.

Definition at line 302 of file OP_Operator.h.

unsigned OP_Operator::minInputs

(

)

const [inline]

Definition at line 295 of file OP_Operator.h.

void OP_Operator::nodeDestroyed

(

OP_Node *

node

)

void OP_Operator::notifyUpdateTemplatesSinksOfDelete

(

)

[protected]

void OP_Operator::notifyUpdateTemplatesSinksOfUpdate

(

)

[protected]

static void OP_Operator::registerPythonModuleKeyClient

(

void *

client

)

[static]

static void OP_Operator::removeCmdOverrides	(	UT_FileUtil *	fu,
		const char *	path,
		const char *	tablename,
		const char *	opname,
		int	flags
	)			[static]

static void OP_Operator::removeHelpCardOverrides	(	UT_FileUtil *	fu,
		const char *	path,
		const char *	tablename,
		const char *	opname,
		int	flags
	)			[static]

static void OP_Operator::removeIconOverrides	(	UT_FileUtil *	fu,
		const char *	path,
		const char *	tablename,
		const char *	opname,
		int	flags
	)			[static]

static void OP_Operator::removeRenameOverrides	(	UT_FileUtil *	fu,
		const char *	path,
		const char *	tablename,
		const char *	opname,
		int	flags
	)			[static]

bool OP_Operator::runEventScript	(	const char *	event,
		OP_Node *	node_arg = NULL,
		bool	full_path = false,
		UT_Options *	extra_args = NULL,
		bool *	node_deleted_by_script = NULL
	)

void OP_Operator::setDefaultIconName

(

)

void OP_Operator::setDefinition

(

const char *

def

)

void OP_Operator::setEnglish

(

const char *

english

)

void OP_Operator::setIconName

(

const char *

name

)

void OP_Operator::setIsGenerator

(

bool

isgen

)

void OP_Operator::setIsThreadSafe

(

bool

is_safe

)

[inline]

This function is used to specify whether a particular operator type can be cooked in a multi-threaded manner.

Definition at line 524 of file OP_Operator.h.

void OP_Operator::setMaxInputs

(

int

inputs

)

void OP_Operator::setMinInputs

(

int

inputs

)

virtual void OP_Operator::setName

(

const char *

name

)

[virtual]

void OP_Operator::setObsoleteTemplates

(

PRM_Template *

tmpl

)

[inline]

Definition at line 318 of file OP_Operator.h.

void OP_Operator::setOTLDefinition

(

const OP_OTLDefinition &

definition

)

void OP_Operator::setOTLLibrary

(

OP_OTLLibrary *

library

)

[inline]

Definition at line 249 of file OP_Operator.h.

void OP_Operator::setScriptIsPython

(

bool

is_python

)

[inline]

Definition at line 236 of file OP_Operator.h.

static int OP_Operator::uninstallOpType	(	const char *	path,
		const char *	tablename,
		const char *	opname,
		const char *	indexpath,
		const char *	indexfile
	)			[static]

unsigned OP_Operator::unorderedInputs

(

)

const [inline]

Definition at line 339 of file OP_Operator.h.

virtual int OP_Operator::updateParmTemplates

(

)

[virtual]

Reimplemented in OP_ScriptOperator, and VOP_ScriptOperator.

void OP_Operator::updatePresetInfo

(

)

static bool OP_Operator::verifyPythonModuleKeyClient	(	const OP_Operator *	op,
		void *	client
	)			[static]

virtual bool OP_Operator::wantsInputEditor

(

)

const [virtual]

Reimplemented in DOP_Operator, SHOP_Operator, VOP_Operator, and VOP_ScriptOperator.

virtual bool OP_Operator::wantsOutputNameEditor

(

)

const [virtual]

Reimplemented in VOP_Operator.

virtual bool OP_Operator::wantsParametersAnimatable

(

)

const [virtual]

Reimplemented in VOP_ScriptOperator.

virtual bool OP_Operator::wantsParmOrderEditor

(

)

const [virtual]

Reimplemented in VOP_Operator.

---

Friends And Related Function Documentation

friend class OP_OperatorTable [friend]

Definition at line 612 of file OP_Operator.h.

friend class OP_UpdateTemplatesSink [friend]

Definition at line 614 of file OP_Operator.h.

friend class SHOP_ScriptOperator [friend]

Definition at line 613 of file OP_Operator.h.

---

Member Data Documentation

unsigned OP_Operator::myFlags [protected]

Definition at line 555 of file OP_Operator.h.

bool OP_Operator::myHasContentsSection [protected]

Definition at line 556 of file OP_Operator.h.

UT_StringArray OP_Operator::myInputLabels [protected]

Definition at line 548 of file OP_Operator.h.

int OP_Operator::myNvariables [protected]

Definition at line 550 of file OP_Operator.h.

PRM_Template* OP_Operator::myObsoleteTemplates [protected]

Definition at line 547 of file OP_Operator.h.

OP_OTLDefinition OP_Operator::myOTLDefinition [protected]

Definition at line 552 of file OP_Operator.h.

PRM_Template* OP_Operator::myParmTemplates [protected]

Definition at line 546 of file OP_Operator.h.

RSL_ContextType OP_Operator::myRslContextType [protected]

Definition at line 554 of file OP_Operator.h.

CH_LocalVariable* OP_Operator::myVariables [protected]

Definition at line 549 of file OP_Operator.h.

VEX_ContextType OP_Operator::myVexContextType [protected]

Definition at line 553 of file OP_Operator.h.

---

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

• OP/OP_Operator.h