PI_OpHandleLink Class Reference
#include <PI_OpHandleLink.h>
Inheritance diagram for PI_OpHandleLink:
Classes | |
| class | PI_Interest |
Public Member Functions | |
| PI_OpHandleLink (const PI_PITemplate &templ) | |
| virtual | ~PI_OpHandleLink () |
| int | linkOpParmToHandleParm (const char *op_type, const char *handle_parm_name, const char *op_parm_name) |
| virtual int | attach (OP_Node &node) |
| virtual int | detach (OP_Node &node) |
| virtual void | detachAll () |
| void | attachForKeyframe (OP_Node &node) |
| void | detachForKeyframe (OP_Node &node) |
| void | detachAllForKeyframe () |
| void | setShowOpPath (bool onoff) |
| virtual bool | getShowOpPath () const |
| void | setRootDescription (const char *description) |
| const char * | getRootDescription () const |
| void | buildDescription () |
| const char * | getDescription () const |
| virtual void | descriptionChanged () |
| bool | allowsUsingPerOpSettingsTable () const |
| bool | allowsUsingLastSettingsTable () const |
| bool | allowsUsingOpTypeSettings () const |
| bool | allowsUsingLastVisibilitySetting () const |
| OP_Operator * | lastSettingsOperatorTypeRestriction () const |
| OP_Node * | getOpNode (int opnum=0) const |
| int | getNumOps () const |
| OP_Node * | getKeyframeOpNode (int opnum=0) const |
| int | getKeyframeNumOps () const |
| int | hasOpNode (const OP_Node &node) const |
| int | hasKeyframeOpNode (const OP_Node &node) const |
| OP_Node * | findOpNode (int op_type, const char *op_name) const |
| void | doUpdateFromOpParms () |
| virtual void | handleOpNodeChange (OP_Node &node) |
| virtual void | handleOpUIChange (OP_Node &) |
| virtual int | wantsOpNodeChange (const OP_Node &) const |
| virtual void | flagOpNodeChangeNeeded (OP_Node &) |
| virtual int | refreshBindings (int op_type, const char *op_name) |
| void | id (int i) |
| int | id () const |
| const UT_StringArray & | linkedParmNames (int opnum) const |
| virtual const UT_StringArray & | allParmNames (int opnum) const |
| int | getOpnumForHandleParmIndex (int idx) const |
| const UT_Color & | getActiveColor () const |
| virtual void | setActiveColor (const UT_Color &c) |
| void | setBindingState (const bool active) |
| virtual int | isEqual (const PI_OpHandleLink &pi) const |
| virtual int | setEqual (const PI_OpHandleLink &pi) |
| bool | ethereal (void) const |
| const PI_PITemplate & | getTemplate () const |
| int | writeOptions (ostream &os, const char *baseCommand) |
| int | runBindCommand (CMD_Args &args) |
| int | runUnbindCommand (CMD_Args &args) |
| void | editChannels (int append_channels, int opnum=-1) |
| void | findKey (int direction, int opnum=-1) |
| void | setKeys (int opnum=-1, int pindex_start=-1, int pined_stop=-1, const char *undo_str=0) |
| void | removeKeys (int opnum=-1) |
| void | deleteChannels (int opnum=-1) |
| void | lockParms (int opnum=-1) |
| void | revertToDefaults (int opnum=-1) |
| void | revertToFactoryDefaults (int opnum=-1) |
| void | overwriteDefaults (int opnum=-1) |
| virtual void | loadSettings (const PI_SettingList &settings) |
| virtual void | saveSettings (PI_SettingList &settings, bool specific_to_op) const |
| virtual void | saveSettingsToAppropriateLocation () |
| void | loadSettingsFromTables (bool okay_to_use_last_settings) |
| void | removeSettingsFromTables () |
Static Public Member Functions | |
| static void | extractProjection (UT_String &channel, const char *parmname, float &a, float &b, float &c, float &d) |
| static void | extractChannelName (UT_String &channel, const char *parmname) |
Protected Member Functions | |
| virtual void | updateFromOpParms (void) |
| virtual int | justLinked (int pindex) |
| virtual void | justUnlinked (int pindex) |
| virtual PI_Interest * | getInputGroupInterests () const |
| int | findHandleParmIndex (const char *h_parm_name) const |
| void | addAllInputGroupInterests (int opnum) |
| void | removeAllInputGroupInterests (int opnum) |
| virtual float | getTime () const |
| int | getParmValue (int pindex, int &val, int d=0) const |
| int | getParmValue (int pindex, float &val, float d=0) const |
| int | getParmValue (int pindex, UT_String &val, UT_String d=0) const |
| int | setParmValue (int pindex, int val, bool addkey=false) |
| int | setParmValue (int pindex, float val, bool addkey=false) |
| int | setParmValue (int pindex, const UT_String &val, CH_StringMeaning meaning) |
| int | setOpParmValue (OP_Node *op, PRM_Parm *parm, int vecidx, int val, bool addkey=false) |
| int | setOpParmValue (OP_Node *op, PRM_Parm *parm, int vecidx, float val, bool addkey=false) |
| int | setOpParmValue (OP_Node *op, PRM_Parm *parm, int vecidx, const UT_String &val, CH_StringMeaning meaning) |
| void | copyKeyStructure (int pindex_dest, int pindex_from) |
| bool | isParmEnabled (int pindex, int opnum=0) const |
| PRM_ChanState | getParmState (int pindex, int opnum=0) const |
| int | getLinkedParmCount () const |
| virtual int | hasTimeInterest () const |
| virtual void | handleTimeChange () |
| void | beginDistributedUndoBlock (const char *operation, UT_UndoBlockType blocktype) |
| void | endDistributedUndoBlock () |
| bool | inDistributedUndoBlock () |
| virtual void | handleOpChange (OP_Node *op, OP_EventType etype, void *data) |
| void | setAllowUsingPerOpSettingsTable (bool onoff) |
| void | setAllowUsingLastSettingsTable (bool onoff) |
| void | setAllowUsingOpTypeSettings (bool onoff) |
| void | setAllowUsingLastVisibilitySetting (bool onoff) |
| virtual void | setOwnerOp (const char *owner_op) |
| const UT_String & | getOwnerOp () const |
| OP_Node * | getOwnerOpRelativeTo (OP_Node *node) const |
| virtual void | setOwnerOpGroup (const char *owner_op_group) |
| const UT_String & | getOwnerOpGroup () const |
| const UT_String & | getFirstInputGroupInterestName () const |
Static Protected Member Functions | |
| static bool | isOpParmLocked (const char *channel_name, OP_Node &op, float time, const PRM_Parm **ret_parm=NULL, const OP_Node **ret_node=NULL) |
Detailed Description
Definition at line 47 of file PI_OpHandleLink.h.
Constructor & Destructor Documentation
| PI_OpHandleLink::PI_OpHandleLink | ( | const PI_PITemplate & | templ | ) |
| virtual PI_OpHandleLink::~PI_OpHandleLink | ( | ) | [virtual] |
Member Function Documentation
| void PI_OpHandleLink::addAllInputGroupInterests | ( | int | opnum | ) | [protected] |
| bool PI_OpHandleLink::allowsUsingLastSettingsTable | ( | ) | const [inline] |
Definition at line 85 of file PI_OpHandleLink.h.
| bool PI_OpHandleLink::allowsUsingLastVisibilitySetting | ( | ) | const [inline] |
Definition at line 89 of file PI_OpHandleLink.h.
| bool PI_OpHandleLink::allowsUsingOpTypeSettings | ( | ) | const [inline] |
Definition at line 87 of file PI_OpHandleLink.h.
| bool PI_OpHandleLink::allowsUsingPerOpSettingsTable | ( | ) | const [inline] |
Definition at line 83 of file PI_OpHandleLink.h.
| virtual const UT_StringArray& PI_OpHandleLink::allParmNames | ( | int | opnum | ) | const [inline, virtual] |
Definition at line 149 of file PI_OpHandleLink.h.
| virtual int PI_OpHandleLink::attach | ( | OP_Node & | node | ) | [virtual] |
| void PI_OpHandleLink::attachForKeyframe | ( | OP_Node & | node | ) |
| void PI_OpHandleLink::beginDistributedUndoBlock | ( | const char * | operation, | |
| UT_UndoBlockType | blocktype | |||
| ) | [protected] |
| void PI_OpHandleLink::buildDescription | ( | ) |
| void PI_OpHandleLink::copyKeyStructure | ( | int | pindex_dest, | |
| int | pindex_from | |||
| ) | [protected] |
| void PI_OpHandleLink::deleteChannels | ( | int | opnum = -1 |
) |
| virtual void PI_OpHandleLink::descriptionChanged | ( | ) | [virtual] |
| virtual int PI_OpHandleLink::detach | ( | OP_Node & | node | ) | [virtual] |
| virtual void PI_OpHandleLink::detachAll | ( | ) | [virtual] |
| void PI_OpHandleLink::detachAllForKeyframe | ( | ) |
| void PI_OpHandleLink::detachForKeyframe | ( | OP_Node & | node | ) |
| void PI_OpHandleLink::doUpdateFromOpParms | ( | ) |
| void PI_OpHandleLink::editChannels | ( | int | append_channels, | |
| int | opnum = -1 | |||
| ) |
| void PI_OpHandleLink::endDistributedUndoBlock | ( | ) | [protected] |
| bool PI_OpHandleLink::ethereal | ( | void | ) | const |
| static void PI_OpHandleLink::extractChannelName | ( | UT_String & | channel, | |
| const char * | parmname | |||
| ) | [inline, static] |
Definition at line 219 of file PI_OpHandleLink.h.
| static void PI_OpHandleLink::extractProjection | ( | UT_String & | channel, | |
| const char * | parmname, | |||
| float & | a, | |||
| float & | b, | |||
| float & | c, | |||
| float & | d | |||
| ) | [static] |
| int PI_OpHandleLink::findHandleParmIndex | ( | const char * | h_parm_name | ) | const [protected] |
| void PI_OpHandleLink::findKey | ( | int | direction, | |
| int | opnum = -1 | |||
| ) |
| OP_Node* PI_OpHandleLink::findOpNode | ( | int | op_type, | |
| const char * | op_name | |||
| ) | const |
| virtual void PI_OpHandleLink::flagOpNodeChangeNeeded | ( | OP_Node & | ) | [inline, virtual] |
Definition at line 127 of file PI_OpHandleLink.h.
| const UT_Color& PI_OpHandleLink::getActiveColor | ( | ) | const |
| const char* PI_OpHandleLink::getDescription | ( | ) | const |
| const UT_String& PI_OpHandleLink::getFirstInputGroupInterestName | ( | ) | const [protected] |
| virtual PI_Interest* PI_OpHandleLink::getInputGroupInterests | ( | ) | const [protected, virtual] |
| int PI_OpHandleLink::getKeyframeNumOps | ( | ) | const |
| OP_Node* PI_OpHandleLink::getKeyframeOpNode | ( | int | opnum = 0 |
) | const |
| int PI_OpHandleLink::getLinkedParmCount | ( | ) | const [inline, protected] |
Definition at line 291 of file PI_OpHandleLink.h.
| int PI_OpHandleLink::getNumOps | ( | ) | const |
| OP_Node* PI_OpHandleLink::getOpNode | ( | int | opnum = 0 |
) | const |
| int PI_OpHandleLink::getOpnumForHandleParmIndex | ( | int | idx | ) | const |
| const UT_String& PI_OpHandleLink::getOwnerOp | ( | ) | const [protected] |
| const UT_String& PI_OpHandleLink::getOwnerOpGroup | ( | ) | const [protected] |
| PRM_ChanState PI_OpHandleLink::getParmState | ( | int | pindex, | |
| int | opnum = 0 | |||
| ) | const [protected] |
| int PI_OpHandleLink::getParmValue | ( | int | pindex, | |
| UT_String & | val, | |||
| UT_String | d = 0 | |||
| ) | const [protected] |
| int PI_OpHandleLink::getParmValue | ( | int | pindex, | |
| float & | val, | |||
| float | d = 0 | |||
| ) | const [protected] |
| int PI_OpHandleLink::getParmValue | ( | int | pindex, | |
| int & | val, | |||
| int | d = 0 | |||
| ) | const [protected] |
| const char* PI_OpHandleLink::getRootDescription | ( | ) | const |
| virtual bool PI_OpHandleLink::getShowOpPath | ( | ) | const [virtual] |
| const PI_PITemplate& PI_OpHandleLink::getTemplate | ( | ) | const |
| virtual float PI_OpHandleLink::getTime | ( | ) | const [protected, virtual] |
| virtual void PI_OpHandleLink::handleOpChange | ( | OP_Node * | op, | |
| OP_EventType | etype, | |||
| void * | data | |||
| ) | [protected, virtual] |
Reimplemented in PI_OHLPersistent.
| virtual void PI_OpHandleLink::handleOpNodeChange | ( | OP_Node & | node | ) | [virtual] |
| virtual void PI_OpHandleLink::handleOpUIChange | ( | OP_Node & | ) | [inline, virtual] |
Definition at line 123 of file PI_OpHandleLink.h.
| virtual void PI_OpHandleLink::handleTimeChange | ( | ) | [protected, virtual] |
| int PI_OpHandleLink::hasKeyframeOpNode | ( | const OP_Node & | node | ) | const |
| int PI_OpHandleLink::hasOpNode | ( | const OP_Node & | node | ) | const |
| virtual int PI_OpHandleLink::hasTimeInterest | ( | ) | const [protected, virtual] |
| int PI_OpHandleLink::id | ( | ) | const |
| void PI_OpHandleLink::id | ( | int | i | ) |
| bool PI_OpHandleLink::inDistributedUndoBlock | ( | ) | [protected] |
| virtual int PI_OpHandleLink::isEqual | ( | const PI_OpHandleLink & | pi | ) | const [virtual] |
| static bool PI_OpHandleLink::isOpParmLocked | ( | const char * | channel_name, | |
| OP_Node & | op, | |||
| float | time, | |||
| const PRM_Parm ** | ret_parm = NULL, |
|||
| const OP_Node ** | ret_node = NULL | |||
| ) | [static, protected] |
| bool PI_OpHandleLink::isParmEnabled | ( | int | pindex, | |
| int | opnum = 0 | |||
| ) | const [protected] |
| virtual int PI_OpHandleLink::justLinked | ( | int | pindex | ) | [protected, virtual] |
| virtual void PI_OpHandleLink::justUnlinked | ( | int | pindex | ) | [protected, virtual] |
| OP_Operator* PI_OpHandleLink::lastSettingsOperatorTypeRestriction | ( | ) | const |
| const UT_StringArray& PI_OpHandleLink::linkedParmNames | ( | int | opnum | ) | const [inline] |
Definition at line 142 of file PI_OpHandleLink.h.
| int PI_OpHandleLink::linkOpParmToHandleParm | ( | const char * | op_type, | |
| const char * | handle_parm_name, | |||
| const char * | op_parm_name | |||
| ) |
| virtual void PI_OpHandleLink::loadSettings | ( | const PI_SettingList & | settings | ) | [virtual] |
| void PI_OpHandleLink::loadSettingsFromTables | ( | bool | okay_to_use_last_settings | ) |
| void PI_OpHandleLink::lockParms | ( | int | opnum = -1 |
) |
| void PI_OpHandleLink::overwriteDefaults | ( | int | opnum = -1 |
) |
| virtual int PI_OpHandleLink::refreshBindings | ( | int | op_type, | |
| const char * | op_name | |||
| ) | [virtual] |
| void PI_OpHandleLink::removeAllInputGroupInterests | ( | int | opnum | ) | [protected] |
| void PI_OpHandleLink::removeKeys | ( | int | opnum = -1 |
) |
| void PI_OpHandleLink::removeSettingsFromTables | ( | ) |
| void PI_OpHandleLink::revertToDefaults | ( | int | opnum = -1 |
) |
| void PI_OpHandleLink::revertToFactoryDefaults | ( | int | opnum = -1 |
) |
| int PI_OpHandleLink::runBindCommand | ( | CMD_Args & | args | ) |
| int PI_OpHandleLink::runUnbindCommand | ( | CMD_Args & | args | ) |
| virtual void PI_OpHandleLink::saveSettings | ( | PI_SettingList & | settings, | |
| bool | specific_to_op | |||
| ) | const [virtual] |
| virtual void PI_OpHandleLink::saveSettingsToAppropriateLocation | ( | ) | [virtual] |
| virtual void PI_OpHandleLink::setActiveColor | ( | const UT_Color & | c | ) | [virtual] |
Reimplemented in PI_OHLPersistent.
| void PI_OpHandleLink::setAllowUsingLastSettingsTable | ( | bool | onoff | ) | [inline, protected] |
Definition at line 327 of file PI_OpHandleLink.h.
| void PI_OpHandleLink::setAllowUsingLastVisibilitySetting | ( | bool | onoff | ) | [inline, protected] |
Definition at line 331 of file PI_OpHandleLink.h.
| void PI_OpHandleLink::setAllowUsingOpTypeSettings | ( | bool | onoff | ) | [inline, protected] |
Definition at line 329 of file PI_OpHandleLink.h.
| void PI_OpHandleLink::setAllowUsingPerOpSettingsTable | ( | bool | onoff | ) | [inline, protected] |
Definition at line 325 of file PI_OpHandleLink.h.
| void PI_OpHandleLink::setBindingState | ( | const bool | active | ) |
| virtual int PI_OpHandleLink::setEqual | ( | const PI_OpHandleLink & | pi | ) | [virtual] |
Reimplemented in PI_OHLPersistent.
| void PI_OpHandleLink::setKeys | ( | int | opnum = -1, |
|
| int | pindex_start = -1, |
|||
| int | pined_stop = -1, |
|||
| const char * | undo_str = 0 | |||
| ) |
| int PI_OpHandleLink::setOpParmValue | ( | OP_Node * | op, | |
| PRM_Parm * | parm, | |||
| int | vecidx, | |||
| const UT_String & | val, | |||
| CH_StringMeaning | meaning | |||
| ) | [protected] |
| int PI_OpHandleLink::setOpParmValue | ( | OP_Node * | op, | |
| PRM_Parm * | parm, | |||
| int | vecidx, | |||
| float | val, | |||
| bool | addkey = false | |||
| ) | [protected] |
| int PI_OpHandleLink::setOpParmValue | ( | OP_Node * | op, | |
| PRM_Parm * | parm, | |||
| int | vecidx, | |||
| int | val, | |||
| bool | addkey = false | |||
| ) | [protected] |
| virtual void PI_OpHandleLink::setOwnerOp | ( | const char * | owner_op | ) | [protected, virtual] |
| virtual void PI_OpHandleLink::setOwnerOpGroup | ( | const char * | owner_op_group | ) | [protected, virtual] |
| int PI_OpHandleLink::setParmValue | ( | int | pindex, | |
| const UT_String & | val, | |||
| CH_StringMeaning | meaning | |||
| ) | [protected] |
| int PI_OpHandleLink::setParmValue | ( | int | pindex, | |
| float | val, | |||
| bool | addkey = false | |||
| ) | [protected] |
| int PI_OpHandleLink::setParmValue | ( | int | pindex, | |
| int | val, | |||
| bool | addkey = false | |||
| ) | [protected] |
| void PI_OpHandleLink::setRootDescription | ( | const char * | description | ) |
| void PI_OpHandleLink::setShowOpPath | ( | bool | onoff | ) |
| virtual void PI_OpHandleLink::updateFromOpParms | ( | void | ) | [protected, virtual] |
| virtual int PI_OpHandleLink::wantsOpNodeChange | ( | const OP_Node & | ) | const [inline, virtual] |
Definition at line 125 of file PI_OpHandleLink.h.
| int PI_OpHandleLink::writeOptions | ( | ostream & | os, | |
| const char * | baseCommand | |||
| ) |
The documentation for this class was generated from the following file:
