16 #ifndef __OP_Operator_h__
17 #define __OP_Operator_h__
49 #define ENGLISH_NAME "englishname"
50 #define VOPNET_TAB_MENU_FLAG_NAME "tabmenuflag"
78 class OP_EventScriptPathCache;
81 #define OP_FLAG_NETWORK 0x01
82 #define OP_FLAG_GENERATOR 0x02
83 #define OP_FLAG_UNORDERED 0x04
84 #define OP_FLAG_SCRIPTDEF 0x08
85 #define OP_FLAG_MANAGER 0x10
86 #define OP_FLAG_PRIMARYSUBNET 0x20
87 #define OP_FLAG_OUTPUT 0x40
88 #define OP_FLAG_EDITABLE_INPUT_DATA 0x80
91 #define OP_MAX_INPUT_LABELS 4
94 #define OP_MULTI_INPUT_MAX 9999
98 #define OP_MAX_INDIRECT_INPUTS 500
101 #define OP_MULTI_OUTPUT_MAX 9999
119 virtual void saveToDialogScript(std::ostream &os)
const = 0;
147 unsigned min_sources,
148 unsigned max_sources = 9999,
151 const char **inputlabels = 0,
153 const char *tab_submenu_path = 0);
159 unsigned min_sources,
160 unsigned max_sources = 9999,
163 const char **inputlabels = 0,
165 const char *tab_submenu_path = 0);
171 const char *child_table_name,
172 unsigned min_sources,
173 unsigned max_sources = 9999,
176 const char **inputlabels = 0,
178 const char *tab_submenu_path = 0);
184 const char *child_table_name,
185 unsigned min_sources,
186 unsigned max_sources = 9999,
189 const char **inputlabels = 0,
191 const char *tab_submenu_path = 0);
196 int getNumActiveNodes()
const;
197 OP_Node *getActiveNode(
int i)
const;
198 void nodeDestroyed(
OP_Node *node);
209 {
return myOTLDefinition.getName(); }
216 { myOTLDefinition.getTableAndName(name); }
218 { myOTLDefinition.getTableAndName(name); }
221 {
return myOTLDefinition.getLabel(); }
222 virtual UT_Color getDefaultColor()
const;
228 virtual bool getOpHelpURL(
UT_String &url);
229 virtual bool getOpTabSubMenuPath(
UT_String &tab_submenu_path);
230 void setOpTabSubMenuPath(
const char *tab_submenu_path);
235 bool hasPotentialEditableSubNodes();
238 void getDiveTarget(
UT_String &divetarget);
239 void getDescriptiveParmName(
UT_String &descrparm);
240 void getDefaultState(
UT_String &statename);
241 void getFunctionName(
UT_String &function_name);
242 void getSecondaryFunctionsNames(
255 void getHelpFileDirAndName(
UT_String & script_dir,
258 void getDefinitionSource(
UT_String &defsource)
const;
261 { ourLastHelpOp = 0; }
262 OP_Node *getDefiningNetwork()
const;
268 {
return myOTLDefinition.getIndexPath(); }
270 {
return myOTLDefinition.getIndexFile(); }
272 {
return myOTLDefinition.getIsSubnet(); }
278 {
return myVexContextType; }
280 {
return myRslContextType; }
282 {
return myOTLDefinition.getModTime(); }
284 {
return myOTLDefinition.getIsDummyDefinition(); }
288 {
return myOTLDefinition.getIsPython(); }
290 { myOTLDefinition.setIsPython(is_python); }
294 {
return myOTLDefinition.getExtraInfo(); }
296 {
return myOTLDefinition.getExtraInfoBuffer(); }
301 {
return myOTLDefinition; }
305 { myOTLLibrary = library; }
307 {
return myOTLLibrary; }
311 virtual bool hasSectionData(
const UT_StringRef &name)
const;
313 bool hasContentsSection();
317 {
return getOTLIndexFilePtr(check_timestamp).get(); }
330 virtual void clearOTLIndexFile();
336 FS_IndexFile *createOTLIndexFile(
bool reservedsectionsonly,
341 void getDefinitionSectionName(
UT_String §name)
const;
355 const char *opdef_or_oplib,
356 const char *section_name)
const;
358 const char *opdef_or_oplib,
364 void listContainedOperators(
UT_StringSet &contents_list);
368 const char *getIconName()
const;
369 void setIconName(
const char *name);
370 void setDefaultIconName();
373 {
return myOTLDefinition.getMinInputs(); }
375 {
return myOTLDefinition.getMaxInputs(); }
383 { myOTLDefinition.setNumOrderedInputs(inputs); }
385 {
return myOTLDefinition.getNumOrderedInputs(); }
398 void setLegacyInputsMap(
const char *map);
399 void getLegacyInputsMap(
UT_String &map)
const;
407 return isManagementOp()
409 : myOTLDefinition.getMaxOutputs();
414 virtual bool hasLoadedParmTemplates()
const;
415 virtual int updateParmTemplates();
418 virtual void forceUpdateParmTemplates();
444 {
return myBaseOverrideLayout; }
447 {
return myObsoleteTemplates; }
449 { myObsoleteTemplates = tmpl; }
455 bool getOverrideLayoutParmTemplateFile(
477 bool isCustomDSO()
const;
503 return myCreatingNode;
507 return myChangingParmTemplates;
511 return myLoadingContentsSectionCount > 0;
515 myLoadingContentsSectionCount++;
519 myLoadingContentsSectionCount--;
527 return getNumActiveNodes() > 0 || myRefreshingLib;
531 OP_COMPARE_GEN_ENGLISH = 0,
532 OP_COMPARE_GEN_NAME = 1,
533 OP_COMPARE_ENGLISH = 2,
539 virtual int compareOperator(
const OP_Operator *other,
548 {
return myInputNames; }
551 {
return myInputLabels; }
552 bool getInputIsReference(
int idx)
const;
554 {
return myInputReferences; }
555 virtual bool allowsInputNameEditing()
const;
560 {
return myOutputLabels; }
563 unsigned getPermissionMask()
const;
571 virtual bool wantsParametersAnimatable()
const;
574 virtual bool wantsInputEditor()
const;
577 virtual bool wantsParmOrderEditor()
const;
580 virtual bool wantsOutputNameEditor()
const;
583 virtual bool wantsParentInputs()
const;
587 {
return myInputDataEditorConfig; }
590 { myInputDataEditorConfig = config; }
591 void setInputDataEditorConfig(
596 virtual const char *getOperatorShortHelpString();
601 virtual void getOperatorSpecificInfoText(
int verbose,
613 virtual void fillInfoTreeOperatorSpecific(
UT_InfoTree &tree,
617 static int loadFromOpType(
const char *fname,
const char *savedir);
618 static int uninstallOpType(
const char *
path,
619 const char *tablename,
const char *opname,
620 const char *indexpath,
const char *indexfile);
622 static void removeHelpCardOverrides(
UT_FileUtil *fu,
623 const char *
path,
const char *tablename,
624 const char *opname,
int flags);
626 const char *
path,
const char *tablename,
627 const char *opname,
int flags);
629 const char *
path,
const char *tablename,
630 const char *opname,
int flags);
632 const char *
path,
const char *tablename,
633 const char *opname,
int flags);
635 static void getDefaultIconName(
const char *tablename,
642 const char *getTableName()
const;
658 void setDefinition(
const char *def);
660 void setEnglish(
const char *english);
664 void informOfTabMenuFlagChange();
668 virtual void setName(
const char *name);
679 void setMinInputs(
int inputs);
680 void setMaxInputs(
int inputs);
681 void setIsGenerator(
bool isgen);
685 void updatePresetInfo();
705 bool full_path =
false,
707 bool *node_deleted_by_script =
nullptr);
713 {
return myPythonModuleDicts; }
715 {
return myHasLoadedPythonModuleSection; }
716 void loadPythonModuleSection(
bool force=
false);
719 {
return myViewerStateModuleDicts; }
721 {
return myHasLoadedViewerStateModuleSection; }
722 void loadViewerStateModuleSection(
bool force=
false);
725 {
return myViewerHandleModuleDicts; }
727 {
return myHasLoadedViewerHandleModuleSection; }
728 void loadViewerHandleModuleSection(
bool force=
false);
731 void clearEventScriptPathCache();
734 void getCachedEventScriptPaths(
737 bool only_nonempty)
const;
743 {
return myIsThreadSafe; }
748 { myIsThreadSafe = is_safe; }
750 static const char *getCurrentPythonModuleKey();
751 static const OP_Operator *mapSecurityKeyToOperator(
const char *key);
752 static void registerPythonModuleKeyClient(
void *client);
753 static bool verifyPythonModuleKeyClient(
775 void notifyUpdateTemplatesSinksOfUpdate();
777 void notifyUpdateTemplatesSinksOfDelete();
780 void notifyActiveNodesOfTemplatesUpdate();
789 { myDescriptiveParmName = parm; }
791 void dirtyParmTemplatesLoaded();
793 virtual bool loadParmTemplatesSubclass();
796 bool loadAndCreateLayoutParmTemplates(
803 int base_controls_switcher_index,
804 int base_controls_insert_index,
805 int base_controls_switcher_page_num,
807 bool hide_default_parms);
847 void getContentSectionTypeNames(
UT_IStream &is,
851 static void handleDefiningNetworkChange(
OP_Node *caller,
863 bool &node_deleted_by_script,
865 void runHscriptEventScript(
867 const char *script_path,
870 const char *extra_args);
871 void runPythonEventScript(
873 const char *script_path,
875 const char *kwargs_dict,
877 const char *script_source);
879 void formatErrorSource(
886 OP_EventScriptPathCache *getEventScriptPathCache();
890 void loadOverrideLayoutParmTemplates();
892 void ensureParmTemplatesLoaded();
904 OP_EventScriptPathCache *myEventScriptPathCache;
906 bool myChangingParmTemplates;
907 bool myRefreshingLib;
908 bool myDestroyingSelf;
909 int myLoadingContentsSectionCount;
914 bool myHasLoadedPythonModuleSection;
917 bool myHasLoadedViewerStateModuleSection;
920 bool myHasLoadedViewerHandleModuleSection;
933 friend class SHOP_ScriptOperator;
937 static int ourLastHelpLevel;
939 static bool ourHelpIsHtml;
947 { removeAllTemplatesSinks(); }
949 virtual void templatesUpdated(
OP_Operator *op) = 0;
951 { removeUpdateTemplatesSink(op); }
957 op->addUpdateTemplatesSink(
this);
958 myOperators.append(op, 1);
962 return myOperators.find(op) >= 0;
967 op->removeUpdateTemplatesSink(
this);
968 myOperators.findAndRemove(op);
972 for(
int i = myOperators.entries(); i --> 0; )
973 removeUpdateTemplatesSink(myOperators(i));
unsigned maxInputs() const
virtual ~OP_SpecificData()
GLboolean GLboolean GLboolean b
unsigned minInputs() const
PRM_ScriptImports * myLayoutParmImports
int getVersion(int version)
GT_API const UT_StringHolder filename
virtual ~OP_UpdateTemplatesSink()
bool getScriptIsSubnet() const
UT_StringArray myInputLabels
const OP_OTLDefinition & getOTLDefinition() const
void setIsThreadSafe(bool is_safe)
void getTableAndName(UT_String &name) const
bool shouldPreserve() const
static void clearOperatorHelpCache()
CH_LocalVariable * myVariables
bool getScriptIsRsl() const
PRM_Template * myBaseOverrideLayout
GLsizei const GLchar *const * path
#define OP_FLAG_NETWORK
Flags passed to the contructor:
const UT_StringHolder & getExtraInfo() const
VEX_ContextType getVexContextType() const
int getVariableCount() const
OP_OTLDefinition myOTLDefinition
virtual void getRefreshPICommands(OP_Node *, std::ostream &)
bool isManagementOp() const
#define OP_FLAG_GENERATOR
void removeAllTemplatesSinks()
void removeUpdateTemplatesSink(OP_Operator *op)
GLuint const GLchar * name
void setNumOrderedInputs(int inputs)
PY_EvaluationContext * getViewerHandleModuleDicts()
UT_StringArray myInputNames
UT_StringHolder myChildTableName
#define OP_FLAG_PRIMARYSUBNET
const UT_StringArray & getOutputLabels() const
bool hasLoadedViewerStateModuleSection() const
UT_Array< bool > myInputReferences
const UT_StringHolder & getName() const
virtual void updateExtraInfoBuffer(OP_ExtraInfoBuffer &b) const
bool myHasContentsSection
bool isScriptedOp() const
virtual bool getHDKHelp(UT_String &) const
const OP_ExtraInfoBuffer & getExtraInfoBuffer() const
const UT_StringHolder & getIndexFile() const
FS_IndexFile * getOTLIndexFile(bool check_timestamp=true)
#define OP_FLAG_SCRIPTDEF
virtual const OP_SpecificData * getOpSpecificData() const
static int operatorNameCompare(const OP_Operator *a, const OP_Operator *b)
std::shared_ptr< T > UT_SharedPtr
Wrapper around std::shared_ptr.
bool getIsPrimarySubnetType() const
bool isCreatingNode() const
bool hasLoadedViewerHandleModuleSection() const
int numOrderedInputs() const
GLboolean GLboolean GLboolean GLboolean a
void setInputDataEditorConfigEx(const OP_InputDataEditorConfigEx &config)
UT_DeepString myTabSubmenuPath
PRM_Template * myLayoutParmTemplates
bool hasLoadedPythonModuleSection() const
bool isChangingParmTemplates() const
bool operator<(const GU_TetrahedronFacet &a, const GU_TetrahedronFacet &b)
PY_EvaluationContext * getViewerStateModuleDicts()
void setScriptIsPython(bool is_python)
UT_StringArray myOutputLabels
time_t getModTime() const
bool isThreadSafe() const
const UT_StringArray & getInputLabels() const
Accessing operator inputs name, label, and reference flag.
RSL_ContextType getRslContextType() const
void setDescriptiveParmName(const UT_StringHolder &parm)
void setObsoleteTemplates(PRM_Template *tmpl)
PRM_Template * getBaseOverrideLayoutParmTemplates()
void beginLoadingContentsSectionForNode()
OP_Node *(* OP_Constructor)(OP_Network *, const char *, OP_Operator *)
GT_API const UT_StringHolder version
PRM_Template * myObsoleteTemplates
A map of string to various well defined value types.
void getTableAndName(UT_WorkBuffer &name) const
const UT_StringArray & getInputNames() const
Accessing operator inputs name, label, and reference flag.
Parameters for OP_Node::fillInfoTree()/OP_Node::fillInfoTreeNodeSpecific()
UT_ValArray< OP_Operator * > OP_OperatorList
virtual unsigned maxOutputs()
bool hasTemplatesSink(OP_Operator *op)
#define OP_FLAG_UNORDERED
PRM_Template * myParmTemplates
void endLoadingContentsSectionForNode()
VEX_ContextType myVexContextType
OP_OTLLibrary * getOTLLibrary()
CH_LocalVariable * getVariables() const
virtual OP_SpecificData * getOpSpecificData()
const UT_StringHolder & getIndexPath() const
bool getScriptIsVex() const
RSL_ContextType
RenderMan shader context types.
#define OP_FLAG_EDITABLE_INPUT_DATA
bool myParmTemplatesLoaded
UT_SharedPtr< PRM_ScriptPage > myOverrideLayoutParmScriptPage
bool getIsDummyDefinition() const
virtual void operatorDeleted(OP_Operator *op)
const UT_Array< bool > & getInputAreReferences() const
Accessing operator inputs name, label, and reference flag.
PRM_ScriptImports * myImports
virtual PRM_Template * getObsoleteTemplates()
const OP_InputDataEditorConfigEx & getInputDataEditorConfigEx() const
PY_EvaluationContext * getPythonModuleDicts()
virtual const PRM_Template * getBaseParmTemplates()
void addUpdateTemplatesSink(OP_Operator *op)
bool getScriptIsPython() const
const UT_StringHolder & getEnglish() const
OP_InputDataEditorConfigEx myInputDataEditorConfig
RSL_ContextType myRslContextType
bool hasNodeLoadingContentsSection() const
GLenum const void * paths
bool unorderedInputs() const
void setOTLLibrary(OP_OTLLibrary *library)
bool hasEditableInputData() const