OP_OperatorTable Class Reference

#include <OP_OperatorTable.h>

Inheritance diagram for OP_OperatorTable:

Public Member Functions
	OP_OperatorTable (const char *table_name, const char *script_directory)
	~OP_OperatorTable ()
OP_Node *	createNode (OP_Network *parent, const char *type, const char *name=0, int *aliasedScriptedOp=0, bool exact_type=false)
OP_Operator *	getOperator (const char *name) const
bool	addOperator (OP_Operator *op, std::ostream *err=nullptr)
void	removeOperator (OP_Operator *op)
OP_Operator *	getPrimarySubnetOperator ()
void	setScriptCreator (OP_ScriptCreatorFunc creator_func, OP_ScriptCanReuseFunc reuse_func)
void	addScriptIndexFile (const char *indexpath, const char *indexfile, const char *classid, const char *extrainfo, int defaultMinInputs, int defaultMaxInputs, bool issubnet, bool ispython)
bool	loadScriptOperator (const char *opname, UT_IStream &is, OP_OTLLibrary *addToLib)
bool	addOperatorIfNew (const OP_OTLDefinition &definition)
bool	canReuseOperator (const OP_OTLDefinition &new_definition, const OP_Operator *op=0) const
void	requestReload ()
void	runDSOInstall ()
bool	loadDSO (const char *dso_file)
int	entries () const
void	getOperatorList (UT_StringArray &list, bool english=true) const
int	getOperators (OP_OperatorList &list, OP_Network *net=0, bool filterhidden=false) const
OP_OpTypeId	getOpTypeID () const
int	getUniqueOpTypeID () const
void	sortOperators (OP_OperatorList &list, OP_Operator::OP_OperatorCompare method=OP_Operator::OP_COMPARE_GEN_NAME)
const UT_String &	getName () const
const UT_String &	getScriptPath () const
unsigned	getOperatorStatus (OP_Operator *op) const
unsigned	getStatus () const
void	setDefaultType (const char *type)
const char *	getDefaultType () const
bool	setOpRename (const char *optype, const char *newname, std::ostream *err=nullptr)
void	outputOpRenames (std::ostream &os) const
bool	setOpAlias (const char *optype, const char *alias, std::ostream *err=nullptr)
bool	setOpFirstName (const char *type, const char *firstname, std::ostream *err=nullptr)
void	outputOpAliases (std::ostream &os) const
void	outputOpFirstNames (std::ostream &os) const
void	getOpAliases (const char *opname, UT_StringArray &opaliases) const
const char *	getOpFromAlias (const char *alias) const
bool	addOpExcluded (const char *opname, std::ostream *err=nullptr)
bool	isOpExcluded (const char *opname) const
void	outputOpExcluded (std::ostream &os) const
bool	addOpHidden (const char *opname, std::ostream *err=nullptr)
void	delOpHidden (const char *opname)
bool	isOpHidden (const char *opname) const
void	getOpHidden (UT_StringArray &opnames) const
bool	isOpExperimental (const UT_StringRef &opname) const
bool	addOpExperimental (const char *opname, std::ostream *err=nullptr)
bool	setOpDeprecated (const char *opname, const char *version, const char *replacement=0, std::ostream *err=nullptr)
bool	isOpDeprecated (const char *opname) const
bool	getDeprecationInfo (const char *opname, UT_StringHolder &version, UT_StringHolder &replacement) const
void	outputOpDeprecated (std::ostream &os) const
bool	setOpDefaultColor (const UT_StringHolder &optype, const UT_Color &clr, std::ostream *err=nullptr)
UT_Color	getOpDefaultColor (const UT_StringRef &optype) const
bool	hasSpecificOpDefaultColor (const UT_StringRef &optype) const
void	clearOpDefaultColors ()
void	outputOpDefaultColors (std::ostream &os) const
bool	setOpDefaultShape (const UT_StringHolder &optype, const UT_StringHolder &shape, std::ostream *err=nullptr)
const UT_StringHolder &	getOpDefaultShape (const UT_StringRef &optype) const
bool	hasSpecificOpDefaultShape (const UT_StringRef &optype) const
void	clearOpDefaultShapes ()
void	outputOpDefaultShapes (std::ostream &os) const
const UT_StringHolder &	getDefaultWireStyle () const
void	setDefaultWireStyle (const UT_StringHolder &wirestyle)
void	getDefaultNodeName (const char *type, UT_String &name)
const char *	getScriptedSubnetIndex () const
void	notifyUpdateTableSinksOfUpdate ()
void	getCandidateOperatorNamesInPrecedenceOrder (UT_StringArray &precedence_order, const char *op_name, const UT_StringArray *scope_network_stack)
const char *	getPreferredOperatorName (const char *opname, const UT_StringArray *scope_network_stack)
bool	nodeNameImpliesType (OP_Operator *op, const UT_String &node_name) const

Static Public Member Functions
static int	getAllOperatorTables (OP_OperatorTableList &list)
static int	getLoadDSOFlag ()
static void	setLoadDSOFlag (int i)
static unsigned	getPermissionMask (const OP_Operator *op)
static void	clearPermissionMask (const OP_Operator *op)
static void	initializeOpThemes ()
static void	buildOpTypeNamespaceHierarchy ()
static const char *	getOpTypeNamespaceHierarchyPref ()
static bool	alwaysReuseScriptOperatorCallback (const OP_ScriptOperator *script_operator, const OP_OTLDefinition &new_definition)
	Convenience functions for the second callback in setScriptCreator(). More...
static bool	neverReuseScriptOperatorCallback (const OP_ScriptOperator *script_operator, const OP_OTLDefinition &new_definition)

Friends
class	OP_UpdateTableSink

Detailed Description

Examples:

CHOP/CHOP_Blend.C, CHOP/CHOP_Spring.C, CHOP/CHOP_Stair.C, COP2/COP2_FullImageFilter.C, COP2/COP2_MultiInputWipe.C, COP2/COP2_PixelAdd.C, COP2/COP2_SampleFilter.C, COP2/COP2_SampleGenerator.C, DOP/DOP_GroupAndApply.C, euclid/SOP_Euclid.C, field3d/ROP_Field3D.C, HOM/SOP_HOMWave.C, LOP/LOP_Sphere.C, OBJ/OBJ_Lamp.C, OBJ/OBJ_Shake.C, OBJ/OBJ_WorldAlign.C, ROP/ROP_Dumper.C, SHOP/SHOP_Multi.C, SHOP/SHOP_Multi.h, SHOP/SHOP_POVMaterial.C, SOP/SOP_ArrayAttrib.C, SOP/SOP_BlindData.C, SOP/SOP_BouncyAgent.C, SOP/SOP_BrushHairLen.C, SOP/SOP_Cop2Raster.C, SOP/SOP_CPPWave.C, SOP/SOP_CustomBrush.C, SOP/SOP_DetailAttrib.C, SOP/SOP_DualStar.C, SOP/SOP_Flatten.C, SOP/SOP_GroupRename.C, SOP/SOP_HDKObject.C, SOP/SOP_IKSample.C, SOP/SOP_NURBS.C, SOP/SOP_PointWave.C, SOP/SOP_PrimVOP.C, SOP/SOP_SParticle.C, SOP/SOP_Surface.C, SOP/SOP_TimeCompare.C, tetprim/SOP_Tetra.C, VOP/VOP_CustomContext.C, VOP/VOP_CustomContext.h, and VOP/VOP_Switch.C.

Definition at line 42 of file OP_OperatorTable.h.

Constructor & Destructor Documentation

OP_OperatorTable::OP_OperatorTable	(	const char *	table_name,
		const char *	script_directory
	)

OP_OperatorTable::~OP_OperatorTable

(

)

Member Function Documentation

bool OP_OperatorTable::addOperator	(	OP_Operator *	op,
		std::ostream *	err = nullptr
	)

Examples:

CHOP/CHOP_Blend.C, CHOP/CHOP_Spring.C, CHOP/CHOP_Stair.C, COP2/COP2_FullImageFilter.C, COP2/COP2_MultiInputWipe.C, COP2/COP2_PixelAdd.C, COP2/COP2_SampleFilter.C, COP2/COP2_SampleGenerator.C, DOP/DOP_GroupAndApply.C, euclid/SOP_Euclid.C, field3d/ROP_Field3D.C, HOM/SOP_HOMWave.C, LOP/LOP_Sphere.C, OBJ/OBJ_Lamp.C, OBJ/OBJ_Shake.C, OBJ/OBJ_WorldAlign.C, ROP/ROP_Dumper.C, SHOP/SHOP_Multi.C, SHOP/SHOP_POVMaterial.C, SOP/SOP_ArrayAttrib.C, SOP/SOP_BlindData.C, SOP/SOP_BouncyAgent.C, SOP/SOP_BrushHairLen.C, SOP/SOP_Cop2Raster.C, SOP/SOP_CPPWave.C, SOP/SOP_CustomBrush.C, SOP/SOP_DetailAttrib.C, SOP/SOP_DualStar.C, SOP/SOP_Flatten.C, SOP/SOP_GroupRename.C, SOP/SOP_HDKObject.C, SOP/SOP_IKSample.C, SOP/SOP_NURBS.C, SOP/SOP_PointWave.C, SOP/SOP_PrimVOP.C, SOP/SOP_SParticle.C, SOP/SOP_Surface.C, SOP/SOP_TimeCompare.C, tetprim/SOP_Tetra.C, VOP/VOP_CustomContext.C, and VOP/VOP_Switch.C.

bool OP_OperatorTable::addOperatorIfNew

(

const OP_OTLDefinition &

definition

)

bool OP_OperatorTable::addOpExcluded	(	const char *	opname,
		std::ostream *	err = nullptr
	)

bool OP_OperatorTable::addOpExperimental	(	const char *	opname,
		std::ostream *	err = nullptr
	)

bool OP_OperatorTable::addOpHidden	(	const char *	opname,
		std::ostream *	err = nullptr
	)

void OP_OperatorTable::addScriptIndexFile	(	const char *	indexpath,
		const char *	indexfile,
		const char *	classid,
		const char *	extrainfo,
		int	defaultMinInputs,
		int	defaultMaxInputs,
		bool	issubnet,
		bool	ispython
	)

static bool OP_OperatorTable::alwaysReuseScriptOperatorCallback ( const OP_ScriptOperator *  script_operator, const OP_OTLDefinition &  new_definition  )

static

Convenience functions for the second callback in setScriptCreator().

static void OP_OperatorTable::buildOpTypeNamespaceHierarchy ( )

static

Builds (or rebuilds) the operator type namespace hierarchy. The optype precedense is given by the environment variable HOUDINI_OPTYPE_NAMESPACE_HIERARCHY, which is processed by this method.

bool OP_OperatorTable::canReuseOperator	(	const OP_OTLDefinition &	new_definition,
		const OP_Operator *	op = 0
	)		const

void OP_OperatorTable::clearOpDefaultColors

(

)

void OP_OperatorTable::clearOpDefaultShapes

(

)

static void OP_OperatorTable::clearPermissionMask ( const OP_Operator *  op )

static

OP_Node* OP_OperatorTable::createNode	(	OP_Network *	parent,
		const char *	type,
		const char *	name = 0,
		int *	aliasedScriptedOp = 0,
		bool	exact_type = false
	)

Creates a new node of a given type inside a parent and names it as a give name.

Parameters

exact_type

If true, the operator name parameter 'type', is used verbatim to lookup the operator. Otherwise, a preferred operator name that matches 'type' specification is found first and then is used to lookup the operator. For example, "hda" may match "hda::2.0", which is the preferred operator definition.

void OP_OperatorTable::delOpHidden

(

const char *

opname

)

int OP_OperatorTable::entries ( ) const

inline

Definition at line 97 of file OP_OperatorTable.h.

static int OP_OperatorTable::getAllOperatorTables ( OP_OperatorTableList &  list )

static

void OP_OperatorTable::getCandidateOperatorNamesInPrecedenceOrder	(	UT_StringArray &	precedence_order,
		const char *	op_name,
		const UT_StringArray *	scope_network_stack
	)

Obtains a list of available operator names that have the same base (core) name as the given operator. If scope network name is not NULL, the list includes only operators whose nodes can be created in that network (otherwise all operators are included). The list is sorted according to the descending precedence order.

void OP_OperatorTable::getDefaultNodeName	(	const char *	type,
		UT_String &	name
	)

const char* OP_OperatorTable::getDefaultType

(

)

const

const UT_StringHolder& OP_OperatorTable::getDefaultWireStyle

(

)

const

bool OP_OperatorTable::getDeprecationInfo	(	const char *	opname,
		UT_StringHolder &	version,
		UT_StringHolder &	replacement
	)		const

static int OP_OperatorTable::getLoadDSOFlag ( )

inlinestatic

Definition at line 236 of file OP_OperatorTable.h.

const UT_String& OP_OperatorTable::getName ( ) const

inline

Definition at line 117 of file OP_OperatorTable.h.

void OP_OperatorTable::getOpAliases	(	const char *	opname,
		UT_StringArray &	opaliases
	)		const

UT_Color OP_OperatorTable::getOpDefaultColor

(

const UT_StringRef &

optype

)

const

const UT_StringHolder& OP_OperatorTable::getOpDefaultShape

(

const UT_StringRef &

optype

)

const

OP_Operator* OP_OperatorTable::getOperator

(

const char *

name

)

const

Examples:

SOP/MSS_BrushHairLenSelector.C.

void OP_OperatorTable::getOperatorList	(	UT_StringArray &	list,
		bool	english = true
	)		const

int OP_OperatorTable::getOperators	(	OP_OperatorList &	list,
		OP_Network *	net = 0,
		bool	filterhidden = false
	)		const

unsigned OP_OperatorTable::getOperatorStatus

(

OP_Operator *

op

)

const

const char* OP_OperatorTable::getOpFromAlias

(

const char *

alias

)

const

void OP_OperatorTable::getOpHidden

(

UT_StringArray &

opnames

)

const

OP_OpTypeId OP_OperatorTable::getOpTypeID

(

)

const

static const char* OP_OperatorTable::getOpTypeNamespaceHierarchyPref ( )

static

Obtains the value of the environment variable used to construct the hierarchy.

static unsigned OP_OperatorTable::getPermissionMask ( const OP_Operator *  op )

static

const char* OP_OperatorTable::getPreferredOperatorName	(	const char *	opname,
		const UT_StringArray *	scope_network_stack
	)

Obtains the preferred operator name that matches the given op_name. Any name component included in the op_name must match the returned op type name, and any component not present in op_name is assumed to match the returned op type. For example 'hda' will match any scope, namespace, or version, while 'userA::hda' will match any scope and version, but the namespace must be 'userA'. For global namespace use '::hda' and for versionless opname use 'hda::'. If the scope_network_stack is also given (ie, non-null) then the returned opname must match one of the scopes listed in that array too. Returns the name of the highest precedence operator that matches the given op_name.

OP_Operator* OP_OperatorTable::getPrimarySubnetOperator ( )

inline

Definition at line 68 of file OP_OperatorTable.h.

const char* OP_OperatorTable::getScriptedSubnetIndex

(

)

const

const UT_String& OP_OperatorTable::getScriptPath ( ) const

inline

Definition at line 119 of file OP_OperatorTable.h.

unsigned OP_OperatorTable::getStatus

(

)

const

int OP_OperatorTable::getUniqueOpTypeID ( ) const

inline

Definition at line 110 of file OP_OperatorTable.h.

bool OP_OperatorTable::hasSpecificOpDefaultColor

(

const UT_StringRef &

optype

)

const

bool OP_OperatorTable::hasSpecificOpDefaultShape

(

const UT_StringRef &

optype

)

const

static void OP_OperatorTable::initializeOpThemes ( )

static

Called once all basic operator types are loaded to call the python code which will initialize node color and shape themes.

bool OP_OperatorTable::isOpDeprecated

(

const char *

opname

)

const

bool OP_OperatorTable::isOpExcluded

(

const char *

opname

)

const

bool OP_OperatorTable::isOpExperimental

(

const UT_StringRef &

opname

)

const

bool OP_OperatorTable::isOpHidden

(

const char *

opname

)

const

bool OP_OperatorTable::loadDSO

(

const char *

dso_file

)

bool OP_OperatorTable::loadScriptOperator	(	const char *	opname,
		UT_IStream &	is,
		OP_OTLLibrary *	addToLib
	)

static bool OP_OperatorTable::neverReuseScriptOperatorCallback ( const OP_ScriptOperator *  script_operator, const OP_OTLDefinition &  new_definition  )

static

bool OP_OperatorTable::nodeNameImpliesType	(	OP_Operator *	op,
		const UT_String &	node_name
	)		const

Returns true if the provided node name is "close enough" to the operator type name, english name, or first name to imply what the operator type is.

void OP_OperatorTable::notifyUpdateTableSinksOfUpdate

(

)

Examples:

VOP/VOP_CustomContext.C.

void OP_OperatorTable::outputOpAliases

(

std::ostream &

os

)

const

void OP_OperatorTable::outputOpDefaultColors

(

std::ostream &

os

)

const

void OP_OperatorTable::outputOpDefaultShapes

(

std::ostream &

os

)

const

void OP_OperatorTable::outputOpDeprecated

(

std::ostream &

os

)

const

void OP_OperatorTable::outputOpExcluded

(

std::ostream &

os

)

const

void OP_OperatorTable::outputOpFirstNames

(

std::ostream &

os

)

const

void OP_OperatorTable::outputOpRenames

(

std::ostream &

os

)

const

void OP_OperatorTable::removeOperator

(

OP_Operator *

op

)

void OP_OperatorTable::requestReload

(

)

void OP_OperatorTable::runDSOInstall

(

)

void OP_OperatorTable::setDefaultType

(

const char *

type

)

void OP_OperatorTable::setDefaultWireStyle

(

const UT_StringHolder &

wirestyle

)

static void OP_OperatorTable::setLoadDSOFlag ( int  i )

inlinestatic

Definition at line 238 of file OP_OperatorTable.h.

bool OP_OperatorTable::setOpAlias	(	const char *	optype,
		const char *	alias,
		std::ostream *	err = nullptr
	)

bool OP_OperatorTable::setOpDefaultColor	(	const UT_StringHolder &	optype,
		const UT_Color &	clr,
		std::ostream *	err = nullptr
	)

bool OP_OperatorTable::setOpDefaultShape	(	const UT_StringHolder &	optype,
		const UT_StringHolder &	shape,
		std::ostream *	err = nullptr
	)

bool OP_OperatorTable::setOpDeprecated	(	const char *	opname,
		const char *	version,
		const char *	replacement = 0,
		std::ostream *	err = nullptr
	)

bool OP_OperatorTable::setOpFirstName	(	const char *	type,
		const char *	firstname,
		std::ostream *	err = nullptr
	)

bool OP_OperatorTable::setOpRename	(	const char *	optype,
		const char *	newname,
		std::ostream *	err = nullptr
	)

void OP_OperatorTable::setScriptCreator	(	OP_ScriptCreatorFunc	creator_func,
		OP_ScriptCanReuseFunc	reuse_func
	)

void OP_OperatorTable::sortOperators	(	OP_OperatorList &	list,
		OP_Operator::OP_OperatorCompare	method = OP_Operator::OP_COMPARE_GEN_NAME
	)

Friends And Related Function Documentation

friend class OP_UpdateTableSink

friend

Definition at line 370 of file OP_OperatorTable.h.

---

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

• OP/OP_OperatorTable.h