OP_Node Class Reference

#include <OP_Node.h>

Inheritance diagram for OP_Node:

List of all members.

Public Types

enum RampError { RAMP_ERR_SUCCESS, RAMP_ERR_NOT_FOUND, RAMP_ERR_FIRST_OR_LAST_KEY }

Public Member Functions

OP_Network * getParent () const

OP_Network * getRootCompiledParent () const

virtual OP_Network * getParentNetwork () const

Returns the network that is our parent.

bool getIsContainedBy (const OP_Node *testparent) const

const UT_String & getNetName () const

Return the name of this node's parent.

virtual OP_OpTypeId getOpTypeID () const =0

virtual const char * getOpType () const =0

virtual OP_ItemType getItemType () const

Our children should implement this and return what type of item they are.

const UT_String & getDelScript (void) const

Obtain the node's script which is called when it is being deleted.

bool setDelScript (const char *str)

bool setXYWithBoundsChecks (fpreal x, fpreal y)

void pickRequest (int shift)

bool notifyVarChange (const char *varname, OP_NodeList *changed_nodes=NULL)

virtual int getNchildren () const

virtual OP_Node * getChild (const char *name, int *hint=0) const

virtual OP_Node * getChild (int index) const

void getPickedChildren (OP_NodeList &picked, bool include_hidden=false) const

void getAllChildren (OP_NodeList &children) const

virtual OP_Node * matchChild (const char *pattern, OP_Node *prevmatch=0, const char *optype=0, int casesensitive=0) const

virtual OP_Node * matchChildBackwards (const char *pattern, OP_Node *prevmatch=0, const char *optype=0, int casesensitive=0) const

virtual OP_Network * createProxyRefNode (const char *path)

int getUniqueId () const

bool expandGroupPattern (const char *pattern, UT_String &result, bool expandToFullPaths=false)

bool patternContainsBundle (const char *pattern, const OP_Bundle *bundle) const

bool patternContainsGroup (const char *pattern, const OP_Group *group) const

virtual int isManager () const

virtual int isManagementNode () const

bool isEffectivelyAManagementNode () const

virtual int isSubNetwork (bool includemanagementops) const

virtual int isNetwork () const

virtual int isInSubNetwork () const

bool isProxyRefNode () const

void setProxyRefNode (bool f)

int isNetworkWithKids () const

virtual int isVex () const

OP_Bundle * getParmBundle (const char *parm_name, int vector_index, UT_String &pattern, OP_Network *creator, const char *filter)

void markBundleRefsAsUnused ()

void cleanUnusedBundleRefs ()

void cleanAllBundleRefs ()

virtual bool bundleChanged (const OP_Bundle *bundle)

void touchBundleParm (const char *name)

void touchBundleParm (int parm_index)

virtual int getDandROpsEqual ()

virtual int updateDandROpsEqual (int=1)

int isAncestor (const OP_Node *node, int checkextra=1) const

bool isInputAncestor (const OP_Node *parent, bool check_extra=true) const

bool isParentAncestor (const OP_Node *parent) const

const char * getInfoText (OP_Context &context, OP_NodeInfoParms &parms)

virtual void getNodeSpecificInfoText (OP_Context &context, OP_NodeInfoParms &parms)

OP_Node * findNode (const char *path) const

Uses the path (eg. "/obj/geo1") to find a node in our heirarchy.

OP_Node * findSubNode (const char *path) const

virtual OP_NetworkBox * findNetworkBox (const char *)

virtual OP_PostIt * findPostItNote (const char *)

virtual OP_NetworkBoxItem * findItem (const char *const_path, OP_ItemTypeMask item_type=OP_ITEMTYPE_ALL)

SOP_Node * getSOPNode (const char *path, int addextra=0) const

COP2_Node * getCOP2Node (const char *path, int addextra=0) const

POP_Node * getPOPNode (const char *path, int addextra=0) const

DOP_Node * getDOPNode (const char *path, int addextra=0) const

ROP_Node * getROPNode (const char *path, int addextra=0) const

virtual OP_Node * castToOPNode ()

virtual const OP_Node * castToOPNode () const

virtual void getPathWithSubnet (UT_String &str) const

Returns the path of this node relative to its getCreator().

void getRelativePathTo (const OP_Node *base_node, UT_String &result) const

Returns the path of this node relative to 'base_node'.

void completePath (const char *prefixpath, UT_String &completepath) const

virtual CH_Channel * getTrackChannel (const char *name)

virtual bool findParmFromTrack (fpreal t, const char *trackname, OP_NodeParmRefCycle &cycle, OP_Node *&node, PRM_Parm *&parm, int &vecidx)

virtual void evaluateBatchParms (PRM_BatchList &list, fpreal now)

void globNodes (const char *pat, UT_String *expand, UT_PtrArray< OP_Node * > *list=0, OP_GlobContext *context=0, const char *prefix=" ")

CH_Channel * findChannel (const char *path)

void globChannels (const char *, UT_String &expand, OP_GlobContext *context=0, const char *prefix=" ") const

void globChannels (const char *pattern, CH_ChannelList &clist, OP_GlobContext *context=0, OP_Node *dependent=0)

void globChanRefs (const char *pattern, CH_ChannelRefList &list, OP_GlobContext *context=0, OP_Node *dependent=0)

int globParms (const char *pattern, fpreal t, UT_RefArray< opParmData > &list, OP_GlobContext *context=0, OP_Node *dependent=0, int calc_value=1)

void globNodeParms (const char *pattern, fpreal t, UT_RefArray< opParmData > &list, OP_GlobContext *context, OP_Node *dependent, int calc_value, bool animated_only)

void globNodeChannels (const char *pattern, CH_ChannelList &list, OP_GlobContext *context, int *parm_start=NULL, UT_IntArray *parm_indices=NULL, UT_IntArray *parm_sub_indices=NULL) const

void globNodeChanRefs (const char *pattern, CH_ChannelRefList &list, OP_GlobContext *context, int *parm_start=NULL, UT_IntArray *parm_indices=NULL, UT_IntArray *parm_sub_indices=NULL) const

virtual void globNetworkBoxes (const char *pat, UT_String *expand, UT_PtrArray< OP_NetworkBox * > *list=0, OP_GlobContext *glob_context=0, const char *prefix=" ")

virtual void globPostIts (const char *pat, UT_String *expand, UT_PtrArray< OP_PostIt * > *list=0, OP_GlobContext *glob_context=0, const char *prefix=" ")

int getAllChannels (CH_ChannelList &list, int scoped=0)

virtual void opChanged (OP_EventType reason, void *data=0)

virtual bool opShouldHandleChange (OP_EventType reason)

virtual void referencedParmChanged (int pi)

virtual void forceRecook (bool evensmartcache=true)

virtual void reloadExternalFiles ()

virtual unsigned needToCook (OP_Context &context, bool queryonly=false)

virtual bool cook (OP_Context &context)

bool parallelCook (OP_Context &context)

OP_TaskState & taskState ()

const OP_TaskState & taskState () const

virtual OP_ERROR pubCookInputGroups (OP_Context &context, int alone=0)

void bumpVersionParm ()

int cookParmsModified () const

virtual int getDataClass () const

virtual void getXformOrder (UT_XformOrder &xord, CH_Channel *chp)

virtual OP_DATA_TYPE getCookedDataType () const =0

virtual void * getCookedData (OP_Context &)

virtual void deleteCookedData ()=0

virtual int saveCookedData (ostream &os, OP_Context &, int binary=0)=0

virtual bool loadCookedData (UT_IStream &is, const char *path=0)

virtual int saveCookedData (const char *filename, OP_Context &)=0

virtual int getRelativeTransform (OP_Node &to, UT_Matrix4 &xform, OP_Context &context)

virtual int getRelativeTransform (OP_Node &to, UT_DMatrix4 &xform, OP_Context &context)

virtual int getRelativeCaptureTransform (OP_Node &to, UT_Matrix4 &xform, OP_Context &context)

virtual int getRelativeCaptureTransform (OP_Node &to, UT_DMatrix4 &xform, OP_Context &context)

virtual void getRotations (fpreal t, fpreal &rx, fpreal &ry, fpreal &rz)

virtual int getWorldTransform (UT_DMatrix4 &xform, OP_Context &)

virtual int getIWorldTransform (UT_DMatrix4 &xform, OP_Context &)

int getWorldTransform (UT_Matrix4 &xform, OP_Context &)

int getIWorldTransform (UT_Matrix4 &xform, OP_Context &)

void addTransformError (const OP_Node &node, const char *label=0) const

virtual bool getBoundingBox (UT_BoundingBox &box, OP_Context &)

virtual const char * getInternalOpTable () const

virtual OP_Operator * getInternalOperator () const

virtual const char * inputLabel (unsigned idx) const

virtual const char * outputLabel (unsigned idx) const

virtual const char * inputConnectorLabel (unsigned idx)

virtual int isRefInput (unsigned) const

bool hasRefOutputs (bool recurse_on_implicits=false) const

virtual int getAuxInput () const

int setLock (int state, int saveundo=1)

int getSoftLock () const

int getHardLock () const

int getLock () const

int getNetworkLock (bool relaxedlockcheck=false, const OP_Node *inputNode=NULL) const

virtual int setModelLock (int on_off, void *modeler=0, int allow_softlock_promotion=0, UT_Undo *undo=0)

int getModelLock () const

int setUnload (int on_off)

int getUnload () const

virtual bool isLoaded () const

virtual bool unloadData ()

void takeActivateFlag (uchar flag, bool enable=true, bool send_flag_event=true)

void takeDeactivateFlag (uchar flag)

bool takeIsActiveFlag (uchar flag) const

void setHasTakeData (int onoff)

bool canAccessFlag (unsigned mask, uchar flag) const

virtual int setPicked (int on_off, bool propagate_parent_event=true)

int setEditPicked (int on_off, bool propagate_parent_event=true)

void setAutoscope (bool on_off)

bool isAutoscope ()

int setCurrent (int on_off)

int setExpose (int on_off)

int setBypass (int on_off)

int setTemplate (int on_off)

int setFootprint (int on_off)

int setXray (int on_off)

int setDisplay (int on_off)

int setRender (int on_off)

int setHighlight (int on_off)

int setModified (int on_off)

int setSaveBypass (int on_off)

int setSaveData (int on_off)

virtual int setPickable (int on_off)

virtual int setAudio (int on_off)

virtual int setExport (int on_off)

virtual int setDebug (int on_off)

void userSetTemplate (bool onoff)

void userSetSelectableTemplate (bool onoff)

virtual int setFlag (char tag, int on_off)

virtual int getFlag (char tag) const

virtual int getPicked () const

virtual int getEditPicked () const

int getCurrent () const

int getDisplay () const

int getRender () const

int getHighlight () const

int getBypass () const

int getTemplate () const

int getFootprint () const

int getXray () const

int getExpose () const

int getModified () const

int getSaveBypass () const

int getSaveData () const

virtual int getHasTakeData () const

virtual int getPickable ()

virtual int getAudio () const

virtual int getExport () const

virtual int getDebug () const

OP_Node * getPickableSelfOrParent ()

virtual void setExtraFlag (char, int)

virtual void setExtraFlags (int axis)

int setCompress (int on_off)

int getCompress () const

void setCurrentAndPicked ()

virtual bool setVisible (int onoff)

virtual bool getVisible () const

virtual const OP_NodeFlags & flags () const

virtual OP_NodeFlags & flags ()

virtual void getSaveFlagsString (UT_String &cmd, const char *flags, bool save_to_hip) const

virtual void getPreParmSaveFlagsString (UT_String &cmd) const

virtual void getPostParmSaveFlagsString (UT_String &cmd) const

int hasOpInterest (void *data, OP_EventMethod m) const

void addOpInterest (void *data, OP_EventMethod m)

void removeOpInterest (void *data, OP_EventMethod m)

int isBeingDeleted () const

void setNodeBeingDeleted (int beingdeleted)

void setConnectionsChanging (bool value)

virtual unsigned minInputs () const

Minimum inputs that must be connected to a node for it to cook.

virtual unsigned maxInputs () const

Maximum inputs that can be connected to a node.

virtual unsigned getNumVisibleInputs () const

virtual unsigned orderedInputs () const

virtual unsigned maxOutputs () const

virtual unsigned getNumVisibleOutputs () const

bool hasUnorderedInputs () const

Returns true if the operator type says we have unordered inputs.

virtual unsigned nInputs () const

unsigned nConnectedInputs () const

unsigned getActiveInputIndex () const

void setActiveInputIndex (unsigned idx)

OP_Node * getInput (unsigned idx, bool mark_used=false) const

Returns the node connected to a particular input (may be null).

int getConnectedInputIndex (int startAt=-1) const

int getNthConnectedInput (int n) const

Gets the index of the Nth non-null connection to this node.

virtual void getParallelInputs (OP_Context &context, OP_NodeList &nodes) const

virtual OP_ERROR setInput (unsigned idx, OP_Node *op, unsigned outputIdx=0)

Sets a given input to connect to an output of a particular node.

virtual OP_ERROR setIndirectInput (unsigned idx, OP_InputIndirect *input)

Connects an input to an indirect input of our parent subnet.

virtual OP_ERROR setInputReference (unsigned idx, const char *label, int keeppos, unsigned outputIdx=0)

Connects an input to particular node by name in the network.

int whichInputIs (const OP_Node *who) const

int whichInputIs (const OP_InputIndirect *who) const

Returns the index of the first connection of an indirect input.

int whichInputIs (const OP_InputIndirect *whoi, int cnt) const

int whichOutputIs (OP_Node *target_node, int input_on_target_node)

int whichInputIs (OP_Node *source_node, int counter)

void consolidateInputs ()

virtual void clearUnreferencedInputs ()

virtual OP_Input * getInputReference (unsigned idx, int grow=1)

virtual OP_Input * getInputReferenceConst (unsigned idx) const

virtual int doDeleteRewire () const

virtual void moveInput (int srcidx, int dstidx, bool forcesubnet=false)

OP_ERROR insertInput (unsigned idx, OP_Node *op, unsigned outputIdx)

OP_ERROR insertIndirectInput (unsigned idx, OP_InputIndirect *input)

DEP_MicroNode & dataMicroNode ()

DEP_MicroNode & flagMicroNode ()

DEP_MicroNode & parmMicroNode (int parm_idx, int vi)

virtual void getOwnedMicroNodes (DEP_MicroNodeList &micronodes)

void propagateDirtyMicroNode (DEP_MicroNode &micronode, OP_EventType reason, void *data, bool send_root_event)

virtual void addExtraInput (OP_Node *op, OP_InterestType type)

void addExtraInput (OP_Node &op, int parm_i, int vec_i)

void addExtraInput (const OP_InterestRef &source_ref)

void addExtraInput (DEP_MicroNode &source_micronode)

void getExtraInputNodes (OP_NodeList &extras, bool remove_duplicates=true, bool data_interest=true, bool parm_interest=true, bool flag_interest=true) const

void getExtraOutputNodes (OP_NodeList &extras, bool remove_duplicates=true, bool data_interest=true, bool parm_interest=true, bool flag_interest=true) const

int getNumExtraInputs () const

void dumpExtraInputs (std::ostream &os, bool as_DOT, int indent_level=0) const

void addGenericOpNameReference (const UT_String &oppath)

void addGenericOpNameReference (const PRM_RefId &ref_id, OP_Node *node)

virtual void rebuildParmDependency (int parm_index)

virtual void clearParmDependency (int parm_index)

void decrementOpReference (int node_id)

virtual void dumpDependencies ()

void dumpOpDependents (OP_Node *ref, int brief, ostream &os)

int countReferences (int op_id)

void getExistingOpReferences (OP_NodeList &refs, bool recurse)

void getExistingOpDependents (OP_NodeList &deps, bool recurse)

const OP_DependencyList & getOpDependents () const

void getParmsThatReference (const char *channame, UT_PtrArray< PRM_Parm * > &parms, UT_IntArray &parmsubidxs)

virtual void inputConnectChanged (int which)

unsigned nOutputs (int outputIdx=-1) const

unsigned nOutputEntries () const

OP_Node * getOutput (unsigned idx, int outputIdx=-1)

const OP_Node * getOutput (unsigned idx, int outputIdx=-1) const

void getNonSubnetOutputs (OP_NodeList &nodes) const

OP_Node * getOutputTowardsNode (const OP_Node *target)

void fillInfoTree (UT_InfoTree &tree, fpreal time)

virtual void fillInfoTreeNodeSpecific (UT_InfoTree &tree, fpreal time)

virtual const char * getDefaultSelectedInfoTreeBranchName () const

virtual OP_ERROR lockInput (unsigned idx, OP_Context &context)

virtual void unlockInput (unsigned idx)

virtual OP_ERROR lockInputs (OP_Context &context)

virtual void unlockInputs (void)

int getCookCount (void) const

void triggerOutputChanged ()

void triggerUIChanged ()

virtual int cookedInputIndex () const

bool setMinimumCacheSize (int min_size)

OP_VERSION getVersionParms () const

virtual bool handleTimeChange (fpreal)

bool isTimeDependent (OP_Context &context)

virtual bool runCreateScript ()

void updateParmsToMatchCurrentUnits ()

virtual void matchOTLDefinition ()

virtual void unmatchOTLDefinition ()

Unmatches (unlocks) the node from the current HDA definition.

const UT_String & getSyncErrors () const

OP_ERROR getSyncErrorLevel () const

Returns the error level generated in our last synchronization attempt.

int getMatchesOTLDefinition () const

Interface to flag that specifies whether or not we match our definition.

int getCanDeviateFromOTLDefinition () const

void setAllChildAssetPermissions (int permission)

bool getIsEditableAssetSubNode () const

void turnOffAllChildExports (void)

bool haveLicenseToAccessContents (OP_Node *opt_specific_child=NULL) const

bool haveLicenseToAccessParentContents () const

bool haveAncestorWithoutFullLicense (bool ignore_self) const

OP_OTLLicenseType getLicense () const

OP_Node * getFirstExecLicenseOnlyAncestor (bool ignore_self=true) const

OP_Node * getLastExecLicenseOnlyAncestor (bool ignore_self=true) const

bool haveCompiledExpressions () const

bool isCompiled () const

void saveWires (ostream &os, const char *name, int dogeneral=0)

void saveOutputWires (ostream &os, const char *name, int dogeneral=0)

virtual void saveIntrinsicCommand (ostream &os, const char *name)

virtual OP_ERROR saveCommand (ostream &os, const char *name, fpreal x, fpreal y, const char *netboxname, const OP_SaveCommandOptions &options)

Writes to 'os' a string of hscript commands to recreate this node.

void saveParameterFlags (ostream &os, const char *name, const char *command, bool(PRM_Parm::*flag_method)(int) const, bool defaultstoo, bool reverse, UT_RefArray< opParmData > *parm_array)

void saveUserDataCommand (ostream &os, const char *node_name, bool omit_version=false)

virtual RampError rampCommand (bool remove, fpreal pos, float rgba[4])

RampError rampCommand (bool remove, fpreal pos, float rgba[4], UT_Ramp &ramp)

virtual bool loadRamp (UT_IStream &is, const char *path=0)

bool loadRamp (UT_IStream &is, UT_Ramp &ramp, const char *path=0)

OP_ERROR saveRamp (ostream &os, UT_Ramp &ramp, const char *name=0, int command=0)

bool getUserData (const char *key, std::string &result)

void setUserData (const char *key, const std::string &data)

bool hasUserData (const char *key)

bool deleteUserData (const char *key)

const UT_Options & userData () const

bool loadUserData (UT_IStream &is, const char *path=NULL)

OP_ERROR saveUserData (ostream &os, const char *path)

PY_OpaqueObject * getCachedPythonObject (const char *key) const

void setCachedPythonObject (const char *key, void *opaque_py_object)

bool deleteCachedPythonObject (const char *key)

const UT_SymbolTable & cachedPythonObjects () const

bool loadExtraInputs (UT_IStream &is, const char *path=0)

void saveOverrides (ostream &os)

void saveOverrides (ostream &os, OP_Node *root, const UT_String &rootpath, bool &added)

void saveChildOverrides (ostream &os, OP_Node *root, const UT_String &rootpath, bool &added)

bool loadOverride (UT_IStream &is)

virtual UT_ErrorSeverity prmCookOverrides (fpreal t, int thread, const char *parm_name, int vec_idx)

virtual bool isParmPendingOverride (const char *parm_name, int vec_idx) const

OP_ERROR cookOverrides (OP_Context &c)

virtual void removeOverrideDestination (OP_Node *)

virtual void removeOverrideDestination (OP_Node *, int)

virtual void executeCommand (const char *command, ostream *out, ostream *err) const

virtual void pushAsPwdAndRunPython (PY_CompiledCode &compiled_code, PY_Result::Type desired_result_type, PY_Result &result, PY_EvaluationContext *context=NULL) const

OP_ERROR executeHscriptScript (UT_String &script, fpreal now)

OP_ERROR executePythonScript (UT_String &script, fpreal now)

void addPythonNodeError (const PY_Result &py_result)

void saveInputs (ostream &os, bool compile_basic)

bool loadInputs (UT_IStream &is, const char *path=0)

void saveNamedInputs (ostream &os, bool compile_basic)

void saveNamedOutputs (ostream &os)

bool loadNamedInputs (UT_IStream &is, const char *path=0)

bool loadNamedOutputs (UT_IStream &is, const char *path=0)

void checkInputs ()

virtual void saveDialogScriptExtraInfo (ostream &os)

virtual void createGalleryEntry (OP_GalleryEntry &entry)

void evalOpPathString (UT_String &val, int pi, int vi, fpreal t, int &op_id, fpreal &op_time, int expanded=1)

void evalOpPathString (UT_String &val, const char *pn, int &pi, int vi, fpreal t, int &op_id, fpreal &op_time, int expanded=1)

virtual int getTranslateParmIndex ()

void resolveInputReferences ()

virtual void clearUndoFlags ()

virtual void setAnyUndoFlag ()

void saveForUndoInput ()

void blockModify (int on_off, int propagate=1)

int isBlockModify (void) const

virtual void propagateEndBlockModify ()

virtual const CL_Clip * getClip (OP_Context *context=0)

void getMotionEffectsNetworkPath (UT_String &path)

const char * getCookDurationString () const

void getCookInfo (UT_String &info) const

Return the cook information as a formatted string.

virtual int getNetOverviewColor (UT_Color &color)

virtual UT_Ramp * getRamp ()

virtual int isCookingRender () const

virtual void setCookingRender (int val)

virtual void clearInterrupted ()

int wasInterrupted () const

void setRenameConflict ()

void setRunningCreateScript (int onoff)

virtual int outputCode (OP_OutputCodeParms &, OP_Context &)

virtual fpreal getTimeTransform (int input, fpreal t)

virtual void getInputRes (int input, fpreal t, const OP_Context &context, OP_Context &input_context)

UT_TokenString & getHashCode (OP_Context &context, int group_mask=1)

virtual UT_TokenString & getParmHashCode (OP_Context &context, int group_mask=1)

virtual int getNumInputsToHash ()

virtual OP_Node * getInputToHash (int i)

void clearHashCodeFlags ()

bool isHashCodeBuilt () const

void builtHashCode (bool b=true)

void buildInputHashCode (UT_TokenString &string, OP_Context &context, int group_mask, int level)

void setCreatorState (const char *s)

const UT_String & getCreatorState () const

void builtExplicitly (int yn)

int wasBuiltExplicitly () const

bool matchesState (const char *state) const

virtual void changeParmTemplate (PRM_Template *new_template)

void ensureInputsAndOutputsAreValid ()

void connectToInputNode (OP_Node &inputnode, int input_idx, int branch_off=0)

virtual int editCallback (CL_Track *track, fpreal t, fpreal newValue)

virtual const CH_LocalVariable * resolveVariable (const char *name)

virtual const CH_LocalVariable * resolveExtraVariableForSyntaxHighlight (const char *name)

virtual void setMapping (int idx, int type, const char *label=0)

virtual int getMapping (int idx, const char *&label) const

virtual int acceptDragDrop (DD_Source &src, const char *label)

virtual int testDragDrop (DD_Source &src)

virtual void getDragDropChoice (DD_Source &src, DD_ChoiceList &c)

bool hasComment () const

bool hasParmsNotAtFactoryDefault () const

bool hasAnimatedParms () const

bool hasChopOverriddenParms () const

bool traverseChildren (bool(*callback)(OP_Node &, void *), void *data, bool recurse_into_subnets)

virtual bool usesFootprint () const

void getExternalReferences (UT_StringArray &reflist, UT_StringArray *nodelist=0, bool from_children_too=true, bool collapse=false, bool check_missing=false, bool show_missing_only=false)

virtual bool getSaveWithVopnets ()

virtual void runDelScript ()

virtual void preDelete ()

virtual DOP_Parent * castToDOPParent ()

virtual const DOP_Parent * castToDOPParent () const

virtual VOP_CodeGenerator * getVopCodeGenerator ()

virtual bool getScriptMaterialInfo (UT_String &mat_info, VOP_ScriptMaterialCodeMapper *mapper)

virtual const char * getOTLSubType ()

bool setChannelAlias (PRM_Parm &parm, int subindex, const char *alias_name)

void disconnectAllInputsOutputs (bool keepSelected, bool forceDisconnectOutputs=false)

void disconnectAllInputs (void)

void disconnectAllOutputs (void)

virtual void notifyParmRenameDependents (const UT_String &chan_name, const UT_String &old_chan_name)

void writeChannel (CH_Channel *channel, ostream &os, const char *name, bool frames)

void writeAllChannels (ostream &os, const char *name, bool frames, bool dochblock, bool dospareparms)

virtual bool triggerParmCallback (PRM_Parm *parmptr, fpreal now, int value, void *data)

virtual int64 getMemUsage (UT_Bool onlythis) const

int64 getExtraInputMemUsage () const

virtual void unscopeChannels (bool recurse)

virtual void setChannelScope (const char *pattern, OP_ScopeOp scope_op, const OP_ScopeOptions &scope_opts)

virtual const UT_String & getItemName () const

virtual bool changeSpareParms (UT_IStream &istream, UT_String &errors)

virtual void spareParmRemoved (const char *parmname)

virtual PRM_ParmList * createObsoleteParmList ()

virtual void resolveAndDeleteObsoleteParmList (PRM_ParmList *&obsolete_parms)

void updateVersionUserData ()

void syncNodeVersionIfNeeded (bool *node_deleted, const char *from_version=NULL, bool update_node_version=false)

virtual void syncNodeVersion (const char *old_version, const char *current_version, bool *node_deleted)

bool setGlobalFloatParam (const char *param, fpreal value, bool *warned)

bool setGlobalStringParam (const char *param, const char *strvalue, bool *warned)

void beginPropagateModification ()

void endPropagateModification ()

virtual void getActiveOperatorsDefinedByOTL (UT_HashTable &active_operators) const

virtual bool hasDifferentMultiInputs () const

virtual bool canCreateNewOpType () const

virtual UT_String * getMaterialIconFilename ()

virtual void setMaterialIconFilename (const char *)

virtual IMG_Raster * getMaterialIconImage ()

virtual bool getMaterialIconAllowRegenerateFlag ()

virtual void setMaterialIconAllowRegenerateFlag (bool)

virtual bool willAutoconvertInputType (int input_idx)

bool isDependentOn (OP_Node *other_node, PRM_Parm *parm)

void setExposeRecursive (bool expose, bool do_inputs, int level=0)

virtual bool getIsVisible (int idx)

bool verifyTemplatesWithParameters () const

OP_Input * getNamedInputReference (const OP_ConnectorId &input_name, bool grow=true)

OP_Input * getNamedInputReferenceConst (const OP_ConnectorId &input_name) const

OP_Node * getNamedInput (const OP_ConnectorId &input_name, bool mark_used=false) const

virtual int getInputFromName (const UT_String &in) const

virtual int getOutputFromName (const UT_String &out) const

virtual void getInputName (UT_String &in, int idx) const

virtual void getOutputName (UT_String &out, int idx) const

int getInputFromUniqueName (const OP_ConnectorId &id) const

int getOutputFromUniqueName (const OP_ConnectorId &id) const

void getUniqueInputName (OP_ConnectorId &id_out, int idx, bool disable_creation=false)

void getUniqueOutputName (OP_ConnectorId &id_out, int idx)

OP_Node * getNamedOutput (unsigned idx, const OP_ConnectorId *output_name=NULL)

const OP_Node * getNamedOutput (unsigned idx, const OP_ConnectorId *output_name=NULL) const

virtual OP_ERROR setNamedInput (const OP_ConnectorId &input_name, OP_Node *op, const OP_ConnectorId *output_name=NULL)

New input functions that use names instead of indices.

virtual OP_ERROR setNamedIndirectInput (const OP_ConnectorId &input_name, OP_InputIndirect *input)

virtual OP_ERROR setNamedInputReference (const OP_ConnectorId &input_name, const char *label, int, const OP_ConnectorId *output_name=NULL)

OP_ERROR insertNamedInput (const OP_ConnectorId &input_name, OP_Node *op, const OP_ConnectorId *output_name)

OP_ERROR insertNamedIndirectInput (const OP_ConnectorId &input_name, OP_InputIndirect *input)

virtual void onCreated (void)

Overriden in VOPs.

virtual bool isOrderedInput (const OP_ConnectorId &input_name) const

OP_ConnectorId whichNamedInputIs (const OP_Node *who) const

OP_ConnectorId whichNamedInputIs (const OP_InputIndirect *who) const

Returns the index of the first connection of an indirect input.

virtual bool willAutoconvertNamedInputType (const OP_ConnectorId &input_name)

TInputsIterator traverseInputs (TInputsIterator *prev_iter)

TInputsIterator traverseConnectedInputs (TInputsIterator *prev_iter)

TInputsIterator getTraverseEndIterator (void)

void gatherInputs (TInputPairs &input_pairs_out)

void gatherOutputs (TOutputPairs &output_pairs_out)

virtual void getAuxInputName (OP_ConnectorId &name_out)

unsigned nOutputsNamed (const OP_ConnectorId *output_name=NULL) const

unsigned getInputsArraySize ()

void getLocalVarNames (UT_StringArray &out_vars)

Retrieve a sorted list of local variables visible to this OP_Node.

void recomputeCompiledHash ()

OBJ_Node * findOBJNode (const char *path) const

SOP_Node * findSOPNode (const char *path) const

POPNET_Node * findPOPNETNode (const char *path) const

POP_Node * findPOPNode (const char *path) const

CHOPNET_Node * findCHOPNETNode (const char *path) const

CHOP_Node * findCHOPNode (const char *path) const

ROP_Node * findROPNode (const char *path) const

SHOP_Node * findSHOPNode (const char *path) const

COP2_Node * findCOP2Node (const char *path) const

COPNET_Node * findCOPNETNode (const char *path) const

VOP_Node * findVOPNode (const char *path) const

VOPNET_Node * findVOPNETNode (const char *path) const

DOP_Node * findDOPNode (const char *path) const

OBJ_Node * castToOBJNode () const

SOP_Node * castToSOPNode () const

POPNET_Node * castToPOPNETNode () const

POP_Node * castToPOPNode () const

CHOPNET_Node * castToCHOPNETNode () const

CHOP_Node * castToCHOPNode () const

ROP_Node * castToROPNode () const

SHOP_Node * castToSHOPNode () const

COP2_Node * castToCOP2Node () const

COPNET_Node * castToCOPNETNode () const

VOP_Node * castToVOPNode () const

VOPNET_Node * castToVOPNETNode () const

DOP_Node * castToDOPNode () const

const UT_String & getComment (void) const

Accessors for this node's comment string.

bool setComment (const char *str)

Accessors for this node's comment string.

virtual const UT_Color * getColor () const

Accessors for this node's color in the network view pane.

virtual bool setColor (const UT_Color &col)

Accessors for this node's color in the network view pane.

virtual void setXY (fpreal x, fpreal y)

Node position/scale is used by the UI.

virtual fpreal getX () const

Node position/scale is used by the UI.

virtual fpreal getY () const

Node position/scale is used by the UI.

virtual fpreal getW () const

Node position/scale is used by the UI.

virtual fpreal getH () const

Node position/scale is used by the UI.

virtual int findString (const char *str, bool fullword, bool usewildcards) const

virtual int changeString (const char *from, const char *to, bool fullword)

OP_CookLock & getCookLock ()

bool lockForCooking (OP_CookLock::Scope &scope)

bool traverseInputs (bool(*callback)(OP_Node &, void *), void *data, bool follow_subnets, bool follow_ref_inputs, bool follow_extra_inputs, OP_InterestType extra_interest_mask=OP_INTEREST_ALL)

bool traverseInputs (bool(*callback)(const OP_Node &, void *), void *data, bool follow_subnets, bool follow_ref_inputs, bool follow_extra_inputs, OP_InterestType extra_interest_mask=OP_INTEREST_ALL) const

virtual int beginVopCodeGeneratorUpdate ()

virtual void endVopCodeGeneratorUpdate (int update_level)

Static Public Member Functions

static const OP_TypeInfo * getOpInfoFromOpTypeID (OP_OpTypeId opid)

static const OP_TypeInfo * getOpInfoFromOpTypeName (const char *name)

static const OP_TypeInfo * getOpInfoFromTableName (const char *name)

static const OP_TypeInfo * getOpInfoFromScriptDir (const char *dir)

static int isValidOpName (const char *s, bool allow_rel_paths=false, bool ignore_node_names_env_var=false)

Set allow_rel_paths to true to accept "." or ".." as valid paths.

static int isValidOpPath (const char *s)

static bool forceValidOpName (UT_String &name)

static OP_Node * lookupNode (int unique_id, bool include_proxy=false)

static int getNumUniqueIds ()

static void getAllNodes (OP_NodeList &nodes)

static bool parallelCook (OP_Context &context, const OP_NodeList &nodes)

Cook the given node list in parallel.

static void repositionOpsMaxY (OP_NodeList &ops, UT_PtrArray< OP_NetworkBox * > &netboxes, fpreal x, fpreal y)

static DEP_MicroNode * getEvalChannelMicroNode (int thread)

static void addExprOpDependency (const char *arg_str, const PRM_RefId &ref_id, OP_InterestType interest_type)

static void addExprOpDependency1From2 (const char *arg_str1, const char *arg_str2, const PRM_RefId &ref_id, OP_InterestType interest_type)

static void addExprOpParmDependency (const char *arg_str, const PRM_RefId &ref_id, OP_InterestType interest_type)

static void changeExprOpRef (const char *arg_str, char *&new_arg, const char *new_fullpath, const char *old_fullpath, const char *old_cwd)

static void changeExprOpRef1From2 (const char *arg_str1, const char *arg_str2, char *&new_arg1, char *&new_arg2, const char *new_fullpath, const char *old_fullpath, const char *old_cwd)

static void changeExprOpParmRef (const char *arg_str, char *&new_arg, const char *new_fullpath, const char *old_fullpath, const char *old_cwd, const char *chan_name, const char *old_chan_name)

static void moveAndUpdateDependencies (const OP_NodeList &src_nodes, const OP_NodeList &dest_nodes)

static void updateChannelPtrs (CH_CollectionList &parents)

static int getGlobbedNodes (OP_Node *cwd, UT_String &holder, const char *pattern, UT_WorkArgs &argv, OP_GlobContext *context)

static int getGlobbedNetworkBoxes (OP_Node *cwd, UT_String &holder, const char *pattern, UT_WorkArgs &argv, OP_GlobContext *context)

static int getGlobbedPostIts (OP_Node *cwd, UT_String &holder, const char *pattern, UT_WorkArgs &argv, OP_GlobContext *context)

static void propagateMatchOTLDefinitionToAncestors (OP_Node *node, bool sync_flag)

Utility function for syncing/unsyncing all uncestor nodes.

static int findOpFramePair (const char *path, int &op_id, fpreal &frame)

static void buildXformOrder (int trs, int xyz, UT_XformOrder &order)

Build a UT_XformOrder out of TRS and XYZ parameter values.

static UT_XformOrder::rstOrder getMainOrder (int trs)

Translate a TRS parameter menu index into the UT_XformOrder type.

static int getMainOrderMenuIndex (UT_XformOrder::rstOrder order)

static UT_XformOrder::xyzOrder getRotOrder (int xyz)

Translate a XYZ parameter menu index into the UT_XformOrder type.

static int getRotOrderMenuIndex (UT_XformOrder::xyzOrder order)

static UT_Vector3R getXformPivot (int trs, fpreal tx, fpreal ty, fpreal tz, fpreal px, fpreal py, fpreal pz)

static UT_Vector3R getPivotParmValue (int trs, fpreal tx, fpreal ty, fpreal tz, fpreal px, fpreal py, fpreal pz)

static void buildXform (int trs, int xyz, float tx, float ty, float tz, float rx, float ry, float rz, float sx, float sy, float sz, float px, float py, float pz, UT_Matrix4 &mat)

static void buildXform (int trs, int xyz, double tx, double ty, double tz, double rx, double ry, double rz, double sx, double sy, double sz, double px, double py, double pz, UT_DMatrix4 &mat)

static void buildXform (int trs, int xyz, float tx, float ty, float tz, float rx, float ry, float rz, float sx, float sy, float sz, float s_xy, float s_xz, float s_yz, float px, float py, float pz, UT_Matrix4 &mat)

static void buildXform (int trs, int xyz, double tx, double ty, double tz, double rx, double ry, double rz, double sx, double sy, double sz, double s_xy, double s_xz, double s_yz, double px, double py, double pz, UT_DMatrix4 &mat)

static void buildXform (int trs, float tx, float ty, float rz, float sx, float sy, float px, float py, UT_Matrix3 &mat)

static void buildXform (int trs, double tx, double ty, double rz, double sx, double sy, double px, double py, UT_DMatrix3 &mat)

static void buildXform (int trs, float tx, float ty, float rz, float sx, float sy, float s_xy, float px, float py, UT_Matrix3 &mat)

static void buildXform (int trs, double tx, double ty, double rz, double sx, double sy, double s_xy, double px, double py, UT_DMatrix3 &mat)

static void clearAllPendingUndoFlags ()

static void setIndentLevel (int numspaces)

static void writeIndent (ostream &os, int indent)

static void writeSpaces (ostream &os, int spaces)

static void writeFileHeader (ostream &os, const char *filename, const char *prefix)

static OP_EditCallback getEditCallback (void *&data)

static void setEditCallback (OP_EditCallback func, void *data)

static void buildQuadricXform (UT_Matrix4 &mat, float tx, float ty, float tz, float sx, float sy, float sz, char axis= 'y')

static void buildQuadricXform (UT_DMatrix4 &mat, double tx, double ty, double tz, double sx, double sy, double sz, char axis= 'y')

static int buildOpMenu (OP_Network *net, PRM_Name *theMenu, int theMenuSize, int(*doAdd)(OP_Node *)=0, int startItem=0, const PRM_Parm *parm=0, int showSubnets=1, int expandSubnets=1, bool recurse=false)

static void buildPreDefRulesMenu (PRM_Name *menu, OP_PreDefRules &pdr)

static int getNameSerialIndex ()

static void printOpMemoryUsageStats (ostream &os)

static bool getDoingBulkNotification ()

static bool isDirectorDoingBulkNotification ()

static bool createNewOpType (OP_Node *node, UT_String &errors, const char *typeName=NULL, const char *typeLabel=NULL, const char *otlFile=NULL, const char *metaSource=NULL, const char *comment=NULL, const char *version=NULL, const char *newName=NULL, int minimumInputs=-1, int maximumInputs=-1, bool ignore_external_references=false, bool compress_contents=false, bool force=false, int *newNodeId=NULL, bool compile_contents=false)

static void setSmallMode ()

static bool getSmallMode ()

static void startBulkNotifications (const OP_NodeList &changed, OP_Node *caller=NULL)

static void endBulkNotifications (const OP_NodeList &changed)

static void setNodeButtonWidthFlagMult (int new_mult)

Sets the node button width in terms of the flag widths multiplier.

static void addExtraInputToEvalChannel (int thread, OP_Node &op, OP_InterestType type)

static void addExtraInputToEvalChannel (int thread, OP_Node &op, int parm_i, int vec_i)

static void addExtraInputToEvalChannel (int thread, const OP_InterestRef &source_ref)

static void addExtraInputToEvalChannel (int thread, DEP_MicroNode &src_micronode)

static void addExtraInput (const OP_InterestRef &target_ref, const OP_InterestRef &source_ref)

static void addExtraInput (const OP_InterestRef &target_ref, DEP_MicroNode &source_micronode)

static void addExtraInput (DEP_MicroNode &target_micronode, const OP_InterestRef &source_ref)

Protected Member Functions

virtual void doGetFullPath (UT_WorkBuffer &str) const

Implement the method from PRM_ParmOwner.

virtual void buildLocalVarNames (UT_StringArray &out_vars)

void finishedLoadingParentNetwork (void)

OP_Node (OP_Network *parent, const char *name, OP_Operator *entry)

virtual ~OP_Node ()

void setNewParent (OP_Network *new_parent)

void setLegacyConnectingInputIndex (int index)

virtual void clearAndDestroy (void)

virtual void clearCache ()

void clearInterruptedImpl (bool allow_recook)

virtual OP_ERROR cookMe (OP_Context &context)=0

virtual OP_ERROR bypassMe (OP_Context &context, int &copied_input)=0

virtual void doOverridePreCook ()

virtual void doOverridePostCook ()

int getSourceCount (void) const

virtual int bumpSourceCount (int d)

virtual OP_ERROR cookInputGroups (OP_Context &context, int alone=0)

virtual int deleteNodeData (void *)

virtual void * copyNodeData (void *)

virtual OP_ERROR saveIntrinsic (ostream &os, const OP_SaveFlags &flags)

virtual OP_ERROR save (ostream &os, const OP_SaveFlags &flags, const char *path_prefix="")

bool loadIntrinsic (UT_IStream &is, const char *path=0)

virtual bool loadPacket (UT_IStream &is, short class_id, short sig, const char *path=0)

virtual bool loadPacket (UT_IStream &is, const char *token, const char *path=0)

virtual bool load (UT_IStream &is, const char *ext="", const char *path=0)

virtual void loadStart ()

virtual void loadFinished ()

void loadContentsSection ()

virtual bool syncContents (UT_IStream &is)

void setMatchesOTLDefinition (int matches)

Sets the flag idicating if the node is synced (matched) to the HDA.

virtual const char * getFileExtension (int binary) const =0

virtual const char * getDataFileExtension (int binary) const

const char * inputLabelNum (unsigned idx) const

const char * outputLabelNum (unsigned idx) const

virtual void checkTimeDependencies (int do_parms=1, int do_inputs=1, int do_extras=1)

unsigned isInput (unsigned idx)

void sendEvent (OP_EventType type, void *data=0)

int haveSeenDataModification (long modification_id)

virtual int propagateModification (OP_Node *by_whom, OP_EventType reason, int parm_index, OP_PropagateData &prop_data)

OP_Cache * getCookCache ()

virtual void saveFlagsForUndo ()

void saveForUndoLayout ()

void saveForUndoColor ()

void clearDependency ()

Clears all cook dependencies (i.e., items that may cause it to cook).

bool dirtyForTimeChange (fpreal t)

virtual void cloneFromProxyRefNode (OP_Network *proxy)

virtual OP_Network * cloneToProxyRefNode ()

void stealDependents (OP_Node *other)

bool hasOpDependents ()

virtual int hasProxyRefNodes () const

virtual void moveProxyRefNodes (OP_Network *)

void clearOpReferences ()

virtual void rebuildOpDependents (bool proxy_only)

virtual int removeOpDependent (int op_id, const PRM_RefId &ref_id, OP_InterestType mask=OP_INTEREST_ALL)

removeOpDependent() returns the number of dependents removed

virtual int removeOpDependent (int op_id, OP_InterestType mask=OP_INTEREST_ALL)

virtual void buildOpDependencies ()

virtual void checkChannelDependencies (CH_Channel *ch, CH_CHANGE_TYPE reason)

void notifyOpDependents (OP_InterestType interest, bool recurse)

virtual void moveDependencies (OP_Node *from_node)

void notifyRenameDependents (const UT_String &full_from)

virtual void notifyRenameDependents (const UT_String &full_from, OP_NodeList &cook_nodes)

void notifyRenameReferences (const UT_String &full_from)

virtual void notifyRenameReferences (const UT_String &full_from, OP_NodeList &cook_nodes)

virtual void handleOpDependency (int referenced_op_id, const OP_Dependency &op_dep, OP_InterestType interest_type, bool &need_cook, const char *old_fullpath, const char *old_cwd, const char *old_chan_name)

virtual void buildParmDependency (int parm_index)

void addOpNameReference (const PRM_RefId &ref_id, const UT_String &op_path, OP_InterestType type)

void addChannelNameReference (const PRM_RefId &ref_id, const UT_String &op_path, const UT_String &chan_name, OP_InterestType type)

OP_Node * getNodeOrCreateProxy (const UT_String &op_path)

void addOpReference (const PRM_RefId &ref_id, OP_Node *node, const PRM_RefId &source_ref_id, OP_InterestType type)

bool changeOpPathRef (UT_String &value_str, const char *new_fullpath, const char *old_fullpath, const char *old_cwd, const char *new_cwd)

void handleStringParmOpPathDependency (int parm_index, int vi, const char *new_fullpath, const char *old_fullpath, const char *old_cwd)

void notifyNodeDeletion ()

virtual void nodeDeleted (OP_Node *op, int propagate=1)

void startCookTimer (const OP_Context &context)

void stopCookTimer (const OP_Context &context)

virtual const char * getCookTimerLabel (const OP_Context &context) const

virtual void permissionError (const char *chname=0)

void addInputError (unsigned input_idx)

virtual bool isInputConnectedInsideSubnet (int input_idx) const

virtual bool isNamedInputConnectedInsideSubnet (const OP_ConnectorId &input_name) const

virtual void nodeUnlocked ()

virtual void setUniqueId (int id)

void changeOpDependentUniqueId (int old_id, int new_id)

void changeOpReferenceUniqueId (int old_id, int new_id)

virtual void clearUniqueId ()

void setAllowBuildDependencies (int yesno)

int allowBuildDependencies () const

void evaluateAllParms (fpreal t)

virtual void getMyExternalReferences (UT_StringArray &reflist, UT_StringArray *nodelist=0, bool collapse=false, bool check_missing=false, bool show_missing_only=false)

void getExternalFiles (UT_StringArray &files, const char *stringparm, int framestart, int frameend, bool collapse, bool check_missing, bool show_only_missing, UT_KnownPath path)

virtual bool canDestroyNode ()

virtual bool cookedDataUsesAllParameters () const

virtual bool cookedDataNeedsErrors () const

bool getIsRunningInCreateScript () const

virtual void refreshRepresentativeNode (OP_Node &changed_child)

void convertOpdefToAbsolutePath (UT_String &str) const

bool isCookedTime (fpreal t) const

virtual void dumpMicroNodes (std::ostream &os, bool as_DOT, int indent_level) const

void deleteInput (int idx)

void deleteInput (const OP_ConnectorId &input_name)

void updateErrorSeverity ()

Update the error severity of this node.

virtual void onInputAllocated (OP_Input *new_input, int index)

Overriden in VOPs.

void checkConnectorsConsistency (void)

Debug method for checking connector consistency.

void renameInput (OP_Input *input, int new_id)

void renameOutput (OP_Output *output, int new_id)

Static Protected Member Functions

static void bumpNameSerialIndex ()

static void deleteDataCallback (void *, void *)

static void * copyDataCallback (void *, void *)

static void cmd_locate (CMD_Args &)

static void saveForUndoDelete (OP_NodeList &nodes)

static bool getStringParmOpPath (PRM_Parm &parm, int vi, UT_String &oppath, int thread)

static bool canDestroyNodes (OP_Network *src_net, OP_NodeList *nodes)

static fpreal getFlagWidth ()

static fpreal getNodeHeight ()

Get the default node height based on the current flag width.

static fpreal getNodeButtonWidth ()

static fpreal getConnectorHeight ()

Protected Attributes

UT_TokenString myHashCode

UT_TokenString myParmHashCode

int myLastGroupMask

OP_VERSION myHashVersion

fpreal myHashTime

int myParmLastGroupMask

OP_VERSION myParmHashVersion

fpreal myParmHashTime

UT_String mySyncErrors

OP_ERROR mySyncErrorLevel

int mySyncDepth

uint32 myCompHash

Static Protected Attributes

static bool theSmallMode

Friends

class OP_Network

class OP_Group

class OP_DataMicroNode

class OP_ParmMicroNode

class OP_Input

class OP_InputIndirect

class OP_UndoDelete

class OP_UndoInput

class OP_UndoCreate

class OP_UndoSpareParm

class op_MicroNodeDirtied

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/ObjNode_setSelectable.C, HOM/SOP_HOMWave.C, HOM/SOP_HOMWave.h, 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_CustomBrushState.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, standalone/traverse.C, 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 448 of file OP_Node.h.

Member Enumeration Documentation

enum OP_Node::RampError

Enumerator:

RAMP_ERR_SUCCESS
RAMP_ERR_NOT_FOUND
RAMP_ERR_FIRST_OR_LAST_KEY

Definition at line 1686 of file OP_Node.h.

Constructor & Destructor Documentation

OP_Node::OP_Node	(	OP_Network *	parent,
		const char *	name,
		OP_Operator *	entry
	)			`[protected]`

virtual OP_Node::~OP_Node ( ) [protected, virtual]

Member Function Documentation

virtual int OP_Node::acceptDragDrop	(	DD_Source &	src,
		const char *	label
	)			`[virtual]`

Reimplemented in OBJ_Node, and SOP_Node.

void OP_Node::addChannelNameReference	(	const PRM_RefId &	ref_id,
		const UT_String &	op_path,
		const UT_String &	chan_name,
		OP_InterestType	type
	)			`[protected]`

static void OP_Node::addExprOpDependency	(	const char *	arg_str,
		const PRM_RefId &	ref_id,
		OP_InterestType	interest_type
	)			`[static]`

Examples:: expr/functions.C.

static void OP_Node::addExprOpDependency1From2	(	const char *	arg_str1,
		const char *	arg_str2,
		const PRM_RefId &	ref_id,
		OP_InterestType	interest_type
	)			`[static]`

static void OP_Node::addExprOpParmDependency	(	const char *	arg_str,
		const PRM_RefId &	ref_id,
		OP_InterestType	interest_type
	)			`[static]`

static void OP_Node::addExtraInput	(	DEP_MicroNode &	target_micronode,
		const OP_InterestRef &	source_ref
	)			`[static]`

Generic versions of addExtraInput() used by the others. In particular, the static version of addExtraInput() allows you to define channel to channel dependencies.

static void OP_Node::addExtraInput	(	const OP_InterestRef &	target_ref,
		DEP_MicroNode &	source_micronode
	)			`[static]`

Generic versions of addExtraInput() used by the others. In particular, the static version of addExtraInput() allows you to define channel to channel dependencies.

static void OP_Node::addExtraInput	(	const OP_InterestRef &	target_ref,
		const OP_InterestRef &	source_ref
	)			`[static]`

Generic versions of addExtraInput() used by the others. In particular, the static version of addExtraInput() allows you to define channel to channel dependencies.

void OP_Node::addExtraInput ( DEP_MicroNode & source_micronode )

Generic version of addExtraInput() which adds a dependency from an source micronode to this node's data micronode.

void OP_Node::addExtraInput ( const OP_InterestRef & source_ref )

Generic version of addExtraInput() which adds a dependency from an source ref to this node's data micronode.

void OP_Node::addExtraInput	(	OP_Node &	op,
		int	parm_i,
		int	vec_i
	)			`[inline]`

Declares that this node's data depends on op channel. If vec_i is -1, then this node depends on all the channels of the parameter.

Definition at line 1341 of file OP_Node.h.

virtual void OP_Node::addExtraInput	(	OP_Node *	op,
		OP_InterestType	type
	)			`[inline, virtual]`

Declares that this node's data depends on the op for the given reason (OP_INTEREST_DATA, OP_INTEREST_FLAG).

Note:: There are no other acceptable values for type.

Reimplemented in MGR_Node, and OP_Director.

Examples:: expr/functions.C, SOP/SOP_CopRaster.C, SOP/SOP_HDKObject.C, and SOP/SOP_PrimVOP.C.

Definition at line 1336 of file OP_Node.h.

static void OP_Node::addExtraInputToEvalChannel	(	int	thread,
		DEP_MicroNode &	src_micronode
	)			`[inline, static]`

Declare from an expression callback that the current evaluation channel is dependent on the given source.

Definition at line 1381 of file OP_Node.h.

static void OP_Node::addExtraInputToEvalChannel	(	int	thread,
		const OP_InterestRef &	source_ref
	)			`[inline, static]`

Declare from an expression callback that the current evaluation channel is dependent on the given source.

Definition at line 1373 of file OP_Node.h.

static void OP_Node::addExtraInputToEvalChannel	(	int	thread,
		OP_Node &	op,
		int	parm_i,
		int	vec_i
	)			`[inline, static]`

Declare from an expression callback that the current evaluation channel is dependent on the given source.

Definition at line 1365 of file OP_Node.h.

static void OP_Node::addExtraInputToEvalChannel	(	int	thread,
		OP_Node &	op,
		OP_InterestType	type
	)			`[inline, static]`

Declare from an expression callback that the current evaluation channel is dependent on the given source.

Definition at line 1357 of file OP_Node.h.

void OP_Node::addGenericOpNameReference	(	const PRM_RefId &	ref_id,
		OP_Node *	node
	)

void OP_Node::addGenericOpNameReference ( const UT_String & oppath )

void OP_Node::addInputError ( unsigned input_idx ) [protected]

void OP_Node::addOpInterest	(	void *	data,
		OP_EventMethod	m
	)			`[inline]`

Definition at line 1182 of file OP_Node.h.

void OP_Node::addOpNameReference	(	const PRM_RefId &	ref_id,
		const UT_String &	op_path,
		OP_InterestType	type
	)			`[protected]`

void OP_Node::addOpReference	(	const PRM_RefId &	ref_id,
		OP_Node *	node,
		const PRM_RefId &	source_ref_id,
		OP_InterestType	type
	)			`[protected]`

void OP_Node::addPythonNodeError ( const PY_Result & py_result )

void OP_Node::addTransformError	(	const OP_Node &	node,
		const char *	label = `0`
	)			const

Registers an error for cooking the given node's transform. If label is supplied, then it will be used as a label of the transform error.

Examples:: SOP/SOP_HDKObject.C.

int OP_Node::allowBuildDependencies ( ) const [inline, protected]

Definition at line 2680 of file OP_Node.h.

void OP_Node::beginPropagateModification ( )

virtual int OP_Node::beginVopCodeGeneratorUpdate ( ) [inline, virtual]

Methods to postpone the update of the code generator until ending the last (level zero) update. This avoids recalculation of parameters and vop signatures, which can be quite costly.

Definition at line 2089 of file OP_Node.h.

void OP_Node::blockModify	(	int	on_off,
		int	propagate = `1`
	)

void OP_Node::buildInputHashCode	(	UT_TokenString &	string,
		OP_Context &	context,
		int	group_mask,
		int	level
	)

virtual void OP_Node::buildLocalVarNames ( UT_StringArray & out_vars ) [protected, virtual]

Retrieve a list of the local variables visible to this OP_Node. This list is unsorted and may contain duplicates.

Reimplemented in POP_LocalVar, and SOP_Node.

virtual void OP_Node::buildOpDependencies ( ) [protected, virtual]

Reimplemented from OP_Parameters.

Reimplemented in CHOP_Node, OP_Network, SOP_CaptureEdit, SOP_CaptureLayerPaint, and SOP_CaptureOverride.

static int OP_Node::buildOpMenu	(	OP_Network *	net,
		PRM_Name *	theMenu,
		int	theMenuSize,
		int()(OP_Node )	doAdd = `0`,
		int	startItem = `0`,
		const PRM_Parm *	parm = `0`,
		int	showSubnets = `1`,
		int	expandSubnets = `1`,
		bool	recurse = `false`
	)			`[static]`

virtual void OP_Node::buildParmDependency ( int parm_index ) [protected, virtual]

Reimplemented in CHOP_Channel, OBJ_Geometry, OBJ_SubNet, SOP_CaptureBase, SOP_CaptureEdit, SOP_CaptureLayerPaint, and SOP_CaptureOverride.

static void OP_Node::buildPreDefRulesMenu	(	PRM_Name *	menu,
		OP_PreDefRules &	pdr
	)			`[static]`

static void OP_Node::buildQuadricXform	(	UT_DMatrix4 &	mat,
		double	tx,
		double	ty,
		double	tz,
		double	sx,
		double	sy,
		double	sz,
		char	axis = `'y'`
	)			`[static]`

static void OP_Node::buildQuadricXform	(	UT_Matrix4 &	mat,
		float	tx,
		float	ty,
		float	tz,
		float	sx,
		float	sy,
		float	sz,
		char	axis = `'y'`
	)			`[static]`

Examples:: POP/POP_LocalForce.C.

static void OP_Node::buildXform	(	int	trs,
		double	tx,
		double	ty,
		double	rz,
		double	sx,
		double	sy,
		double	s_xy,
		double	px,
		double	py,
		UT_DMatrix3 &	mat
	)			`[static]`

static void OP_Node::buildXform	(	int	trs,
		float	tx,
		float	ty,
		float	rz,
		float	sx,
		float	sy,
		float	s_xy,
		float	px,
		float	py,
		UT_Matrix3 &	mat
	)			`[static]`

static void OP_Node::buildXform	(	int	trs,
		double	tx,
		double	ty,
		double	rz,
		double	sx,
		double	sy,
		double	px,
		double	py,
		UT_DMatrix3 &	mat
	)			`[static]`

static void OP_Node::buildXform	(	int	trs,
		float	tx,
		float	ty,
		float	rz,
		float	sx,
		float	sy,
		float	px,
		float	py,
		UT_Matrix3 &	mat
	)			`[static]`

static void OP_Node::buildXform	(	int	trs,
		int	xyz,
		double	tx,
		double	ty,
		double	tz,
		double	rx,
		double	ry,
		double	rz,
		double	sx,
		double	sy,
		double	sz,
		double	s_xy,
		double	s_xz,
		double	s_yz,
		double	px,
		double	py,
		double	pz,
		UT_DMatrix4 &	mat
	)			`[static]`

static void OP_Node::buildXform	(	int	trs,
		int	xyz,
		float	tx,
		float	ty,
		float	tz,
		float	rx,
		float	ry,
		float	rz,
		float	sx,
		float	sy,
		float	sz,
		float	s_xy,
		float	s_xz,
		float	s_yz,
		float	px,
		float	py,
		float	pz,
		UT_Matrix4 &	mat
	)			`[static]`

static void OP_Node::buildXform	(	int	trs,
		int	xyz,
		double	tx,
		double	ty,
		double	tz,
		double	rx,
		double	ry,
		double	rz,
		double	sx,
		double	sy,
		double	sz,
		double	px,
		double	py,
		double	pz,
		UT_DMatrix4 &	mat
	)			`[static]`

static void OP_Node::buildXform	(	int	trs,
		int	xyz,
		float	tx,
		float	ty,
		float	tz,
		float	rx,
		float	ry,
		float	rz,
		float	sx,
		float	sy,
		float	sz,
		float	px,
		float	py,
		float	pz,
		UT_Matrix4 &	mat
	)			`[static]`

static void OP_Node::buildXformOrder	(	int	trs,
		int	xyz,
		UT_XformOrder &	order
	)			`[static]`

Build a UT_XformOrder out of TRS and XYZ parameter values.

void OP_Node::builtExplicitly ( int yn ) [inline]

Definition at line 1943 of file OP_Node.h.

void OP_Node::builtHashCode ( bool b = true ) [inline]

Definition at line 1933 of file OP_Node.h.

static void OP_Node::bumpNameSerialIndex ( ) [static, protected]

virtual int OP_Node::bumpSourceCount ( int d ) [protected, virtual]

Reimplemented in CHOP_Node.

void OP_Node::bumpVersionParm ( ) [inline]

Definition at line 927 of file OP_Node.h.

virtual bool OP_Node::bundleChanged ( const OP_Bundle * bundle ) [virtual]

virtual OP_ERROR OP_Node::bypassMe	(	OP_Context &	context,
		int &	copied_input
	)			`[protected, pure virtual]`

Implemented in CHOP_Node, COP2_Node, DOP_Node, MGR_Node, OBJ_Node, OP_Director, POPNET_Node, ROP_Node, SHOP_Node, SOP_Node, VOP_Node, and VOPNET_Node.

const UT_SymbolTable& OP_Node::cachedPythonObjects ( ) const [inline]

Definition at line 1722 of file OP_Node.h.

bool OP_Node::canAccessFlag	(	unsigned	mask,
		uchar	flag
	)			const

virtual bool OP_Node::canCreateNewOpType ( ) const [virtual]

Reimplemented in OBJ_Node, and SOP_ForEach.

virtual bool OP_Node::canDestroyNode ( ) [protected, virtual]

Reimplemented in MGR_Node, OP_Network, and VOPNET_Node.

static bool OP_Node::canDestroyNodes	(	OP_Network *	src_net,
		OP_NodeList *	nodes
	)			`[static, protected]`

CHOPNET_Node* OP_Node::castToCHOPNETNode ( ) const [inline]

FOO_Node *castToFOONode() const;
This type checks the current node against FOO_Node. If the cast is legal, this is returned. Otherwise, NULL. While it likely will do the "right" thing with this == NULL, that case is UT_ASSERTed as it is just asking for trouble.

Definition at line 504 of file OP_Node.h.

CHOP_Node* OP_Node::castToCHOPNode ( ) const [inline]

FOO_Node *castToFOONode() const;
This type checks the current node against FOO_Node. If the cast is legal, this is returned. Otherwise, NULL. While it likely will do the "right" thing with this == NULL, that case is UT_ASSERTed as it is just asking for trouble.

Definition at line 504 of file OP_Node.h.

COP2_Node* OP_Node::castToCOP2Node ( ) const [inline]

FOO_Node *castToFOONode() const;
This type checks the current node against FOO_Node. If the cast is legal, this is returned. Otherwise, NULL. While it likely will do the "right" thing with this == NULL, that case is UT_ASSERTed as it is just asking for trouble.

Definition at line 504 of file OP_Node.h.

COPNET_Node* OP_Node::castToCOPNETNode ( ) const [inline]

FOO_Node *castToFOONode() const;
This type checks the current node against FOO_Node. If the cast is legal, this is returned. Otherwise, NULL. While it likely will do the "right" thing with this == NULL, that case is UT_ASSERTed as it is just asking for trouble.

Definition at line 504 of file OP_Node.h.

DOP_Node* OP_Node::castToDOPNode ( ) const [inline]

FOO_Node *castToFOONode() const;
This type checks the current node against FOO_Node. If the cast is legal, this is returned. Otherwise, NULL. While it likely will do the "right" thing with this == NULL, that case is UT_ASSERTed as it is just asking for trouble.

Definition at line 504 of file OP_Node.h.

virtual const DOP_Parent* OP_Node::castToDOPParent ( ) const [inline, virtual]

Reimplemented in DOP_Node, and OBJ_DopNet.

Definition at line 2075 of file OP_Node.h.

virtual DOP_Parent* OP_Node::castToDOPParent ( ) [inline, virtual]

Reimplemented in DOP_Node, and OBJ_DopNet.

Examples:: ROP/ROP_DopField.C.

Definition at line 2074 of file OP_Node.h.

OBJ_Node* OP_Node::castToOBJNode ( ) const [inline]

FOO_Node *castToFOONode() const;
This type checks the current node against FOO_Node. If the cast is legal, this is returned. Otherwise, NULL. While it likely will do the "right" thing with this == NULL, that case is UT_ASSERTed as it is just asking for trouble.

Examples:: HOM/ObjNode_setSelectable.C.

Definition at line 504 of file OP_Node.h.

virtual const OP_Node* OP_Node::castToOPNode ( ) const [inline, virtual]

Reimplemented from PRM_ParmOwner.

Definition at line 759 of file OP_Node.h.

virtual OP_Node* OP_Node::castToOPNode ( ) [inline, virtual]

Reimplemented from PRM_ParmOwner.

Definition at line 758 of file OP_Node.h.

POPNET_Node* OP_Node::castToPOPNETNode ( ) const [inline]

FOO_Node *castToFOONode() const;
This type checks the current node against FOO_Node. If the cast is legal, this is returned. Otherwise, NULL. While it likely will do the "right" thing with this == NULL, that case is UT_ASSERTed as it is just asking for trouble.

Definition at line 504 of file OP_Node.h.

POP_Node* OP_Node::castToPOPNode ( ) const [inline]

FOO_Node *castToFOONode() const;
This type checks the current node against FOO_Node. If the cast is legal, this is returned. Otherwise, NULL. While it likely will do the "right" thing with this == NULL, that case is UT_ASSERTed as it is just asking for trouble.

Definition at line 504 of file OP_Node.h.

ROP_Node* OP_Node::castToROPNode ( ) const [inline]

FOO_Node *castToFOONode() const;
This type checks the current node against FOO_Node. If the cast is legal, this is returned. Otherwise, NULL. While it likely will do the "right" thing with this == NULL, that case is UT_ASSERTed as it is just asking for trouble.

Definition at line 504 of file OP_Node.h.

SHOP_Node* OP_Node::castToSHOPNode ( ) const [inline]

FOO_Node *castToFOONode() const;
This type checks the current node against FOO_Node. If the cast is legal, this is returned. Otherwise, NULL. While it likely will do the "right" thing with this == NULL, that case is UT_ASSERTed as it is just asking for trouble.

Definition at line 504 of file OP_Node.h.

SOP_Node* OP_Node::castToSOPNode ( ) const [inline]

FOO_Node *castToFOONode() const;
This type checks the current node against FOO_Node. If the cast is legal, this is returned. Otherwise, NULL. While it likely will do the "right" thing with this == NULL, that case is UT_ASSERTed as it is just asking for trouble.

Definition at line 504 of file OP_Node.h.

VOPNET_Node* OP_Node::castToVOPNETNode ( ) const [inline]

FOO_Node *castToFOONode() const;
This type checks the current node against FOO_Node. If the cast is legal, this is returned. Otherwise, NULL. While it likely will do the "right" thing with this == NULL, that case is UT_ASSERTed as it is just asking for trouble.

Definition at line 504 of file OP_Node.h.

VOP_Node* OP_Node::castToVOPNode ( ) const [inline]

FOO_Node *castToFOONode() const;
This type checks the current node against FOO_Node. If the cast is legal, this is returned. Otherwise, NULL. While it likely will do the "right" thing with this == NULL, that case is UT_ASSERTed as it is just asking for trouble.

Definition at line 504 of file OP_Node.h.

static void OP_Node::changeExprOpParmRef	(	const char *	arg_str,
		char *&	new_arg,
		const char *	new_fullpath,
		const char *	old_fullpath,
		const char *	old_cwd,
		const char *	chan_name,
		const char *	old_chan_name
	)			`[static]`

static void OP_Node::changeExprOpRef	(	const char *	arg_str,
		char *&	new_arg,
		const char *	new_fullpath,
		const char *	old_fullpath,
		const char *	old_cwd
	)			`[static]`

Examples:: expr/functions.C.

static void OP_Node::changeExprOpRef1From2	(	const char *	arg_str1,
		const char *	arg_str2,
		char *&	new_arg1,
		char *&	new_arg2,
		const char *	new_fullpath,
		const char *	old_fullpath,
		const char *	old_cwd
	)			`[static]`

void OP_Node::changeOpDependentUniqueId	(	int	old_id,
		int	new_id
	)			`[protected]`

bool OP_Node::changeOpPathRef	(	UT_String &	value_str,
		const char *	new_fullpath,
		const char *	old_fullpath,
		const char *	old_cwd,
		const char *	new_cwd
	)			`[protected]`

This function takes the given parm string value containing an op path and does a search and replace given the old and new op paths.

value_str - the old parm value to modify new_fullpath - the new path value to change to old_fullpath - the old path that needs changing old_cwd - the old path that the parm value was relative to new_cwd - the new path that the parm value is to be relative to

The reason for old_cwd & new_cwd is when collapsing a node into a subnet. We need to figure out the new path references of the collapsed subnet since it has changed location. We match using the old_cwd but take the new path relative to new_cwd. Note that in this situation, old_fullpath is the same as new_fullpath.

void OP_Node::changeOpReferenceUniqueId	(	int	old_id,
		int	new_id
	)			`[protected]`

virtual void OP_Node::changeParmTemplate ( PRM_Template * new_template ) [virtual]

Reimplemented in OP_Network, and SHOP_Node.

virtual bool OP_Node::changeSpareParms	(	UT_IStream &	istream,
		UT_String &	errors
	)			`[virtual]`

Reimplemented from OP_Parameters.

Reimplemented in OP_Director.

virtual int OP_Node::changeString	(	const char *	from,
		const char *	to,
		bool	fullword
	)			`[virtual]`

Override these methods so that search-and-replace operations affect our delete script as well as our parameters.

Reimplemented from OP_Parameters.

Reimplemented in SOP_CaptureBase.

virtual void OP_Node::checkChannelDependencies	(	CH_Channel *	ch,
		CH_CHANGE_TYPE	reason
	)			`[protected, virtual]`

Reimplemented from OP_Parameters.

Reimplemented in OBJ_Muscle, and SOP_Muscle.

void OP_Node::checkConnectorsConsistency ( void ) [protected]

Debug method for checking connector consistency.

void OP_Node::checkInputs ( )

virtual void OP_Node::checkTimeDependencies	(	int	do_parms = `1`,
		int	do_inputs = `1`,
		int	do_extras = `1`
	)			`[protected, virtual]`

Reimplemented in COP2_MultiBase.

void OP_Node::cleanAllBundleRefs ( )

void OP_Node::cleanUnusedBundleRefs ( )

static void OP_Node::clearAllPendingUndoFlags ( ) [static]

virtual void OP_Node::clearAndDestroy ( void ) [protected, virtual]

Reimplemented in CHOP_Node, and OP_Network.

virtual void OP_Node::clearCache ( ) [protected, virtual]

Reimplemented in OBJ_DopNet.

void OP_Node::clearDependency ( ) [protected]

Clears all cook dependencies (i.e., items that may cause it to cook).

void OP_Node::clearHashCodeFlags ( )

virtual void OP_Node::clearInterrupted ( ) [inline, virtual]

Reimplemented in DOP_Node, OBJ_DopNet, and VOP_Node.

Definition at line 1897 of file OP_Node.h.

void OP_Node::clearInterruptedImpl ( bool allow_recook ) [protected]

void OP_Node::clearOpReferences ( ) [protected]

virtual void OP_Node::clearParmDependency ( int parm_index ) [virtual]

Implements PRM_ParmOwner.

virtual void OP_Node::clearUndoFlags ( ) [virtual]

Reimplemented from OP_Parameters.

Reimplemented in OBJ_Node, and OP_Network.

virtual void OP_Node::clearUniqueId ( ) [protected, virtual]

Reimplemented in SOP_Node.

virtual void OP_Node::clearUnreferencedInputs ( ) [virtual]

Reimplemented in OP_Network.

virtual void OP_Node::cloneFromProxyRefNode ( OP_Network * proxy ) [protected, virtual]

Reimplemented in OP_Network.

virtual OP_Network* OP_Node::cloneToProxyRefNode ( ) [protected, virtual]

Reimplemented in OP_Network.

static void OP_Node::cmd_locate ( CMD_Args & ) [static, protected]

void OP_Node::completePath	(	const char *	prefixpath,
		UT_String &	completepath
	)			const

This will try to complete the path by finding the longest suffix that will work with the given prefix. It will only complete up to the next child. If it finds a valid child, it will append a slash (/).

void OP_Node::connectToInputNode	(	OP_Node &	inputnode,
		int	input_idx,
		int	branch_off = `0`
	)

void OP_Node::consolidateInputs ( )

void OP_Node::convertOpdefToAbsolutePath ( UT_String & str ) const [protected, virtual]

Implements PRM_ParmOwner.

virtual bool OP_Node::cook ( OP_Context & context ) [virtual]

Cook this node's data. Returns true upon success, false otherwise.

Upon failure, use OP_Parameters::error() and OP_Parameters::getErrorMessages() to determine reason.

Reimplemented in COP2_Node.

virtual bool OP_Node::cookedDataNeedsErrors ( ) const [inline, protected, virtual]

Reimplemented in SHOP_Node.

Definition at line 2723 of file OP_Node.h.

virtual bool OP_Node::cookedDataUsesAllParameters ( ) const [inline, protected, virtual]

Reimplemented in DOP_Node, OBJ_Camera, OBJ_DopNet, and SHOP_Node.

Definition at line 2719 of file OP_Node.h.

virtual int OP_Node::cookedInputIndex ( ) const [inline, virtual]

Definition at line 1563 of file OP_Node.h.

virtual OP_ERROR OP_Node::cookInputGroups	(	OP_Context &	context,
		int	alone = `0`
	)			`[protected, virtual]`

Reimplemented in SOP_AttribComp, SOP_BlendShapes, SOP_BrushBase, SOP_CaptureEdit, SOP_CaptureLayerPaint, SOP_CaptureOverride, SOP_Edit, SOP_Lattice, SOP_Pelt, SOP_Reverse, SOP_UVEdit, SOP_UVFuse, SOP_UVTransform, SOP_Visibility, HDK_Sample::SOP_CustomBrush, HDK_Sample::SOP_Flatten, HDK_Sample::SOP_GroupRename, HDK_Sample::SOP_PointWave, and HDK_Sample::SOP_TimeCompare.

virtual OP_ERROR OP_Node::cookMe ( OP_Context & context ) [protected, pure virtual]

Implemented in CHOP_Node, COP2_Node, DOP_Node, DOP_SubNet, MGR_Node, OBJ_Node, OP_Director, POPNET_Node, ROP_Node, SHOP_Node, SOP_Node, VOP_Collect, VOP_Node, VOP_ParameterBase, and VOPNET_Node.

OP_ERROR OP_Node::cookOverrides ( OP_Context & c )

int OP_Node::cookParmsModified ( ) const [inline]

Definition at line 929 of file OP_Node.h.

static void* OP_Node::copyDataCallback	(	void *	,
		void *
	)			`[static, protected]`

virtual void* OP_Node::copyNodeData ( void * ) [protected, virtual]

Reimplemented in SOP_Node.

int OP_Node::countReferences ( int op_id )

virtual void OP_Node::createGalleryEntry ( OP_GalleryEntry & entry ) [virtual]

Reimplemented in SHOP_Node.

static bool OP_Node::createNewOpType	(	OP_Node *	node,
		UT_String &	errors,
		const char *	typeName = `NULL`,
		const char *	typeLabel = `NULL`,
		const char *	otlFile = `NULL`,
		const char *	metaSource = `NULL`,
		const char *	comment = `NULL`,
		const char *	version = `NULL`,
		const char *	newName = `NULL`,
		int	minimumInputs = `-1`,
		int	maximumInputs = `-1`,
		bool	ignore_external_references = `false`,
		bool	compress_contents = `false`,
		bool	force = `false`,
		int *	newNodeId = `NULL`,
		bool	compile_contents = `false`
	)			`[static]`

virtual PRM_ParmList* OP_Node::createObsoleteParmList ( ) [virtual]

Reimplemented from OP_Parameters.

virtual OP_Network* OP_Node::createProxyRefNode ( const char * path ) [virtual]

Reimplemented in OP_Network.

DEP_MicroNode& OP_Node::dataMicroNode ( ) [inline]

Definition at line 1311 of file OP_Node.h.

void OP_Node::decrementOpReference ( int node_id )

bool OP_Node::deleteCachedPythonObject ( const char * key )

virtual void OP_Node::deleteCookedData ( ) [pure virtual]

Implemented in CHOP_Node, DOP_Node, MGR_Node, OBJ_Node, OP_Director, POPNET_Node, ROP_Node, SHOP_Node, SOP_Node, VOP_Node, and VOPNET_Node.

static void OP_Node::deleteDataCallback	(	void *	,
		void *
	)			`[static, protected]`

void OP_Node::deleteInput ( const OP_ConnectorId & input_name ) [protected]

void OP_Node::deleteInput ( int idx ) [protected]

Deletes an input completely if it is disconnected. If the input is connected, does nothing.

virtual int OP_Node::deleteNodeData ( void * ) [protected, virtual]

Reimplemented in SOP_Node.

bool OP_Node::deleteUserData ( const char * key )

bool OP_Node::dirtyForTimeChange ( fpreal t ) [inline, protected]

This function will dirty our data if the given time is different from our last cooked time.

This function is normally called from cook() but subclasses can prevent this with flags().setClearDependency(false). In that case, subclasses are responsible for calling this function at the appropriate time. This is primarily for nodes which cache their data across time. In that case, if they did _not_ reuse their cached data, then dirtyForTimeChange() needs to be called.

Returns:: true if node was dirtied, false otherwise.

Definition at line 2531 of file OP_Node.h.

void OP_Node::disconnectAllInputs ( void )

void OP_Node::disconnectAllInputsOutputs	(	bool	keepSelected,
		bool	forceDisconnectOutputs = `false`
	)

void OP_Node::disconnectAllOutputs ( void )

virtual int OP_Node::doDeleteRewire ( void ) const [inline, virtual]

Definition at line 1300 of file OP_Node.h.

virtual void OP_Node::doGetFullPath ( UT_WorkBuffer & str ) const [protected, virtual]

Implement the method from PRM_ParmOwner.

Reimplemented from OP_Parameters.

virtual void OP_Node::doOverridePostCook ( ) [inline, protected, virtual]

Definition at line 2417 of file OP_Node.h.

virtual void OP_Node::doOverridePreCook ( ) [inline, protected, virtual]

Definition at line 2416 of file OP_Node.h.

virtual void OP_Node::dumpDependencies ( ) [virtual]

Reimplemented in OP_Network.

void OP_Node::dumpExtraInputs	(	std::ostream &	os,
		bool	as_DOT,
		int	indent_level = `0`
	)			const

virtual void OP_Node::dumpMicroNodes	(	std::ostream &	os,
		bool	as_DOT,
		int	indent_level
	)			const `[protected, virtual]`

Subclasses should override this to dump extra micronodes that they own for debugging purposes.

Reimplemented in OBJ_DopNet.

void OP_Node::dumpOpDependents	(	OP_Node *	ref,
		int	brief,
		ostream &	os
	)

virtual int OP_Node::editCallback	(	CL_Track *	track,
		fpreal	t,
		fpreal	newValue
	)			`[virtual]`

static void OP_Node::endBulkNotifications ( const OP_NodeList & changed ) [static]

void OP_Node::endPropagateModification ( )

virtual void OP_Node::endVopCodeGeneratorUpdate ( int update_level ) [inline, virtual]

Methods to postpone the update of the code generator until ending the last (level zero) update. This avoids recalculation of parameters and vop signatures, which can be quite costly.

Definition at line 2090 of file OP_Node.h.

void OP_Node::ensureInputsAndOutputsAreValid ( )

void OP_Node::evalOpPathString	(	UT_String &	val,
		const char *	pn,
		int &	pi,
		int	vi,
		fpreal	t,
		int &	op_id,
		fpreal &	op_time,
		int	expanded = `1`
	)

void OP_Node::evalOpPathString	(	UT_String &	val,
		int	pi,
		int	vi,
		fpreal	t,
		int &	op_id,
		fpreal &	op_time,
		int	expanded = `1`
	)

void OP_Node::evaluateAllParms ( fpreal t ) [protected]

virtual void OP_Node::evaluateBatchParms	(	PRM_BatchList &	list,
		fpreal	now
	)			`[virtual]`

Reimplemented in OBJ_Node.

virtual void OP_Node::executeCommand	(	const char *	command,
		ostream *	out,
		ostream *	err
	)			const `[virtual]`

Implements PRM_ParmOwner.

OP_ERROR OP_Node::executeHscriptScript	(	UT_String &	script,
		fpreal	now
	)

OP_ERROR OP_Node::executePythonScript	(	UT_String &	script,
		fpreal	now
	)

bool OP_Node::expandGroupPattern	(	const char *	pattern,
		UT_String &	result,
		bool	expandToFullPaths = `false`
	)

void OP_Node::fillInfoTree	(	UT_InfoTree &	tree,
		fpreal	time
	)

Fill in 'tree' with details that are common to all node types. Then call fillInfoTreeNodeSpecific() to get specific details about this specific node (be it a SOP, CHOP, etc)

virtual void OP_Node::fillInfoTreeNodeSpecific	(	UT_InfoTree &	tree,
		fpreal	time
	)			`[virtual]`

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

Reimplemented in SOP_ForEach, and SOP_Node.

CH_Channel* OP_Node::findChannel ( const char * path )

CHOPNET_Node* OP_Node::findCHOPNETNode ( const char * path ) const [inline]

FOO_Node *findFOONode(const char *path) const;
This function searches for the node at path relative to this node. If not found, or if the found node is not of type FOO_Node, it returns NULL. The result is already cast to FOO_Node.

Definition at line 493 of file OP_Node.h.

CHOP_Node* OP_Node::findCHOPNode ( const char * path ) const [inline]

FOO_Node *findFOONode(const char *path) const;
This function searches for the node at path relative to this node. If not found, or if the found node is not of type FOO_Node, it returns NULL. The result is already cast to FOO_Node.

Definition at line 493 of file OP_Node.h.

COP2_Node* OP_Node::findCOP2Node ( const char * path ) const [inline]

FOO_Node *findFOONode(const char *path) const;
This function searches for the node at path relative to this node. If not found, or if the found node is not of type FOO_Node, it returns NULL. The result is already cast to FOO_Node.

Definition at line 493 of file OP_Node.h.

COPNET_Node* OP_Node::findCOPNETNode ( const char * path ) const [inline]

FOO_Node *findFOONode(const char *path) const;
This function searches for the node at path relative to this node. If not found, or if the found node is not of type FOO_Node, it returns NULL. The result is already cast to FOO_Node.

Definition at line 493 of file OP_Node.h.

DOP_Node* OP_Node::findDOPNode ( const char * path ) const [inline]

FOO_Node *findFOONode(const char *path) const;
This function searches for the node at path relative to this node. If not found, or if the found node is not of type FOO_Node, it returns NULL. The result is already cast to FOO_Node.

Definition at line 493 of file OP_Node.h.

virtual OP_NetworkBoxItem* OP_Node::findItem	(	const char *	const_path,
		OP_ItemTypeMask	item_type = `OP_ITEMTYPE_ALL`
	)			`[virtual]`

Same as findNode or findNetworkBox, but more generalized so you can search through multiple items with just one method. 'item_type_mask' is used to specify what type of items you want to consider in your search.

Reimplemented in OP_Network.

virtual OP_NetworkBox* OP_Node::findNetworkBox ( const char * ) [inline, virtual]

Implemented in OP_Network, but put here as a virtual to make working with hscript easier so that it can be called directly on an op node

Reimplemented in OP_Network.

Definition at line 726 of file OP_Node.h.

OP_Node* OP_Node::findNode ( const char * path ) const

Uses the path (eg. "/obj/geo1") to find a node in our heirarchy.

Examples:: expr/functions.C, HOM/ObjNode_setSelectable.C, ROP/ROP_DopField.C, SOP/SOP_CopRaster.C, and SOP/SOP_HDKObject.C.

OBJ_Node* OP_Node::findOBJNode ( const char * path ) const [inline]

FOO_Node *findFOONode(const char *path) const;
This function searches for the node at path relative to this node. If not found, or if the found node is not of type FOO_Node, it returns NULL. The result is already cast to FOO_Node.

Definition at line 493 of file OP_Node.h.

static int OP_Node::findOpFramePair	(	const char *	path,
		int &	op_id,
		fpreal &	frame
	)			`[static]`

virtual bool OP_Node::findParmFromTrack	(	fpreal	t,
		const char *	trackname,
		OP_NodeParmRefCycle &	cycle,
		OP_Node *&	node,
		PRM_Parm *&	parm,
		int &	vecidx
	)			`[virtual]`

Reimplemented in CHOP_Channel, and CHOP_Node.

POPNET_Node* OP_Node::findPOPNETNode ( const char * path ) const [inline]

FOO_Node *findFOONode(const char *path) const;
This function searches for the node at path relative to this node. If not found, or if the found node is not of type FOO_Node, it returns NULL. The result is already cast to FOO_Node.

Definition at line 493 of file OP_Node.h.

POP_Node* OP_Node::findPOPNode ( const char * path ) const [inline]

FOO_Node *findFOONode(const char *path) const;
This function searches for the node at path relative to this node. If not found, or if the found node is not of type FOO_Node, it returns NULL. The result is already cast to FOO_Node.

Definition at line 493 of file OP_Node.h.

virtual OP_PostIt* OP_Node::findPostItNote ( const char * ) [inline, virtual]

Implemented in OP_Network, but put here as a virtual to make working with hscript easier so that it can be called directly on an op node

Reimplemented in OP_Network.

Definition at line 731 of file OP_Node.h.

ROP_Node* OP_Node::findROPNode ( const char * path ) const [inline]

FOO_Node *findFOONode(const char *path) const;
This function searches for the node at path relative to this node. If not found, or if the found node is not of type FOO_Node, it returns NULL. The result is already cast to FOO_Node.

Definition at line 493 of file OP_Node.h.

SHOP_Node* OP_Node::findSHOPNode ( const char * path ) const [inline]

FOO_Node *findFOONode(const char *path) const;
This function searches for the node at path relative to this node. If not found, or if the found node is not of type FOO_Node, it returns NULL. The result is already cast to FOO_Node.

Examples:: SOP/SOP_PrimVOP.C.

Definition at line 493 of file OP_Node.h.

SOP_Node* OP_Node::findSOPNode ( const char * path ) const [inline]

FOO_Node *findFOONode(const char *path) const;
This function searches for the node at path relative to this node. If not found, or if the found node is not of type FOO_Node, it returns NULL. The result is already cast to FOO_Node.

Definition at line 493 of file OP_Node.h.

virtual int OP_Node::findString	(	const char *	str,
		bool	fullword,
		bool	usewildcards
	)			const `[virtual]`

Override these methods so that search-and-replace operations affect our delete script as well as our parameters.

Reimplemented from OP_Parameters.

OP_Node* OP_Node::findSubNode ( const char * path ) const

Same as findNode() except it will return NULL if the path is to a node that is either not a descendent of this node, or if it isn't the same type as our children.

VOPNET_Node* OP_Node::findVOPNETNode ( const char * path ) const [inline]

FOO_Node *findFOONode(const char *path) const;
This function searches for the node at path relative to this node. If not found, or if the found node is not of type FOO_Node, it returns NULL. The result is already cast to FOO_Node.

Definition at line 493 of file OP_Node.h.

VOP_Node* OP_Node::findVOPNode ( const char * path ) const [inline]

FOO_Node *findFOONode(const char *path) const;
This function searches for the node at path relative to this node. If not found, or if the found node is not of type FOO_Node, it returns NULL. The result is already cast to FOO_Node.

Definition at line 493 of file OP_Node.h.

void OP_Node::finishedLoadingParentNetwork ( void ) [protected]

Called when loadNetwork finishes loading the whole parent network of this node.

DEP_MicroNode& OP_Node::flagMicroNode ( ) [inline]

Definition at line 1313 of file OP_Node.h.

virtual OP_NodeFlags& OP_Node::flags ( ) [inline, virtual]

Reimplemented from OP_NetworkBoxItem.

Definition at line 1171 of file OP_Node.h.

virtual const OP_NodeFlags& OP_Node::flags ( ) const [inline, virtual]

Reimplemented from OP_NetworkBoxItem.

Examples:: OBJ/OBJ_Shake.C, SOP/SOP_BlindData.h, SOP/SOP_CopRaster.C, SOP/SOP_CPPWave.C, SOP/SOP_CustomBrush.h, SOP/SOP_HDKObject.C, SOP/SOP_PrimVOP.C, and SOP/SOP_SParticle.C.

Definition at line 1169 of file OP_Node.h.

virtual void OP_Node::forceRecook ( bool evensmartcache = true ) [virtual]

Mark this node as needing a full recook. If 'evensmartcache' is true, a recook will occur even if all the parameters match in this node and all its inputs (only valid for COP2_Node).

Reimplemented in COP2_Node.

Examples:: SOP/SOP_BrushHairLen.h, and SOP/SOP_CustomBrush.C.

static bool OP_Node::forceValidOpName ( UT_String & name ) [static]

void OP_Node::gatherInputs ( TInputPairs & input_pairs_out )

Use these to collect all inputs/outputs in cases where they will need to be modified.

void OP_Node::gatherOutputs ( TOutputPairs & output_pairs_out )

unsigned OP_Node::getActiveInputIndex ( ) const [inline]

Definition at line 1244 of file OP_Node.h.

virtual void OP_Node::getActiveOperatorsDefinedByOTL ( UT_HashTable & active_operators ) const [virtual]

Reimplemented in OP_Network.

int OP_Node::getAllChannels	(	CH_ChannelList &	list,
		int	scoped = `0`
	)

void OP_Node::getAllChildren ( OP_NodeList & children ) const

static void OP_Node::getAllNodes ( OP_NodeList & nodes ) [static]

virtual int OP_Node::getAudio ( ) const [virtual]

Reimplemented in CHOP_Node.

virtual int OP_Node::getAuxInput ( ) const [virtual]

Reimplemented in COP2_MaskOp.

virtual void OP_Node::getAuxInputName ( OP_ConnectorId & name_out ) [virtual]

Reimplemented in COP2_MaskOp.

virtual bool OP_Node::getBoundingBox	(	UT_BoundingBox &	box,
		OP_Context &
	)			`[virtual]`

Reimplemented in OBJ_Node, and SOP_Node.

int OP_Node::getBypass ( ) const [inline]

Examples:: COP2/COP2_MultiInputWipe.C, and COP2/COP2_SampleFilter.C.

Definition at line 1122 of file OP_Node.h.

PY_OpaqueObject* OP_Node::getCachedPythonObject ( const char * key ) const

int OP_Node::getCanDeviateFromOTLDefinition ( ) const

virtual OP_Node* OP_Node::getChild ( int index ) const [virtual]

Reimplemented in MOT_Director, and OP_Network.

virtual OP_Node* OP_Node::getChild	(	const char *	name,
		int *	hint = `0`
	)			const `[virtual]`

Reimplemented in MOT_Director, and OP_Network.

Examples:: ROP/ROP_Dumper.C.

virtual const CL_Clip* OP_Node::getClip ( OP_Context * context = 0 ) [virtual]

Reimplemented in CHOP_Node.

virtual const UT_Color* OP_Node::getColor ( void ) const [inline, virtual]

Accessors for this node's color in the network view pane.

Reimplemented from OP_NetworkBoxItem.

Definition at line 525 of file OP_Node.h.

const UT_String& OP_Node::getComment ( void ) const [inline]

Accessors for this node's comment string.

Definition at line 516 of file OP_Node.h.

int OP_Node::getCompress ( ) const

int OP_Node::getConnectedInputIndex ( int startAt = -1 ) const

Returns the first non-null input beyond the specified starting index. This function can be used to easily loop through all connected inputs.

Examples:: VOP/VOP_Switch.C.

static fpreal OP_Node::getConnectorHeight ( ) [static, protected]

Get the default connector (e.g., the thing into which inputs and outputs are drawn) height.

OP_Cache* OP_Node::getCookCache ( ) [inline, protected]

Definition at line 2503 of file OP_Node.h.

int OP_Node::getCookCount ( void ) const [inline]

Definition at line 1558 of file OP_Node.h.

const char* OP_Node::getCookDurationString ( ) const

virtual void* OP_Node::getCookedData ( OP_Context & ) [virtual]

Reimplemented in COP2_Node, MGR_Node, OP_Director, POPNET_Node, ROP_Node, SOP_Node, and VOPNET_Node.

virtual OP_DATA_TYPE OP_Node::getCookedDataType ( ) const [pure virtual]

Implemented in CHOP_Node, COP2_Node, DOP_Node, MGR_Node, OBJ_Node, OP_Director, POPNET_Node, ROP_Node, SHOP_Node, SOP_Node, VOP_Node, and VOPNET_Node.

void OP_Node::getCookInfo ( UT_String & info ) const

Return the cook information as a formatted string.

OP_CookLock& OP_Node::getCookLock ( ) [inline]

The cook lock is used to protect per node data structures during cooking. Use it in the following idiom:

 OP_CookLock::Scope scope(getCookLock(), /*acquire=*/false);
 if (!lockForCooking(scope))
 {
     UTaddDeadlockError();
     return false;
 }

Definition at line 915 of file OP_Node.h.

virtual const char* OP_Node::getCookTimerLabel ( const OP_Context & context ) const [protected, virtual]

COP2_Node* OP_Node::getCOP2Node	(	const char *	path,
		int	addextra = `0`
	)			const

const UT_String& OP_Node::getCreatorState ( ) const [inline]

Definition at line 1942 of file OP_Node.h.

int OP_Node::getCurrent ( ) const

virtual int OP_Node::getDandROpsEqual ( ) [inline, virtual]

Reimplemented in DOP_Node, OBJ_DopNet, OP_Network, and HDK_Sample::SOP_HDKObject.

Definition at line 681 of file OP_Node.h.

virtual int OP_Node::getDataClass ( ) const [virtual]

Reimplemented in SHOP_Node.

virtual const char* OP_Node::getDataFileExtension ( int binary ) const [protected, virtual]

virtual int OP_Node::getDebug ( ) const [virtual]

Reimplemented in VOP_Node.

virtual const char* OP_Node::getDefaultSelectedInfoTreeBranchName ( ) const [virtual]

This method has to do with 'fillInfoTree()' above. When the call to fillInfoTree() completes, the UT_InfoTree 'tree' will be parsed and displayed in a dialog box by OPUI_OpInfoDialog, at which point, that class will want to ask us - which branch of the tree would you like to be selected by default when the dialog is displayed for the first time?

Reimplemented in SOP_Node.

const UT_String& OP_Node::getDelScript ( void ) const [inline]

Obtain the node's script which is called when it is being deleted.

Definition at line 508 of file OP_Node.h.

int OP_Node::getDisplay ( ) const [inline]

Definition at line 1119 of file OP_Node.h.

static bool OP_Node::getDoingBulkNotification ( ) [static]

DOP_Node* OP_Node::getDOPNode	(	const char *	path,
		int	addextra = `0`
	)			const

virtual void OP_Node::getDragDropChoice	(	DD_Source &	src,
		DD_ChoiceList &	c
	)			`[virtual]`

Reimplemented in OBJ_Node, and SOP_Node.

static OP_EditCallback OP_Node::getEditCallback ( void *& data ) [static]

virtual int OP_Node::getEditPicked ( ) const [inline, virtual]

Definition at line 1116 of file OP_Node.h.

static DEP_MicroNode* OP_Node::getEvalChannelMicroNode ( int thread ) [static]

void OP_Node::getExistingOpDependents	(	OP_NodeList &	deps,
		bool	recurse
	)

void OP_Node::getExistingOpReferences	(	OP_NodeList &	refs,
		bool	recurse
	)

virtual int OP_Node::getExport ( ) const [virtual]

Reimplemented in CHOP_Node.

int OP_Node::getExpose ( ) const [inline]

Definition at line 1126 of file OP_Node.h.

void OP_Node::getExternalFiles	(	UT_StringArray &	files,
		const char *	stringparm,
		int	framestart,
		int	frameend,
		bool	collapse,
		bool	check_missing,
		bool	show_only_missing,
		UT_KnownPath	path
	)			`[protected]`

void OP_Node::getExternalReferences	(	UT_StringArray &	reflist,
		UT_StringArray *	nodelist = `0`,
		bool	from_children_too = `true`,
		bool	collapse = `false`,
		bool	check_missing = `false`,
		bool	show_missing_only = `false`
	)

int64 OP_Node::getExtraInputMemUsage ( ) const

void OP_Node::getExtraInputNodes	(	OP_NodeList &	extras,
		bool	remove_duplicates = `true`,
		bool	data_interest = `true`,
		bool	parm_interest = `true`,
		bool	flag_interest = `true`
	)			const

void OP_Node::getExtraOutputNodes	(	OP_NodeList &	extras,
		bool	remove_duplicates = `true`,
		bool	data_interest = `true`,
		bool	parm_interest = `true`,
		bool	flag_interest = `true`
	)			const

virtual const char* OP_Node::getFileExtension ( int binary ) const [protected, pure virtual]

Implemented in CHOP_Node, DOP_Node, MGR_Node, OBJ_Node, OP_Director, POPNET_Node, SHOP_Node, VOP_Node, and VOPNET_Node.

OP_Node* OP_Node::getFirstExecLicenseOnlyAncestor ( bool ignore_self = true ) const

virtual int OP_Node::getFlag ( char tag ) const [virtual]

static fpreal OP_Node::getFlagWidth ( ) [static, protected]

The following methods and booleans are to be used to implement getW() and getH() in sub-classes. They're not of general utility. All of these are in absolute, pan-and-scale independent UI units. Get the width of flags depending on whether we're currently in "small mode" or not.

int OP_Node::getFootprint ( ) const [inline]

Definition at line 1124 of file OP_Node.h.

static int OP_Node::getGlobbedNetworkBoxes	(	OP_Node *	cwd,
		UT_String &	holder,
		const char *	pattern,
		UT_WorkArgs &	argv,
		OP_GlobContext *	context
	)			`[static]`

static int OP_Node::getGlobbedNodes	(	OP_Node *	cwd,
		UT_String &	holder,
		const char *	pattern,
		UT_WorkArgs &	argv,
		OP_GlobContext *	context
	)			`[static]`

static int OP_Node::getGlobbedPostIts	(	OP_Node *	cwd,
		UT_String &	holder,
		const char *	pattern,
		UT_WorkArgs &	argv,
		OP_GlobContext *	context
	)			`[static]`

virtual fpreal OP_Node::getH ( ) const [virtual]

Node position/scale is used by the UI.

Implements OP_NetworkBoxItem.

Reimplemented in CHOP_Node, COP2_Node, DOP_Node, OBJ_DopNet, OBJ_Node, OBJ_SopNet, OBJ_SubNet, POP_Node, POPNET_Node, ROP_Node, SHOP_Node, SOP_Node, VOP_Node, and VOPNET_Node.

int OP_Node::getHardLock ( ) const [inline]

Definition at line 1023 of file OP_Node.h.

UT_TokenString& OP_Node::getHashCode	(	OP_Context &	context,
		int	group_mask = `1`
	)

virtual int OP_Node::getHasTakeData ( ) const [inline, virtual]

Reimplemented from OP_Parameters.

Definition at line 1130 of file OP_Node.h.

int OP_Node::getHighlight ( ) const [inline]

Definition at line 1121 of file OP_Node.h.

const char* OP_Node::getInfoText	(	OP_Context &	context,
		OP_NodeInfoParms &	parms
	)

Get the info text for this op. This non-virtual function does all the stuff common to all operator types.

Warning:

The return value is the value of the work buffer in the OP_NodeInfoParms. Thus, you should never do

     str = node->getInfoText(context, OP_NodeInfoParms());

Since the lifetime of the temporary may not be long enough to extract the string properly.

OP_Node* OP_Node::getInput	(	unsigned	idx,
		bool	mark_used = `false`
	)			const

Returns the node connected to a particular input (may be null).

Examples:: CHOP/CHOP_Spring.h, DOP/DOP_GroupAndApply.C, SOP/SOP_BrushHairLen.C, and VOP/VOP_Switch.C.

virtual int OP_Node::getInputFromName ( const UT_String & in ) const [virtual]

Note that this function only looks through currently connected inputs for the name, not through all possible input names on this node. mapInputNameToIndex does that instead.

Reimplemented in SHOP_Node, and VOP_Node.

int OP_Node::getInputFromUniqueName ( const OP_ConnectorId & id ) const

virtual void OP_Node::getInputName	(	UT_String &	in,
		int	idx
	)			const `[virtual]`

Reimplemented in SHOP_Node, SHOP_Output, and VOP_Node.

virtual OP_Input* OP_Node::getInputReference	(	unsigned	idx,
		int	grow = `1`
	)			`[virtual]`

Reimplemented in VOP_AutoConvert.

Examples:: VOP/VOP_Switch.C.

virtual OP_Input* OP_Node::getInputReferenceConst ( unsigned idx ) const [virtual]

Reimplemented in VOP_AutoConvert.

virtual void OP_Node::getInputRes	(	int	input,
		fpreal	t,
		const OP_Context &	context,
		OP_Context &	input_context
	)			`[virtual]`

Reimplemented in COP2_Node.

unsigned OP_Node::getInputsArraySize ( ) [inline]

Definition at line 2361 of file OP_Node.h.

virtual OP_Node* OP_Node::getInputToHash ( int i ) [virtual]

virtual OP_Operator* OP_Node::getInternalOperator ( ) const [inline, virtual]

Reimplemented in VOPNET_Node.

Definition at line 992 of file OP_Node.h.

virtual const char* OP_Node::getInternalOpTable ( ) const [inline, virtual]

Reimplemented in VOPNET_Node.

Definition at line 990 of file OP_Node.h.

bool OP_Node::getIsContainedBy ( const OP_Node * testparent ) const

bool OP_Node::getIsEditableAssetSubNode ( ) const

bool OP_Node::getIsRunningInCreateScript ( ) const [protected]

virtual bool OP_Node::getIsVisible ( int idx ) [virtual]

Reimplemented in VOP_Node.

virtual const UT_String& OP_Node::getItemName ( ) const [inline, virtual]

Basically the same as OP_Node::getName(), but abstracted to a higher level so we can call it on all items.

Implements OP_NetworkBoxItem.

Definition at line 2157 of file OP_Node.h.

virtual OP_ItemType OP_Node::getItemType ( ) const [virtual]

Our children should implement this and return what type of item they are.

Implements OP_NetworkBoxItem.

int OP_Node::getIWorldTransform	(	UT_Matrix4 &	xform,
		OP_Context &
	)

virtual int OP_Node::getIWorldTransform	(	UT_DMatrix4 &	xform,
		OP_Context &
	)			`[virtual]`

Reimplemented in DOP_Node, and OBJ_Node.

Examples:: SOP/SOP_HDKObject.C.

OP_Node* OP_Node::getLastExecLicenseOnlyAncestor ( bool ignore_self = true ) const

OP_OTLLicenseType OP_Node::getLicense ( ) const

void OP_Node::getLocalVarNames ( UT_StringArray & out_vars )

Retrieve a sorted list of local variables visible to this OP_Node.

int OP_Node::getLock ( ) const [inline]

Definition at line 1024 of file OP_Node.h.

static UT_XformOrder::rstOrder OP_Node::getMainOrder ( int trs ) [static]

Translate a TRS parameter menu index into the UT_XformOrder type.

static int OP_Node::getMainOrderMenuIndex ( UT_XformOrder::rstOrder order ) [static]

Translate a UT_XformOrder type into a TRS parameter menu index (inverse of getMainOrder())

virtual int OP_Node::getMapping	(	int	idx,
		const char *&	label
	)			const `[virtual]`

Reimplemented in CHOP_Node.

int OP_Node::getMatchesOTLDefinition ( ) const

Interface to flag that specifies whether or not we match our definition.

virtual bool OP_Node::getMaterialIconAllowRegenerateFlag ( ) [inline, virtual]

Reimplemented in SHOP_Node.

Definition at line 2253 of file OP_Node.h.

virtual UT_String* OP_Node::getMaterialIconFilename ( ) [inline, virtual]

Reimplemented in SHOP_Node.

Definition at line 2250 of file OP_Node.h.

virtual IMG_Raster* OP_Node::getMaterialIconImage ( ) [inline, virtual]

Reimplemented in SHOP_Node.

Definition at line 2252 of file OP_Node.h.

virtual int64 OP_Node::getMemUsage ( UT_Bool onlythis ) const [virtual]

Reimplemented from OP_Parameters.

int OP_Node::getModelLock ( ) const

int OP_Node::getModified ( ) const [inline]

Definition at line 1127 of file OP_Node.h.

void OP_Node::getMotionEffectsNetworkPath ( UT_String & path )

Returns the a chop network path suitable for storing motion effects associated with this node.

virtual void OP_Node::getMyExternalReferences	(	UT_StringArray &	reflist,
		UT_StringArray *	nodelist = `0`,
		bool	collapse = `false`,
		bool	check_missing = `false`,
		bool	show_missing_only = `false`
	)			`[protected, virtual]`

Reimplemented in COP2_Node.

OP_Node* OP_Node::getNamedInput	(	const OP_ConnectorId &	input_name,
		bool	mark_used = `false`
	)			const

OP_Input* OP_Node::getNamedInputReference	(	const OP_ConnectorId &	input_name,
		bool	grow = `true`
	)

OP_Input* OP_Node::getNamedInputReferenceConst ( const OP_ConnectorId & input_name ) const

const OP_Node* OP_Node::getNamedOutput	(	unsigned	idx,
		const OP_ConnectorId *	output_name = `NULL`
	)			const

OP_Node* OP_Node::getNamedOutput	(	unsigned	idx,
		const OP_ConnectorId *	output_name = `NULL`
	)

static int OP_Node::getNameSerialIndex ( ) [static]

virtual int OP_Node::getNchildren ( ) const [virtual]

Reimplemented in OP_Network.

Examples:: ROP/ROP_Dumper.C.

const UT_String& OP_Node::getNetName ( ) const

Return the name of this node's parent.

virtual int OP_Node::getNetOverviewColor ( UT_Color & color ) [virtual]

Reimplemented in CHOP_Node, COP2_Node, POP_Node, and SOP_Node.

int OP_Node::getNetworkLock	(	bool	relaxedlockcheck = `false`,
		const OP_Node *	inputNode = `NULL`
	)			const

static fpreal OP_Node::getNodeButtonWidth ( ) [static, protected]

Get the default width of the "node button" (the part of the node that you can drag and click on that isn't flags).

static fpreal OP_Node::getNodeHeight ( ) [static, protected]

Get the default node height based on the current flag width.

OP_Node* OP_Node::getNodeOrCreateProxy ( const UT_String & op_path ) [protected]

virtual void OP_Node::getNodeSpecificInfoText	(	OP_Context &	context,
		OP_NodeInfoParms &	parms
	)			`[virtual]`

Reimplemented in CHOP_Node, COP2_Node, DOP_Auto, DOP_Node, OBJ_Bone, OBJ_Fetch, OBJ_Node, POP_Node, POPNET_Node, ROP_IFD, ROP_Node, SOP_ForEach, SOP_MDD, SOP_Node, VOP_Node, VOP_ParmGenerator, VOPNET_Node, and HDK_Sample::SOP_PrimVOP.

void OP_Node::getNonSubnetOutputs ( OP_NodeList & nodes ) const

Obtain the list of outputs from this node. If any of them are subnets, this function will return the actual connected node inside them.

int OP_Node::getNthConnectedInput ( int n ) const

Gets the index of the Nth non-null connection to this node.

int OP_Node::getNumExtraInputs ( ) const

virtual int OP_Node::getNumInputsToHash ( ) [virtual]

static int OP_Node::getNumUniqueIds ( ) [inline, static]

Definition at line 599 of file OP_Node.h.

virtual unsigned OP_Node::getNumVisibleInputs ( ) const [virtual]

Number of input connectors that should be visible on a node. This is only used by VOPs and DOPs. All other OPs return maxInputs() here.

Reimplemented in SHOP_Output, SHOP_VariableInput, VOP_AutoConvert, VOP_ParmGenerator, VOP_Properties, VOP_SubnetOutput, VOP_VariableInput, HDK_Sample::VOP_CustomVop, and HDK_Sample::VOP_Switch.

virtual unsigned OP_Node::getNumVisibleOutputs ( ) const [virtual]

Number of output connections that should be visible on a node tile. Only used by VOPs and DOPs.

Reimplemented in DOP_SubNet, SHOP_Output, VOP_AutoConvert, VOP_OutputVar, VOP_Properties, and HDK_Sample::VOP_CustomVop.

const OP_DependencyList& OP_Node::getOpDependents ( ) const [inline]

Definition at line 1490 of file OP_Node.h.

static const OP_TypeInfo* OP_Node::getOpInfoFromOpTypeID ( OP_OpTypeId opid ) [static]

static const OP_TypeInfo* OP_Node::getOpInfoFromOpTypeName ( const char * name ) [static]

static const OP_TypeInfo* OP_Node::getOpInfoFromScriptDir ( const char * dir ) [static]

static const OP_TypeInfo* OP_Node::getOpInfoFromTableName ( const char * name ) [static]

virtual const char* OP_Node::getOpType ( ) const [pure virtual]

Implemented in CHOP_Node, COP2_Node, DOP_Node, MGR_Node, OBJ_Node, OP_Director, POP_Node, POPNET_Node, ROP_Node, SHOP_Node, SOP_Node, VOP_Node, and VOPNET_Node.

virtual OP_OpTypeId OP_Node::getOpTypeID ( ) const [pure virtual]

This returns the OP_OpTypeId which corresponds to this node type. Management nodes will return the type they really are, which is likely different than the network they currently reside in.

Implemented in CHOP_Node, COP2_Node, DOP_Node, MGR_Node, OBJ_Node, OP_Director, POP_Node, POPNET_Node, ROP_Node, SHOP_Node, SOP_Node, VOP_Node, and VOPNET_Node.

Examples:: SOP/SOP_CopRaster.C, and SOP/SOP_HDKObject.C.

virtual const char* OP_Node::getOTLSubType ( ) [inline, virtual]

Returns the sub type name, if the node's operator wants to be saved as an OTL in a special way (ie, other than the regular scripted operator handling). The sub type name is then used to distinguish how to handle the HDA creation.

Definition at line 2108 of file OP_Node.h.

const OP_Node* OP_Node::getOutput	(	unsigned	idx,
		int	outputIdx = `-1`
	)			const

OP_Node* OP_Node::getOutput	(	unsigned	idx,
		int	outputIdx = `-1`
	)

Examples:: standalone/traverse.C.

virtual int OP_Node::getOutputFromName ( const UT_String & out ) const [virtual]

Reimplemented in SHOP_Node, and VOP_Node.

int OP_Node::getOutputFromUniqueName ( const OP_ConnectorId & id ) const

virtual void OP_Node::getOutputName	(	UT_String &	out,
		int	idx
	)			const `[virtual]`

Reimplemented in SHOP_Node, and VOP_Node.

OP_Node* OP_Node::getOutputTowardsNode ( const OP_Node * target )

virtual void OP_Node::getOwnedMicroNodes ( DEP_MicroNodeList & micronodes ) [virtual]

Subclasses should override this provide any additional micronodes that they own. This list is used in places such as node deletion so that dependents are dirtied.

Reimplemented in OBJ_DopNet.

virtual void OP_Node::getParallelInputs	(	OP_Context &	context,
		OP_NodeList &	nodes
	)			const `[virtual]`

Override this to specify the inputs which are needed for cooking this node which can be executed in parallel.

Reimplemented in OBJ_BlendSticky, OBJ_Node, and OBJ_SubNet.

OP_Network* OP_Node::getParent ( ) const [inline]

Examples:: CHOP/CHOP_Stair.C.

Definition at line 457 of file OP_Node.h.

virtual OP_Network* OP_Node::getParentNetwork ( ) const [virtual]

Returns the network that is our parent.

Implements OP_NetworkBoxItem.

Reimplemented in VOP_AutoConvert.

OP_Bundle* OP_Node::getParmBundle	(	const char *	parm_name,
		int	vector_index,
		UT_String &	pattern,
		OP_Network *	creator,
		const char *	filter
	)

virtual UT_TokenString& OP_Node::getParmHashCode	(	OP_Context &	context,
		int	group_mask = `1`
	)			`[virtual]`

Reimplemented in COP2_Node.

void OP_Node::getParmsThatReference	(	const char *	channame,
		UT_PtrArray< PRM_Parm * > &	parms,
		UT_IntArray &	parmsubidxs
	)

virtual void OP_Node::getPathWithSubnet ( UT_String & str ) const [virtual]

Returns the path of this node relative to its getCreator().

Reimplemented in VOP_AutoConvert.

virtual int OP_Node::getPickable ( ) [virtual]

Reimplemented in OBJ_Node.

OP_Node* OP_Node::getPickableSelfOrParent ( )

virtual int OP_Node::getPicked ( ) const [inline, virtual]

Implements OP_NetworkBoxItem.

Definition at line 1115 of file OP_Node.h.

void OP_Node::getPickedChildren	(	OP_NodeList &	picked,
		bool	include_hidden = `false`
	)			const

static UT_Vector3R OP_Node::getPivotParmValue	(	int	trs,
		fpreal	tx,
		fpreal	ty,
		fpreal	tz,
		fpreal	px,
		fpreal	py,
		fpreal	pz
	)			`[static]`

POP_Node* OP_Node::getPOPNode	(	const char *	path,
		int	addextra = `0`
	)			const

virtual void OP_Node::getPostParmSaveFlagsString ( UT_String & cmd ) const [virtual]

Reimplemented in OBJ_Node.

virtual void OP_Node::getPreParmSaveFlagsString ( UT_String & cmd ) const [virtual]

Reimplemented in OBJ_Node.

virtual UT_Ramp* OP_Node::getRamp ( ) [virtual]

virtual int OP_Node::getRelativeCaptureTransform	(	OP_Node &	to,
		UT_DMatrix4 &	xform,
		OP_Context &	context
	)			`[virtual]`

Reimplemented in OBJ_Bone.

virtual int OP_Node::getRelativeCaptureTransform	(	OP_Node &	to,
		UT_Matrix4 &	xform,
		OP_Context &	context
	)			`[virtual]`

Reimplemented in OBJ_Bone.

void OP_Node::getRelativePathTo	(	const OP_Node *	base_node,
		UT_String &	result
	)			const

Returns the path of this node relative to 'base_node'.

virtual int OP_Node::getRelativeTransform	(	OP_Node &	to,
		UT_DMatrix4 &	xform,
		OP_Context &	context
	)			`[virtual]`

Reimplemented in OBJ_Node.

virtual int OP_Node::getRelativeTransform	(	OP_Node &	to,
		UT_Matrix4 &	xform,
		OP_Context &	context
	)			`[virtual]`

Get the transform from this node's space to the 'to' node's space. Returns 1 if this was possible, 0 otherwise (e.g. failure to cook).

Reimplemented in OBJ_Node.

int OP_Node::getRender ( ) const [inline]

Definition at line 1120 of file OP_Node.h.

OP_Network* OP_Node::getRootCompiledParent ( ) const [inline]

Definition at line 458 of file OP_Node.h.

ROP_Node* OP_Node::getROPNode	(	const char *	path,
		int	addextra = `0`
	)			const

virtual void OP_Node::getRotations	(	fpreal	t,
		fpreal &	rx,
		fpreal &	ry,
		fpreal &	rz
	)			`[virtual]`

Reimplemented in OBJ_Node.

static UT_XformOrder::xyzOrder OP_Node::getRotOrder ( int xyz ) [static]

Translate a XYZ parameter menu index into the UT_XformOrder type.

static int OP_Node::getRotOrderMenuIndex ( UT_XformOrder::xyzOrder order ) [static]

Translate a UT_XformOrder type into a XYZ parameter menu index (inverse of getRotOrder())

int OP_Node::getSaveBypass ( ) const [inline]

Definition at line 1128 of file OP_Node.h.

int OP_Node::getSaveData ( ) const [inline]

Definition at line 1129 of file OP_Node.h.

virtual void OP_Node::getSaveFlagsString	(	UT_String &	cmd,
		const char *	flags,
		bool	save_to_hip
	)			const `[virtual]`

Reimplemented in OBJ_Node.

virtual bool OP_Node::getSaveWithVopnets ( ) [virtual]

Reimplemented in OP_Network.

virtual bool OP_Node::getScriptMaterialInfo	(	UT_String &	mat_info,
		VOP_ScriptMaterialCodeMapper *	mapper
	)			`[inline, virtual]`

This function returns a string that encodes all the necessary information about a node-based material that helps the script-based materials to function properly. The string usually encodes info stored on child nodes, such as rendering properties or procedurals. Then the script node can use that info to provide necessary data for rendering. Returns true if the method provides usable information.

Definition at line 2100 of file OP_Node.h.

static bool OP_Node::getSmallMode ( ) [static]

int OP_Node::getSoftLock ( ) const [inline]

Definition at line 1022 of file OP_Node.h.

SOP_Node* OP_Node::getSOPNode	(	const char *	path,
		int	addextra = `0`
	)			const

Examples:: SOP/SOP_HDKObject.C.

int OP_Node::getSourceCount ( void ) const [protected]

static bool OP_Node::getStringParmOpPath	(	PRM_Parm &	parm,
		int	vi,
		UT_String &	oppath,
		int	thread
	)			`[static, protected]`

OP_ERROR OP_Node::getSyncErrorLevel ( ) const [inline]

Returns the error level generated in our last synchronization attempt.

Definition at line 1611 of file OP_Node.h.

const UT_String& OP_Node::getSyncErrors ( ) const [inline]

Returns the error string where we keep all errors generated during our most recent synchronization attempt.

Definition at line 1608 of file OP_Node.h.

int OP_Node::getTemplate ( ) const [inline]

Definition at line 1123 of file OP_Node.h.

virtual fpreal OP_Node::getTimeTransform	(	int	input,
		fpreal	t
	)			`[virtual]`

Reimplemented in COP2_Node.

virtual CH_Channel* OP_Node::getTrackChannel ( const char * name ) [virtual]

Reimplemented in CHOP_Node.

virtual int OP_Node::getTranslateParmIndex ( ) [virtual]

Reimplemented in SOP_Curve.

TInputsIterator OP_Node::getTraverseEndIterator ( void )

int OP_Node::getUniqueId ( ) const [inline]

Definition at line 606 of file OP_Node.h.

void OP_Node::getUniqueInputName	(	OP_ConnectorId &	id_out,
		int	idx,
		bool	disable_creation = `false`
	)

void OP_Node::getUniqueOutputName	(	OP_ConnectorId &	id_out,
		int	idx
	)

int OP_Node::getUnload ( ) const

bool OP_Node::getUserData	(	const char *	key,
		std::string &	result
	)

OP_VERSION OP_Node::getVersionParms ( ) const [inline]

Definition at line 1567 of file OP_Node.h.

virtual bool OP_Node::getVisible ( ) const [virtual]

Reimplemented in OBJ_Node.

virtual VOP_CodeGenerator* OP_Node::getVopCodeGenerator ( ) [inline, virtual]

Reimplemented in VOPNET_Node, and HDK_Sample::SOP_PrimVOP.

Definition at line 2080 of file OP_Node.h.

virtual fpreal OP_Node::getW ( ) const [virtual]

Node position/scale is used by the UI.

Implements OP_NetworkBoxItem.

Reimplemented in CHOP_Node, COP2_Node, DOP_Node, OBJ_DopNet, OBJ_Node, OBJ_SopNet, OBJ_SubNet, POP_Node, POPNET_Node, ROP_Node, SHOP_Node, SOP_Node, VOP_Node, and VOPNET_Node.

int OP_Node::getWorldTransform	(	UT_Matrix4 &	xform,
		OP_Context &
	)

virtual int OP_Node::getWorldTransform	(	UT_DMatrix4 &	xform,
		OP_Context &
	)			`[virtual]`

Reimplemented in DOP_Node, and OBJ_Node.

Examples:: SOP/SOP_HDKObject.C.

virtual fpreal OP_Node::getX ( ) const [inline, virtual]

Node position/scale is used by the UI.

Implements OP_NetworkBoxItem.

Definition at line 534 of file OP_Node.h.

virtual void OP_Node::getXformOrder	(	UT_XformOrder &	xord,
		CH_Channel *	chp
	)			`[virtual]`

Reimplemented in OBJ_Node, SOP_Edit, SOP_UVEdit, and SOP_UVTransform.

Examples:: SOP/SOP_IKSample.C.

static UT_Vector3R OP_Node::getXformPivot	(	int	trs,
		fpreal	tx,
		fpreal	ty,
		fpreal	tz,
		fpreal	px,
		fpreal	py,
		fpreal	pz
	)			`[static]`

int OP_Node::getXray ( ) const [inline]

Definition at line 1125 of file OP_Node.h.

virtual fpreal OP_Node::getY ( ) const [inline, virtual]

Node position/scale is used by the UI.

Implements OP_NetworkBoxItem.

Definition at line 535 of file OP_Node.h.

void OP_Node::globChannels	(	const char *	pattern,
		CH_ChannelList &	clist,
		OP_GlobContext *	context = `0`,
		OP_Node *	dependent = `0`
	)

void OP_Node::globChannels	(	const char *	,
		UT_String &	expand,
		OP_GlobContext *	context = `0`,
		const char *	prefix = `" "`
	)			const

void OP_Node::globChanRefs	(	const char *	pattern,
		CH_ChannelRefList &	list,
		OP_GlobContext *	context = `0`,
		OP_Node *	dependent = `0`
	)

virtual void OP_Node::globNetworkBoxes	(	const char *	pat,
		UT_String *	expand,
		UT_PtrArray< OP_NetworkBox * > *	list = `0`,
		OP_GlobContext *	glob_context = `0`,
		const char *	prefix = `" "`
	)			`[virtual]`

Same as 'globNodes', except for network boxes. This is to be implemented by OP_Network, but has been put here so it can be called directly on OP_Node like all the other "glob" methods without a cast

Reimplemented in OP_Network.

void OP_Node::globNodeChannels	(	const char *	pattern,
		CH_ChannelList &	list,
		OP_GlobContext *	context,
		int *	parm_start = `NULL`,
		UT_IntArray *	parm_indices = `NULL`,
		UT_IntArray *	parm_sub_indices = `NULL`
	)			const

void OP_Node::globNodeChanRefs	(	const char *	pattern,
		CH_ChannelRefList &	list,
		OP_GlobContext *	context,
		int *	parm_start = `NULL`,
		UT_IntArray *	parm_indices = `NULL`,
		UT_IntArray *	parm_sub_indices = `NULL`
	)			const

void OP_Node::globNodeParms	(	const char *	pattern,
		fpreal	t,
		UT_RefArray< opParmData > &	list,
		OP_GlobContext *	context,
		OP_Node *	dependent,
		int	calc_value,
		bool	animated_only
	)

void OP_Node::globNodes	(	const char *	pat,
		UT_String *	expand,
		UT_PtrArray< OP_Node * > *	list = `0`,
		OP_GlobContext *	context = `0`,
		const char *	prefix = `" "`
	)

int OP_Node::globParms	(	const char *	pattern,
		fpreal	t,
		UT_RefArray< opParmData > &	list,
		OP_GlobContext *	context = `0`,
		OP_Node *	dependent = `0`,
		int	calc_value = `1`
	)

virtual void OP_Node::globPostIts	(	const char *	pat,
		UT_String *	expand,
		UT_PtrArray< OP_PostIt * > *	list = `0`,
		OP_GlobContext *	glob_context = `0`,
		const char *	prefix = `" "`
	)			`[virtual]`

Reimplemented in OP_Network.

virtual void OP_Node::handleOpDependency	(	int	referenced_op_id,
		const OP_Dependency &	op_dep,
		OP_InterestType	interest_type,
		bool &	need_cook,
		const char *	old_fullpath,
		const char *	old_cwd,
		const char *	old_chan_name
	)			`[protected, virtual]`

Reimplemented in CHOP_Channel, CHOP_Node, SOP_CaptureBase, SOP_CaptureEdit, SOP_CaptureLayerPaint, and SOP_CaptureOverride.

void OP_Node::handleStringParmOpPathDependency	(	int	parm_index,
		int	vi,
		const char *	new_fullpath,
		const char *	old_fullpath,
		const char *	old_cwd
	)			`[protected]`

virtual bool OP_Node::handleTimeChange ( fpreal ) [inline, virtual]

Reimplemented in SOP_CaptureBase.

Definition at line 1572 of file OP_Node.h.

bool OP_Node::hasAnimatedParms ( ) const

bool OP_Node::hasChopOverriddenParms ( ) const

bool OP_Node::hasComment ( ) const

virtual bool OP_Node::hasDifferentMultiInputs ( ) const [virtual]

Returns whether multi-inputs on this particular op might have different names for each of the inputs, or if the name will always be the same for all the inputs.

Reimplemented in DOP_Node.

bool OP_Node::hasOpDependents ( ) [inline, protected]

Definition at line 2547 of file OP_Node.h.

int OP_Node::hasOpInterest	(	void *	data,
		OP_EventMethod	m
	)			const `[inline]`

Definition at line 1180 of file OP_Node.h.

bool OP_Node::hasParmsNotAtFactoryDefault ( ) const

virtual int OP_Node::hasProxyRefNodes ( ) const [inline, protected, virtual]

Reimplemented in OP_Network.

Definition at line 2549 of file OP_Node.h.

bool OP_Node::hasRefOutputs ( bool recurse_on_implicits = false ) const

bool OP_Node::hasUnorderedInputs ( ) const

Returns true if the operator type says we have unordered inputs.

bool OP_Node::hasUserData ( const char * key )

bool OP_Node::haveAncestorWithoutFullLicense ( bool ignore_self ) const

bool OP_Node::haveCompiledExpressions ( ) const

bool OP_Node::haveLicenseToAccessContents ( OP_Node * opt_specific_child = NULL ) const

bool OP_Node::haveLicenseToAccessParentContents ( ) const

int OP_Node::haveSeenDataModification ( long modification_id ) [protected]

virtual void OP_Node::inputConnectChanged ( int which ) [virtual]

Reimplemented in CHOP_Node, COP2_Generator, OBJ_Muscle, OP_Network, ROP_Node, and SOP_Node.

virtual const char* OP_Node::inputConnectorLabel ( unsigned idx ) [virtual]

Reimplemented in COP2_MaskOp.

virtual const char* OP_Node::inputLabel ( unsigned idx ) const [virtual]

const char* OP_Node::inputLabelNum ( unsigned idx ) const [protected]

OP_ERROR OP_Node::insertIndirectInput	(	unsigned	idx,
		OP_InputIndirect *	input
	)

OP_ERROR OP_Node::insertInput	(	unsigned	idx,
		OP_Node *	op,
		unsigned	outputIdx
	)

OP_ERROR OP_Node::insertNamedIndirectInput	(	const OP_ConnectorId &	input_name,
		OP_InputIndirect *	input
	)

OP_ERROR OP_Node::insertNamedInput	(	const OP_ConnectorId &	input_name,
		OP_Node *	op,
		const OP_ConnectorId *	output_name
	)

int OP_Node::isAncestor	(	const OP_Node *	node,
		int	checkextra = `1`
	)			const `[inline]`

Definition at line 686 of file OP_Node.h.

bool OP_Node::isAutoscope ( ) [inline]

Definition at line 1080 of file OP_Node.h.

int OP_Node::isBeingDeleted ( ) const [inline]

Definition at line 1186 of file OP_Node.h.

int OP_Node::isBlockModify ( void ) const

bool OP_Node::isCompiled ( ) const

bool OP_Node::isCookedTime ( fpreal t ) const [inline, protected]

Definition at line 2740 of file OP_Node.h.

virtual int OP_Node::isCookingRender ( ) const [inline, virtual]

Reimplemented in OBJ_Node, and SOP_Node.

Examples:: SOP/SOP_HDKObject.C.

Definition at line 1894 of file OP_Node.h.

bool OP_Node::isDependentOn	(	OP_Node *	other_node,
		PRM_Parm *	parm
	)

static bool OP_Node::isDirectorDoingBulkNotification ( ) [static]

bool OP_Node::isEffectivelyAManagementNode ( ) const

bool OP_Node::isHashCodeBuilt ( ) const [inline]

Definition at line 1932 of file OP_Node.h.

unsigned OP_Node::isInput ( unsigned idx ) [inline, protected]

Definition at line 2478 of file OP_Node.h.

bool OP_Node::isInputAncestor	(	const OP_Node *	parent,
		bool	check_extra = `true`
	)			const

Check to see whether node is an ancestor of this node in the input hierarchy. Optionally check extra inputs. This method will recurse using getInputs() (and optional getExtraInputNodes()

Note:: This node is considered to be an ancestor of itself

virtual bool OP_Node::isInputConnectedInsideSubnet ( int input_idx ) const [protected, virtual]

This function is currently only used by VOPs. It checks if an input on the subnet is connected inside the subnet. The default implementation here simply returns false to preserve existing behaviour for all other contexts.

virtual int OP_Node::isInSubNetwork ( ) const [virtual]

virtual bool OP_Node::isLoaded ( ) const [inline, virtual]

Reimplemented in SOP_Node.

Definition at line 1047 of file OP_Node.h.

virtual int OP_Node::isManagementNode ( ) const [virtual]

virtual int OP_Node::isManager ( ) const [virtual]

Reimplemented in MGR_Node, and OP_Director.

virtual bool OP_Node::isNamedInputConnectedInsideSubnet ( const OP_ConnectorId & input_name ) const [protected, virtual]

virtual int OP_Node::isNetwork ( ) const [virtual]

Reimplemented in OP_Network.

Examples:: standalone/traverse.C.

int OP_Node::isNetworkWithKids ( ) const

virtual bool OP_Node::isOrderedInput ( const OP_ConnectorId & input_name ) const [virtual]

bool OP_Node::isParentAncestor ( const OP_Node * parent ) const

Check to see whether the parent node is an ancestor of this node in the parent/child hierarchy. That is, this method will call getParent()/getChild() to traverse the hierarchy.

Note:: This node is considered to be an ancestor of itself

virtual bool OP_Node::isParmPendingOverride	(	const char *	parm_name,
		int	vec_idx
	)			const `[virtual]`

Reimplemented from PRM_ParmOwner.

bool OP_Node::isProxyRefNode ( ) const [inline]

Definition at line 646 of file OP_Node.h.

virtual int OP_Node::isRefInput ( unsigned ) const [inline, virtual]

Reimplemented in POP_Node, and SOP_CaptureLayerPaint.

Definition at line 1003 of file OP_Node.h.

virtual int OP_Node::isSubNetwork ( bool includemanagementops ) const [virtual]

bool OP_Node::isTimeDependent ( OP_Context & context )

Returns true if the OP depends on time at the given time. This is sensitive to handleTimeChange's overrides.

static int OP_Node::isValidOpName	(	const char *	s,
		bool	allow_rel_paths = `false`,
		bool	ignore_node_names_env_var = `false`
	)			`[static]`

Set allow_rel_paths to true to accept "." or ".." as valid paths.

static int OP_Node::isValidOpPath ( const char * s ) [static]

virtual int OP_Node::isVex ( ) const [virtual]

virtual bool OP_Node::load	(	UT_IStream &	is,
		const char *	ext = `""`,
		const char *	path = `0`
	)			`[protected, virtual]`

Reimplemented in CHOP_Node, CHOP_Realtime, COP2_Node, OP_Network, SOP_BlendShapes, SOP_CaptureEdit, SOP_CaptureLayerPaint, SOP_CaptureOverride, SOP_GDT, SOP_Node, VOP_Node, HDK_Sample::SOP_BlindData, and HDK_Sample::SOP_CustomBrush.

void OP_Node::loadContentsSection ( ) [protected]

virtual bool OP_Node::loadCookedData	(	UT_IStream &	is,
		const char *	path = `0`
	)			`[virtual]`

Reimplemented in CHOP_Node, and OP_Director.

bool OP_Node::loadExtraInputs	(	UT_IStream &	is,
		const char *	path = `0`
	)

virtual void OP_Node::loadFinished ( ) [protected, virtual]

bool OP_Node::loadInputs	(	UT_IStream &	is,
		const char *	path = `0`
	)

bool OP_Node::loadIntrinsic	(	UT_IStream &	is,
		const char *	path = `0`
	)			`[protected]`

bool OP_Node::loadNamedInputs	(	UT_IStream &	is,
		const char *	path = `0`
	)

bool OP_Node::loadNamedOutputs	(	UT_IStream &	is,
		const char *	path = `0`
	)

bool OP_Node::loadOverride ( UT_IStream & is )

virtual bool OP_Node::loadPacket	(	UT_IStream &	is,
		const char *	token,
		const char *	path = `0`
	)			`[protected, virtual]`

Reimplemented in OBJ_Node, and VOP_Node.

virtual bool OP_Node::loadPacket	(	UT_IStream &	is,
		short	class_id,
		short	sig,
		const char *	path = `0`
	)			`[protected, virtual]`

Reimplemented in OBJ_Node, and VOP_Node.

bool OP_Node::loadRamp	(	UT_IStream &	is,
		UT_Ramp &	ramp,
		const char *	path = `0`
	)

virtual bool OP_Node::loadRamp	(	UT_IStream &	is,
		const char *	path = `0`
	)			`[virtual]`

virtual void OP_Node::loadStart ( ) [protected, virtual]

bool OP_Node::loadUserData	(	UT_IStream &	is,
		const char *	path = `NULL`
	)

bool OP_Node::lockForCooking ( OP_CookLock::Scope & scope )

The cook lock is used to protect per node data structures during cooking. Use it in the following idiom:

 OP_CookLock::Scope scope(getCookLock(), /*acquire=*/false);
 if (!lockForCooking(scope))
 {
     UTaddDeadlockError();
     return false;
 }

virtual OP_ERROR OP_Node::lockInput	(	unsigned	idx,
		OP_Context &	context
	)			`[virtual]`

Reimplemented in SOP_Node.

virtual OP_ERROR OP_Node::lockInputs ( OP_Context & context ) [virtual]

Reimplemented in SOP_Node.

Examples:: POP/POP_CircleForce.C, POP/POP_LocalForce.C, POP/POP_RadialBirth.C, and POP/POP_SpotLight.C.

static OP_Node* OP_Node::lookupNode	(	int	unique_id,
		bool	include_proxy = `false`
	)			`[inline, static]`

Examples:: SOP/SOP_CopRaster.C, and SOP/SOP_CustomBrush.C.

Definition at line 588 of file OP_Node.h.

void OP_Node::markBundleRefsAsUnused ( )

virtual OP_Node* OP_Node::matchChild	(	const char *	pattern,
		OP_Node *	prevmatch = `0`,
		const char *	optype = `0`,
		int	casesensitive = `0`
	)			const `[virtual]`

virtual OP_Node* OP_Node::matchChildBackwards	(	const char *	pattern,
		OP_Node *	prevmatch = `0`,
		const char *	optype = `0`,
		int	casesensitive = `0`
	)			const `[virtual]`

bool OP_Node::matchesState ( const char * state ) const

virtual void OP_Node::matchOTLDefinition ( ) [virtual]

Matches the node to the current HDA definition, loading the contents section if ncecessary and setting the match flag.

virtual unsigned OP_Node::maxInputs ( ) const [virtual]

Maximum inputs that can be connected to a node.

Reimplemented in SHOP_Output, and VOP_OutputVar.

virtual unsigned OP_Node::maxOutputs ( ) const [virtual]

Maximum number of output connectors on a node. Only VOPs and DOPs ever return a value other than 1 here.

Reimplemented in MGR_Node, POPNET_Node, and VOPNET_Node.

virtual unsigned OP_Node::minInputs ( ) const [virtual]

Minimum inputs that must be connected to a node for it to cook.

static void OP_Node::moveAndUpdateDependencies	(	const OP_NodeList &	src_nodes,
		const OP_NodeList &	dest_nodes
	)			`[static]`

virtual void OP_Node::moveDependencies ( OP_Node * from_node ) [protected, virtual]

Reimplemented in OP_Network.

virtual void OP_Node::moveInput	(	int	srcidx,
		int	dstidx,
		bool	forcesubnet = `false`
	)			`[virtual]`

Reimplemented in VOP_Node, and VOP_SubnetOutput.

virtual void OP_Node::moveProxyRefNodes ( OP_Network * ) [inline, protected, virtual]

Reimplemented in OP_Network.

Definition at line 2551 of file OP_Node.h.

unsigned OP_Node::nConnectedInputs ( ) const

virtual unsigned OP_Node::needToCook	(	OP_Context &	context,
		bool	queryonly = `false`
	)			`[virtual]`

Determines if this node needs to cook.

The queryonly flag will not flag this as a read attempt to the caching mechanisms, and thus not update the touch time.

virtual unsigned OP_Node::nInputs ( ) const [virtual]

Returns the index of the last connected input incremented by one. If there are no inputs connected, returns 0. This means that the function behaves as if the lasted connected input was always the last entry in the inputs array. Note that other array entries up to the index of the one returned may contain null entries, so this is not necessarily the same as the number of connections. Also note that there may be more null entries at indices beyond the returned one.

Reimplemented in VOP_ParmGenerator.

Examples:: CHOP/CHOP_Blend.C, COP2/COP2_MultiInputWipe.C, standalone/traverse.C, and VOP/VOP_Switch.C.

virtual void OP_Node::nodeDeleted	(	OP_Node *	op,
		int	propagate = `1`
	)			`[protected, virtual]`

virtual void OP_Node::nodeUnlocked ( ) [inline, protected, virtual]

Reimplemented in CHOP_Node, and OP_Network.

Definition at line 2670 of file OP_Node.h.

void OP_Node::notifyNodeDeletion ( ) [protected]

void OP_Node::notifyOpDependents	(	OP_InterestType	interest,
		bool	recurse
	)			`[protected]`

virtual void OP_Node::notifyParmRenameDependents	(	const UT_String &	chan_name,
		const UT_String &	old_chan_name
	)			`[virtual]`

virtual void OP_Node::notifyRenameDependents	(	const UT_String &	full_from,
		OP_NodeList &	cook_nodes
	)			`[protected, virtual]`

Reimplemented in OP_Network.

void OP_Node::notifyRenameDependents ( const UT_String & full_from ) [protected]

virtual void OP_Node::notifyRenameReferences	(	const UT_String &	full_from,
		OP_NodeList &	cook_nodes
	)			`[protected, virtual]`

Reimplemented in OP_Network.

void OP_Node::notifyRenameReferences ( const UT_String & full_from ) [protected]

bool OP_Node::notifyVarChange	(	const char *	varname,
		OP_NodeList *	changed_nodes = `NULL`
	)

Mark this node, its descendants, and all data dependents containing varname as being dirty. If changed_nodes is non-NULL, then it is updated with the list of dirtied nodes which contains varname. Returns true iff at least one node was dirtied.

unsigned OP_Node::nOutputEntries ( ) const

Returns the number of output entries in the output array. Note that this done regardless of which entries have any outputs connected.

unsigned OP_Node::nOutputs ( int outputIdx = -1 ) const

Examples:: standalone/traverse.C.

unsigned OP_Node::nOutputsNamed ( const OP_ConnectorId * output_name = NULL ) const

virtual void OP_Node::onCreated ( void ) [inline, virtual]

Overriden in VOPs.

Reimplemented in VOP_Node.

Definition at line 2335 of file OP_Node.h.

virtual void OP_Node::onInputAllocated	(	OP_Input *	new_input,
		int	index
	)			`[inline, protected, virtual]`

Overriden in VOPs.

Reimplemented in VOP_Node.

Definition at line 2795 of file OP_Node.h.

virtual void OP_Node::opChanged	(	OP_EventType	reason,
		void *	data = `0`
	)			`[virtual]`

Implements OP_Parameters.

Reimplemented in CHOP_Node, COP2_Node, DOP_Node, OBJ_DopNet, OBJ_Node, OBJ_SubNet, POPNET_Node, SHOP_VariableInput, SOP_Node, VOP_Node, VOP_ParmGenerator, VOP_Properties, VOP_ScriptNode, VOPNET_Node, and HDK_Sample::SOP_PrimVOP.

virtual bool OP_Node::opShouldHandleChange ( OP_EventType reason ) [virtual]

Reimplemented in OP_Network.

virtual unsigned OP_Node::orderedInputs ( ) const [virtual]

Returns the number of ordered inputs on a node with unordered inputs. Even nodes with unordered inputs can have a few ordered inputs before the unordered inputs start. If hasUnorderedInputs returns false, this function is meaningless.

Reimplemented in SHOP_Output, SHOP_VariableInput, VOP_Properties, VOP_VariableInput, and HDK_Sample::VOP_Switch.

virtual int OP_Node::outputCode	(	OP_OutputCodeParms &	,
		OP_Context &
	)			`[virtual]`

virtual const char* OP_Node::outputLabel ( unsigned idx ) const [virtual]

Reimplemented in VOP_AutoConvert, VOP_ParmGenerator, VOP_Properties, VOP_ScriptNode, VOP_VariableInput, HDK_Sample::VOP_CustomVop, and HDK_Sample::VOP_Switch.

const char* OP_Node::outputLabelNum ( unsigned idx ) const [protected]

static bool OP_Node::parallelCook	(	OP_Context &	context,
		const OP_NodeList &	nodes
	)			`[static]`

Cook the given node list in parallel.

bool OP_Node::parallelCook ( OP_Context & context )

Schedule a task for cooking this node in parallel and wait for it to finish. Returns true upon success, false otherwise.

DEP_MicroNode& OP_Node::parmMicroNode	(	int	parm_idx,
		int	vi
	)			`[inline]`

Definition at line 1315 of file OP_Node.h.

bool OP_Node::patternContainsBundle	(	const char *	pattern,
		const OP_Bundle *	bundle
	)			const

bool OP_Node::patternContainsGroup	(	const char *	pattern,
		const OP_Group *	group
	)			const

virtual void OP_Node::permissionError ( const char * chname = 0 ) [protected, virtual]

Reimplemented from OP_Parameters.

void OP_Node::pickRequest ( int shift )

Reimplemented in OP_Network.

virtual void OP_Node::preDelete ( ) [inline, virtual]

Overriden in VOPs to remove any channel refrences we may have to the node being deleted.

Reimplemented in VOP_ParmGenerator.

Definition at line 2070 of file OP_Node.h.

static void OP_Node::printOpMemoryUsageStats ( ostream & os ) [static]

virtual UT_ErrorSeverity OP_Node::prmCookOverrides	(	fpreal	t,
		int	thread,
		const char *	parm_name,
		int	vec_idx
	)			`[virtual]`

Reimplemented from PRM_ParmOwner.

void OP_Node::propagateDirtyMicroNode	(	DEP_MicroNode &	micronode,
		OP_EventType	reason,
		void *	data,
		bool	send_root_event
	)

Explicitly propagate dirtiness for a particular micronode owned by some node.

virtual void OP_Node::propagateEndBlockModify ( ) [virtual]

Reimplemented in OBJ_Node.

static void OP_Node::propagateMatchOTLDefinitionToAncestors	(	OP_Node *	node,
		bool	sync_flag
	)			`[static]`

Utility function for syncing/unsyncing all uncestor nodes.

virtual int OP_Node::propagateModification	(	OP_Node *	by_whom,
		OP_EventType	reason,
		int	parm_index,
		OP_PropagateData &	prop_data
	)			`[protected, virtual]`

Reimplemented in OP_Network.

virtual OP_ERROR OP_Node::pubCookInputGroups	(	OP_Context &	context,
		int	alone = `0`
	)			`[virtual]`

Reimplemented in SOP_Node.

virtual void OP_Node::pushAsPwdAndRunPython	(	PY_CompiledCode &	compiled_code,
		PY_Result::Type	desired_result_type,
		PY_Result &	result,
		PY_EvaluationContext *	context = `NULL`
	)			const `[virtual]`

Implements PRM_ParmOwner.

RampError OP_Node::rampCommand	(	bool	remove,
		fpreal	pos,
		float	rgba[4],
		UT_Ramp &	ramp
	)

virtual RampError OP_Node::rampCommand	(	bool	remove,
		fpreal	pos,
		float	rgba[4]
	)			`[virtual]`

virtual void OP_Node::rebuildOpDependents ( bool proxy_only ) [protected, virtual]

Reimplemented in OP_Network.

virtual void OP_Node::rebuildParmDependency ( int parm_index ) [virtual]

Implements PRM_ParmOwner.

void OP_Node::recomputeCompiledHash ( )

virtual void OP_Node::referencedParmChanged ( int pi ) [virtual]

Reimplemented in DOP_Node, OBJ_DopNet, OBJ_SubNet, and VOP_Node.

virtual void OP_Node::refreshRepresentativeNode ( OP_Node & changed_child ) [protected, virtual]

virtual void OP_Node::reloadExternalFiles ( ) [virtual]

This method causes any operators that load files to recook. By default, this searches for 'file' operators by iterating through inputs. Parms of type PRM_FILE are also marked dirty. Other nodes that load files differently may wish to override this method.

virtual int OP_Node::removeOpDependent	(	int	op_id,
		OP_InterestType	mask = `OP_INTEREST_ALL`
	)			`[protected, virtual]`

virtual int OP_Node::removeOpDependent	(	int	op_id,
		const PRM_RefId &	ref_id,
		OP_InterestType	mask = `OP_INTEREST_ALL`
	)			`[protected, virtual]`

removeOpDependent() returns the number of dependents removed

void OP_Node::removeOpInterest	(	void *	data,
		OP_EventMethod	m
	)			`[inline]`

Examples:: VOP/VOP_CustomContext.C.

Definition at line 1184 of file OP_Node.h.

virtual void OP_Node::removeOverrideDestination	(	OP_Node *	,
		int
	)			`[inline, virtual]`

Definition at line 1743 of file OP_Node.h.

virtual void OP_Node::removeOverrideDestination ( OP_Node * ) [inline, virtual]

Definition at line 1742 of file OP_Node.h.

void OP_Node::renameInput	(	OP_Input *	input,
		int	new_id
	)			`[protected]`

void OP_Node::renameOutput	(	OP_Output *	output,
		int	new_id
	)			`[protected]`

static void OP_Node::repositionOpsMaxY	(	OP_NodeList &	ops,
		UT_PtrArray< OP_NetworkBox * > &	netboxes,
		fpreal	x,
		fpreal	y
	)			`[static]`

Move the upper-left most node in 'ops' to x-coordinate 'x' and to have its TOP border at y-coordinate 'y', and move all other nodes in 'ops' by the same amount. All netboxes in 'netboxes' will also be moved that amount. If a netbox's top border is higher than any node's top border, everything will be moved down accordingly. Note that the repositioning calculation does not include the nodes contained in the network boxes in 'netboxes'.

virtual void OP_Node::resolveAndDeleteObsoleteParmList ( PRM_ParmList *& obsolete_parms ) [virtual]

Reimplemented from OP_Parameters.

virtual const CH_LocalVariable* OP_Node::resolveExtraVariableForSyntaxHighlight ( const char * name ) [virtual]

Reimplemented in POP_LocalVar, and SOP_Node.

void OP_Node::resolveInputReferences ( )

virtual const CH_LocalVariable* OP_Node::resolveVariable ( const char * name ) [virtual]

Reimplemented in SOP_Node.

virtual bool OP_Node::runCreateScript ( ) [virtual]

Reimplemented in SHOP_Node, VOP_Node, and HDK_Sample::VOP_CustomVop.

virtual void OP_Node::runDelScript ( ) [virtual]

Reimplemented in OP_Network.

virtual OP_ERROR OP_Node::save	(	ostream &	os,
		const OP_SaveFlags &	flags,
		const char *	path_prefix = `""`
	)			`[protected, virtual]`

Reimplemented in CHOP_Node, CHOP_Realtime, COP2_Node, SOP_CaptureEdit, SOP_CaptureLayerPaint, SOP_CaptureOverride, SOP_GDT, SOP_Node, VOP_Node, HDK_Sample::SOP_BlindData, and HDK_Sample::SOP_CustomBrush.

void OP_Node::saveChildOverrides	(	ostream &	os,
		OP_Node *	root,
		const UT_String &	rootpath,
		bool &	added
	)

virtual OP_ERROR OP_Node::saveCommand	(	ostream &	os,
		const char *	name,
		fpreal	x,
		fpreal	y,
		const char *	netboxname,
		const OP_SaveCommandOptions &	options
	)			`[virtual]`

Writes to 'os' a string of hscript commands to recreate this node.

virtual int OP_Node::saveCookedData	(	const char *	filename,
		OP_Context &
	)			`[pure virtual]`

Implemented in CHOP_Node, DOP_Node, MGR_Node, OBJ_Node, OP_Director, POPNET_Node, ROP_Node, SHOP_Node, VOP_Node, and VOPNET_Node.

virtual int OP_Node::saveCookedData	(	ostream &	os,
		OP_Context &	,
		int	binary = `0`
	)			`[pure virtual]`

Implemented in CHOP_Node, DOP_Node, MGR_Node, OBJ_Node, OP_Director, POPNET_Node, ROP_Node, SHOP_Node, VOP_Node, and VOPNET_Node.

virtual void OP_Node::saveDialogScriptExtraInfo ( ostream & os ) [virtual]

Reimplemented in OBJ_Camera, OBJ_Light, SHOP_Node, and VOP_Node.

virtual void OP_Node::saveFlagsForUndo ( ) [protected, virtual]

Reimplemented in OBJ_Node.

void OP_Node::saveForUndoColor ( ) [protected]

static void OP_Node::saveForUndoDelete ( OP_NodeList & nodes ) [static, protected]

void OP_Node::saveForUndoInput ( )

void OP_Node::saveForUndoLayout ( ) [protected]

void OP_Node::saveInputs	(	ostream &	os,
		bool	compile_basic
	)

virtual OP_ERROR OP_Node::saveIntrinsic	(	ostream &	os,
		const OP_SaveFlags &	flags
	)			`[protected, virtual]`

Reimplemented in COP2_Node, OBJ_Node, and VOP_Node.

virtual void OP_Node::saveIntrinsicCommand	(	ostream &	os,
		const char *	name
	)			`[virtual]`

Reimplemented in OBJ_Node.

void OP_Node::saveNamedInputs	(	ostream &	os,
		bool	compile_basic
	)

void OP_Node::saveNamedOutputs ( ostream & os )

void OP_Node::saveOutputWires	(	ostream &	os,
		const char *	name,
		int	dogeneral = `0`
	)

void OP_Node::saveOverrides	(	ostream &	os,
		OP_Node *	root,
		const UT_String &	rootpath,
		bool &	added
	)

void OP_Node::saveOverrides ( ostream & os )

void OP_Node::saveParameterFlags	(	ostream &	os,
		const char *	name,
		const char *	command,
		bool(PRM_Parm::*)(int) const	flag_method,
		bool	defaultstoo,
		bool	reverse,
		UT_RefArray< opParmData > *	parm_array
	)

OP_ERROR OP_Node::saveRamp	(	ostream &	os,
		UT_Ramp &	ramp,
		const char *	name = `0`,
		int	command = `0`
	)

OP_ERROR OP_Node::saveUserData	(	ostream &	os,
		const char *	path
	)

void OP_Node::saveUserDataCommand	(	ostream &	os,
		const char *	node_name,
		bool	omit_version = `false`
	)

void OP_Node::saveWires	(	ostream &	os,
		const char *	name,
		int	dogeneral = `0`
	)

void OP_Node::sendEvent	(	OP_EventType	type,
		void *	data = `0`
	)			`[protected]`

void OP_Node::setActiveInputIndex ( unsigned idx )

void OP_Node::setAllChildAssetPermissions ( int permission )

void OP_Node::setAllowBuildDependencies ( int yesno ) [inline, protected]

Definition at line 2678 of file OP_Node.h.

virtual void OP_Node::setAnyUndoFlag ( ) [virtual]

Reimplemented from OP_Parameters.

virtual int OP_Node::setAudio ( int on_off ) [virtual]

Reimplemented in CHOP_Node.

void OP_Node::setAutoscope ( bool on_off ) [inline]

Definition at line 1079 of file OP_Node.h.

int OP_Node::setBypass ( int on_off )

void OP_Node::setCachedPythonObject	(	const char *	key,
		void *	opaque_py_object
	)

bool OP_Node::setChannelAlias	(	PRM_Parm &	parm,
		int	subindex,
		const char *	alias_name
	)

virtual void OP_Node::setChannelScope	(	const char *	pattern,
		OP_ScopeOp	scope_op,
		const OP_ScopeOptions &	scope_opts
	)			`[virtual]`

This method takes a pattern string and will perform the ch_scope_op on each of our paramaeters that match the pattern. This method primarily supports the chscope command.

virtual bool OP_Node::setColor ( const UT_Color & col ) [virtual]

Accessors for this node's color in the network view pane.

Reimplemented from OP_NetworkBoxItem.

bool OP_Node::setComment ( const char * str )

Accessors for this node's comment string.

int OP_Node::setCompress ( int on_off )

void OP_Node::setConnectionsChanging ( bool value ) [inline]

Definition at line 1190 of file OP_Node.h.

virtual void OP_Node::setCookingRender ( int val ) [virtual]

Reimplemented in OBJ_Node.

Examples:: SOP/SOP_HDKObject.C.

void OP_Node::setCreatorState ( const char * s ) [inline]

Definition at line 1940 of file OP_Node.h.

int OP_Node::setCurrent ( int on_off )

Examples:: CHOP/CHOP_Stair.C.

void OP_Node::setCurrentAndPicked ( )

virtual int OP_Node::setDebug ( int on_off ) [virtual]

Reimplemented in VOP_Node.

bool OP_Node::setDelScript ( const char * str )

Set the node's deletion script. Returns true if the delete script was set successfully.

int OP_Node::setDisplay ( int on_off )

static void OP_Node::setEditCallback	(	OP_EditCallback	func,
		void *	data
	)			`[static]`

int OP_Node::setEditPicked	(	int	on_off,
		bool	propagate_parent_event = `true`
	)

The edit flag is used whenever something is picked from the viewport. This causes the pane paths to be changed to the first writable parent of the node being picked.

virtual int OP_Node::setExport ( int on_off ) [virtual]

Reimplemented in CHOP_Node.

int OP_Node::setExpose ( int on_off )

void OP_Node::setExposeRecursive	(	bool	expose,
		bool	do_inputs,
		int	level = `0`
	)

Recursively exposes or unexposes all of this node's inputs or outputs, starting with exposing/unexposing self.

virtual void OP_Node::setExtraFlag	(	char	,
		int
	)			`[inline, virtual]`

Reimplemented in CHOP_Node, OBJ_Node, and VOP_Node.

Definition at line 1139 of file OP_Node.h.

virtual void OP_Node::setExtraFlags ( int axis ) [virtual]

Reimplemented in OBJ_Node.

virtual int OP_Node::setFlag	(	char	tag,
		int	on_off
	)			`[virtual]`

int OP_Node::setFootprint ( int on_off )

bool OP_Node::setGlobalFloatParam	(	const char *	param,
		fpreal	value,
		bool *	warned
	)

bool OP_Node::setGlobalStringParam	(	const char *	param,
		const char *	strvalue,
		bool *	warned
	)

void OP_Node::setHasTakeData ( int onoff )

int OP_Node::setHighlight ( int on_off )

Examples:: SOP/MSS_CustomBrushState.C.

static void OP_Node::setIndentLevel ( int numspaces ) [static]

virtual OP_ERROR OP_Node::setIndirectInput	(	unsigned	idx,
		OP_InputIndirect *	input
	)			`[virtual]`

Connects an input to an indirect input of our parent subnet.

Reimplemented in OBJ_BlendSticky, OBJ_Node, and OBJ_SubNet.

virtual OP_ERROR OP_Node::setInput	(	unsigned	idx,
		OP_Node *	op,
		unsigned	outputIdx = `0`
	)			`[virtual]`

Sets a given input to connect to an output of a particular node.

Reimplemented in DOP_Node, OBJ_BlendSticky, OBJ_Node, OBJ_SubNet, SHOP_Output, VOP_Node, and VOP_SubnetOutput.

virtual OP_ERROR OP_Node::setInputReference	(	unsigned	idx,
		const char *	label,
		int	keeppos,
		unsigned	outputIdx = `0`
	)			`[virtual]`

Connects an input to particular node by name in the network.

Reimplemented in DOP_Node, OBJ_BlendSticky, OBJ_Node, OBJ_SubNet, VOP_Node, and VOP_SubnetOutput.

void OP_Node::setLegacyConnectingInputIndex ( int index ) [inline, protected]

Definition at line 2387 of file OP_Node.h.

int OP_Node::setLock	(	int	state,
		int	saveundo = `1`
	)

virtual void OP_Node::setMapping	(	int	idx,
		int	type,
		const char *	label = `0`
	)			`[virtual]`

Reimplemented in CHOP_Node.

void OP_Node::setMatchesOTLDefinition ( int matches ) [protected]

Sets the flag idicating if the node is synced (matched) to the HDA.

virtual void OP_Node::setMaterialIconAllowRegenerateFlag ( bool ) [inline, virtual]

Reimplemented in SHOP_Node.

Definition at line 2254 of file OP_Node.h.

virtual void OP_Node::setMaterialIconFilename ( const char * ) [inline, virtual]

Reimplemented in SHOP_Node.

Definition at line 2251 of file OP_Node.h.

bool OP_Node::setMinimumCacheSize ( int min_size )

virtual int OP_Node::setModelLock	(	int	on_off,
		void *	modeler = `0`,
		int	allow_softlock_promotion = `0`,
		UT_Undo *	undo = `0`
	)			`[virtual]`

Reimplemented in SOP_Node.

int OP_Node::setModified ( int on_off )

virtual OP_ERROR OP_Node::setNamedIndirectInput	(	const OP_ConnectorId &	input_name,
		OP_InputIndirect *	input
	)			`[virtual]`

Reimplemented in OBJ_BlendSticky, OBJ_Node, and OBJ_SubNet.

virtual OP_ERROR OP_Node::setNamedInput	(	const OP_ConnectorId &	input_name,
		OP_Node *	op,
		const OP_ConnectorId *	output_name = `NULL`
	)			`[virtual]`

New input functions that use names instead of indices.

Reimplemented in DOP_Node, OBJ_BlendSticky, OBJ_Node, OBJ_SubNet, SHOP_Output, VOP_Node, VOP_SubnetOutput, and VOP_VariableInput.

virtual OP_ERROR OP_Node::setNamedInputReference	(	const OP_ConnectorId &	input_name,
		const char *	label,
		int	,
		const OP_ConnectorId *	output_name = `NULL`
	)			`[virtual]`

Reimplemented in DOP_Node, OBJ_BlendSticky, OBJ_Node, OBJ_SubNet, VOP_Node, VOP_SubnetOutput, and VOP_VariableInput.

void OP_Node::setNewParent ( OP_Network * new_parent ) [protected]

void OP_Node::setNodeBeingDeleted ( int beingdeleted )

static void OP_Node::setNodeButtonWidthFlagMult ( int new_mult ) [static]

Sets the node button width in terms of the flag widths multiplier.

virtual int OP_Node::setPickable ( int on_off ) [virtual]

Reimplemented in OBJ_Node.

virtual int OP_Node::setPicked	(	int	on_off,
		bool	propagate_parent_event = `true`
	)			`[virtual]`

Implements OP_NetworkBoxItem.

void OP_Node::setProxyRefNode ( bool f ) [inline]

Definition at line 648 of file OP_Node.h.

void OP_Node::setRenameConflict ( ) [inline]

Definition at line 1905 of file OP_Node.h.

int OP_Node::setRender ( int on_off )

void OP_Node::setRunningCreateScript ( int onoff )

int OP_Node::setSaveBypass ( int on_off )

int OP_Node::setSaveData ( int on_off )

static void OP_Node::setSmallMode ( ) [static]

If we're in the UI "small" or "compact" modes, someone needs to call OP_Node::setSmallMode() to ensure that the correct node sizes are used by getFlagWidth, getNodeHeight, getNodeButtonWidth, and getConnectorHeight.

int OP_Node::setTemplate ( int on_off )

virtual void OP_Node::setUniqueId ( int id ) [protected, virtual]

Reimplemented in SOP_Node.

int OP_Node::setUnload ( int on_off )

void OP_Node::setUserData	(	const char *	key,
		const std::string &	data
	)

virtual bool OP_Node::setVisible ( int onoff ) [virtual]

Reimplemented in OBJ_Node.

int OP_Node::setXray ( int on_off )

virtual void OP_Node::setXY	(	fpreal	x,
		fpreal	y
	)			`[virtual]`

Node position/scale is used by the UI.

Implements OP_NetworkBoxItem.

bool OP_Node::setXYWithBoundsChecks	(	fpreal	x,
		fpreal	y
	)

Set the node's location like setXY(), but first check if the new position is valid. Also update any netboxes containing this node and send an OP_UI_MOVED event.

virtual void OP_Node::spareParmRemoved ( const char * parmname ) [virtual]

Implements PRM_ParmOwner.

static void OP_Node::startBulkNotifications	(	const OP_NodeList &	changed,
		OP_Node *	caller = `NULL`
	)			`[static]`

void OP_Node::startCookTimer ( const OP_Context & context ) [protected]

void OP_Node::stealDependents ( OP_Node * other ) [protected]

void OP_Node::stopCookTimer ( const OP_Context & context ) [protected]

virtual bool OP_Node::syncContents ( UT_IStream & is ) [protected, virtual]

Reimplemented in OP_Network.

virtual void OP_Node::syncNodeVersion	(	const char *	old_version,
		const char *	current_version,
		bool *	node_deleted
	)			`[virtual]`

Sync the node assuming that it is currently at old_version to the current_version. By default, this will call the corresponding OTL_SYNCNODEVERSION section if it exists.

Reimplemented from OP_Parameters.

Reimplemented in SOP_AttribComp.

void OP_Node::syncNodeVersionIfNeeded	(	bool *	node_deleted,
		const char *	from_version = `NULL`,
		bool	update_node_version = `false`
	)

After the nodes parameter list is loaded, syncNodeVersionIfNeeded() is called to perform any necessary upgrades if the version number of the loaded node (taken from user data) is different from the node type's version number (getOperator()->getVersion()). Use the from_version parameter to override the node current version. If needed, this will call syncNodeVersion(). After synching, the node's version user data will be set to the current version if update_node_version is true.

void OP_Node::takeActivateFlag	(	uchar	flag,
		bool	enable = `true`,
		bool	send_flag_event = `true`
	)

void OP_Node::takeDeactivateFlag ( uchar flag ) [inline]

Definition at line 1057 of file OP_Node.h.

bool OP_Node::takeIsActiveFlag ( uchar flag ) const

const OP_TaskState& OP_Node::taskState ( ) const [inline]

Definition at line 920 of file OP_Node.h.

OP_TaskState& OP_Node::taskState ( ) [inline]

Definition at line 919 of file OP_Node.h.

virtual int OP_Node::testDragDrop ( DD_Source & src ) [virtual]

Reimplemented in OBJ_Node, and SOP_Node.

void OP_Node::touchBundleParm ( int parm_index )

void OP_Node::touchBundleParm ( const char * name )

bool OP_Node::traverseChildren	(	bool()(OP_Node &, void )	callback,
		void *	data,
		bool	recurse_into_subnets
	)

Traverses children of this node, calling 'callback' on all children. If callback returns true, the traversal stops at that node.

TInputsIterator OP_Node::traverseConnectedInputs ( TInputsIterator * prev_iter )

TInputsIterator OP_Node::traverseInputs ( TInputsIterator * prev_iter )

Note: Use these carefully, since they assume that no inputs are actually added or removed (or renamed) during the traversal.

bool OP_Node::traverseInputs	(	bool()(const OP_Node &, void )	callback,
		void *	data,
		bool	follow_subnets,
		bool	follow_ref_inputs,
		bool	follow_extra_inputs,
		OP_InterestType	extra_interest_mask = `OP_INTEREST_ALL`
	)			const

traverseInputs calls 'callback' on this node and all its inputs. If callback returns true for any node, it will stop and return true, otherwise it will return false;

Parameters:

	callback	Callback function
	data	User data passed to the callback function
	follow_subnets	If input is a subnet, we continue traversing from its display node.
	follow_ref_inputs	Follow inputs marked as reference inputs
	follow_extra_inputs	Follow nodes which this node implicitly depends on.
	extra_interest_mask	For extra inputs, this mask allows one to restrict which of those dependency types follow.

bool OP_Node::traverseInputs	(	bool()(OP_Node &, void )	callback,
		void *	data,
		bool	follow_subnets,
		bool	follow_ref_inputs,
		bool	follow_extra_inputs,
		OP_InterestType	extra_interest_mask = `OP_INTEREST_ALL`
	)

traverseInputs calls 'callback' on this node and all its inputs. If callback returns true for any node, it will stop and return true, otherwise it will return false;

Parameters:

	callback	Callback function
	data	User data passed to the callback function
	follow_subnets	If input is a subnet, we continue traversing from its display node.
	follow_ref_inputs	Follow inputs marked as reference inputs
	follow_extra_inputs	Follow nodes which this node implicitly depends on.
	extra_interest_mask	For extra inputs, this mask allows one to restrict which of those dependency types follow.

void OP_Node::triggerOutputChanged ( )

virtual bool OP_Node::triggerParmCallback	(	PRM_Parm *	parmptr,
		fpreal	now,
		int	value,
		void *	data
	)			`[virtual]`

Implements OP_Parameters.

void OP_Node::triggerUIChanged ( )

Examples:: VOP/VOP_CustomContext.C.

void OP_Node::turnOffAllChildExports ( void )

virtual bool OP_Node::unloadData ( ) [virtual]

Reimplemented in SOP_BrushBase, SOP_Edit, SOP_Lattice, and SOP_Node.

virtual void OP_Node::unlockInput ( unsigned idx ) [virtual]

Reimplemented in SOP_Node.

virtual void OP_Node::unlockInputs ( void ) [virtual]

Reimplemented in SOP_Node.

Examples:: POP/POP_CircleForce.C, POP/POP_LocalForce.C, POP/POP_RadialBirth.C, and POP/POP_SpotLight.C.

virtual void OP_Node::unmatchOTLDefinition ( ) [virtual]

Unmatches (unlocks) the node from the current HDA definition.

virtual void OP_Node::unscopeChannels ( bool recurse ) [virtual]

This method will unscope all the channels belonging to this op. If the recurse flag is set it will recurse through the children (at this level the recurse flag is ignored).

Reimplemented in OP_Network.

static void OP_Node::updateChannelPtrs ( CH_CollectionList & parents ) [static]

virtual int OP_Node::updateDandROpsEqual ( int = 1 ) [inline, virtual]

Reimplemented in DOP_Node, OBJ_DopNet, OP_Network, and HDK_Sample::SOP_HDKObject.

Definition at line 684 of file OP_Node.h.

void OP_Node::updateErrorSeverity ( ) [protected]

Update the error severity of this node.

void OP_Node::updateParmsToMatchCurrentUnits ( )

void OP_Node::updateVersionUserData ( )

const UT_Options& OP_Node::userData ( ) const [inline]

Definition at line 1707 of file OP_Node.h.

void OP_Node::userSetSelectableTemplate ( bool onoff )

The user has set the selectable template flag. If we are making a node into a selectable template, we turn on the template flag as well. If we are turning off selectable template, we leave template alone.

void OP_Node::userSetTemplate ( bool onoff )

The user has set the template flag. If we are turning on the template flag, we do the same as setTemplate(). If we are turning it *off*, we also turn off the selectable template (footprint) flag.

virtual bool OP_Node::usesFootprint ( ) const [inline, virtual]

Reimplemented in SOP_Node.

Definition at line 2058 of file OP_Node.h.

bool OP_Node::verifyTemplatesWithParameters ( ) const

int OP_Node::wasBuiltExplicitly ( ) const [inline]

Definition at line 1944 of file OP_Node.h.

int OP_Node::wasInterrupted ( ) const [inline]

Definition at line 1899 of file OP_Node.h.

int OP_Node::whichInputIs	(	OP_Node *	source_node,
		int	counter
	)

int OP_Node::whichInputIs	(	const OP_InputIndirect *	whoi,
		int	cnt
	)			const

int OP_Node::whichInputIs ( const OP_InputIndirect * who ) const

Returns the index of the first connection of an indirect input.

int OP_Node::whichInputIs ( const OP_Node * who ) const

Returns the index of the first connection from node "who" to this node, or -1 if "who" is not an input.

OP_ConnectorId OP_Node::whichNamedInputIs ( const OP_InputIndirect * who ) const

Returns the index of the first connection of an indirect input.

OP_ConnectorId OP_Node::whichNamedInputIs ( const OP_Node * who ) const

Returns the name of the first connection from node "who" to this node, or an empty string if "who" is not an input.

int OP_Node::whichOutputIs	(	OP_Node *	target_node,
		int	input_on_target_node
	)

virtual bool OP_Node::willAutoconvertInputType ( int input_idx ) [virtual]

This is overriden in VOPs. It returns true if the input at input_idx will need *and* can perform autoconversion of its input type to the type it needs. If autoconversion is not needed, or is impossible, this will return false.

Reimplemented in VOP_Node.

virtual bool OP_Node::willAutoconvertNamedInputType ( const OP_ConnectorId & input_name ) [virtual]