HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Friends | List of all members
PI_OHLPersistent Class Reference

#include <PI_OHLPersistent.h>

+ Inheritance diagram for PI_OHLPersistent:

Public Member Functions

const UT_String & getName () const
 
void setName (const char *name)
 
const UT_String & getPaneMask () const
 
void setPaneMask (const char *mask)
 
bool getExpose () const
 
void setExpose (bool expose)
 
bool getDisplayInParent () const
 
void setDisplayInParent (bool display)
 
bool getDisplayInChild () const
 
void setDisplayInChild (bool display)
 
bool getDisplayInSibling () const
 
void setDisplayInSibling (bool display)
 
bool getDisplayAlways () const
 
void setDisplayAlways (bool display)
 
void setPIOwner (PI_OpHandleLink *piowner)
 
PI_OpHandleLink * getPIOwner () const
 
void setActiveColor (const UT_Color &c) override
 
const PI_SettingList & getSettingList () const
 
PI_SettingList & getSettingList ()
 
void setSettings (const char *setting_string)
 
void clearSettingList ()
 
int setEqual (const PI_OpHandleLink &pi) override
 
- Public Member Functions inherited from PI_OpHandleLink
 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)
 
int activateHandleParm (int pindex)
 
void disableHandleParm (int pindex)
 
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 isolateHandleParms (int beg, const UT_StringArray &handle_parms)
 
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 (const char *old_description)
 
void setIsTimeOverride (bool is_time_override)
 
void setTimeOverrideTime (fpreal t)
 
bool getIsTimeOverride () const
 
fpreal getTimeOverrideTime () const
 
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 forceUpdateFromOpParms ()
 
virtual void updateOpParms ()
 
virtual void handleOpNodeChange (OP_Node &node)
 
virtual void handleOpUIChange (OP_Node &)
 
virtual int wantsOpNodeChange (const OP_Node &) const
 
virtual bool flagOpNodeChangeNeeded (OP_Node &)
 
virtual int refreshBindings (int op_type, const char *op_name)
 
void id (int i)
 
int id () const
 
bool hasLinkedParms () 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
 
void setBindingState (const bool active)
 
virtual int isEqual (const PI_OpHandleLink &pi) const
 
bool ethereal () const
 
const PI_PITemplate & getTemplate () const
 
PI_PITemplate & getTemplate ()
 
int writeOptions (std::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 ()
 
void setLateBinding (LateBinding *binding)
 
bool hasLateBinding () const
 
bool hasLateBinding (LateBinding const *binding) const
 
int findHandleParmIndex (const char *h_parm_name) const
 
virtual void onDeletion ()
 
int getProxyIndex () const
 
virtual bool handleDetach ()
 
virtual bool handleIsDetached () const
 
virtual bool handleIsDetachable () const
 
void updateSettings (char const *setting_string)
 
virtual bool getSettingValue (char const *setting_name, hboost::any &out_value) const
 
void setAllowUsingPerOpSettingsTable (bool onoff)
 
void setAllowUsingLastSettingsTable (bool onoff)
 
void setAllowUsingOpTypeSettings (bool onoff)
 
void setAllowUsingLastVisibilitySetting (bool onoff)
 
int iterateParms (int opnum, ReadParmFunc func) const
 
int iterateParms (int opnum, ModifyParmFunc func, bool modify_locked=false)
 

Protected Member Functions

void handleOpChange (OP_Node *op, OP_EventType etype, void *data) override
 
- Protected Member Functions inherited from PI_OpHandleLink
virtual void updateFromOpParms ()
 
virtual int justLinked (int pindex)
 
virtual void justUnlinked (int pindex)
 
virtual PI_Interest * getInputGroupInterests () const
 
void addAllInputGroupInterests (int opnum)
 
void removeAllInputGroupInterests (int opnum)
 
virtual fpreal getTime () const
 
int getParmValue (int pindex, int &val, int d=0) const
 
int getParmValue (int pindex, fpreal &val, fpreal d=0) const
 
int getParmValue (int pindex, UT_String &val, UT_String d=0) const
 
void getParmVector3 (int pindex, UT_Vector3R &v, fpreal def=0.0) const
 
int getParmInstValue (int pindex, const int *inst, int &val, int d=0, int nestlevel=1) const
 
int getParmInstValue (int pindex, const int *inst, fpreal &val, fpreal d=0, int nestlevel=1) const
 
int getParmInstValue (int pindex, const int *inst, UT_String &val, UT_String d=0, int nestlevel=1) const
 
void getParmInstVector3 (int pindex, const int *inst, UT_Vector3R &v, fpreal def=0.0) const
 
int setParmValue (int pindex, int val, bool addkey=false)
 
int setParmValue (int pindex, fpreal val, bool addkey=false)
 
int setParmValue (int pindex, const UT_String &val, CH_StringMeaning meaning)
 
void setParmVector3 (int pindex, const UT_Vector3R &v)
 
int setParmInstValue (int pindex, const int *inst, int val, bool addkey=false, int nestlevel=1)
 
int setParmInstValue (int pindex, const int *inst, fpreal val, bool addkey=false, int nestlevel=1)
 
int setParmInstValue (int pindex, const int *inst, const UT_String &val, CH_StringMeaning meaning, int nestlevel=1)
 
void setParmInstVector3 (int pindex, const int *inst, const UT_Vector3R &v)
 
int performParmCallback (int pindex, int theitem)
 
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, fpreal val, bool addkey=false)
 
int setOpParmValue (OP_Node *op, PRM_Parm *parm, int vecidx, const UT_String &val, CH_StringMeaning meaning)
 
bool readParm (int pindex, ReadParmFunc f) const
 
bool modifyParm (int pindex, ModifyParmFunc f, bool modify_locked=false)
 
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 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_StringHolder & getFirstInputGroupInterestName () const
 
void updateStateValues (void *ui_event)
 
void beginHandleChange (void *ui_event)
 
void endHandleChange (void *ui_event)
 
void allocProxy (void *ptr)
 
void freeProxy ()
 
UT_StringHolder getOpParmLabel (int pi_index) const
 

Friends

class PI_Manager
 

Additional Inherited Members

- Public Types inherited from PI_OpHandleLink
using ReadParmFunc = UT_Function< void(const PRM_Parm &parm, int vecidx)>
 
using ModifyParmFunc = UT_Function< void(PRM_Parm &parm, int vecidx)>
 
- Static Public Member Functions inherited from PI_OpHandleLink
static void extractProjection (UT_String &channel, const char *parmname, fpreal &a, fpreal &b, fpreal &c, fpreal &d)
 
static void extractChannelName (UT_String &channel, const char *parmname)
 
- Static Protected Member Functions inherited from PI_OpHandleLink
static bool isOpParmLocked (const char *channel_name, OP_Node &op, fpreal time, const PRM_Parm **ret_parm=NULL, const OP_Node **ret_node=NULL)
 

Detailed Description

Definition at line 23 of file PI_OHLPersistent.h.

Member Function Documentation

void PI_OHLPersistent::clearSettingList ( )
inline

Definition at line 57 of file PI_OHLPersistent.h.

bool PI_OHLPersistent::getDisplayAlways ( ) const
bool PI_OHLPersistent::getDisplayInChild ( ) const
bool PI_OHLPersistent::getDisplayInParent ( ) const
bool PI_OHLPersistent::getDisplayInSibling ( ) const
bool PI_OHLPersistent::getExpose ( ) const
const UT_String& PI_OHLPersistent::getName ( ) const
const UT_String& PI_OHLPersistent::getPaneMask ( ) const
PI_OpHandleLink* PI_OHLPersistent::getPIOwner ( ) const
inline

Definition at line 50 of file PI_OHLPersistent.h.

const PI_SettingList& PI_OHLPersistent::getSettingList ( ) const
inline

Definition at line 54 of file PI_OHLPersistent.h.

PI_SettingList& PI_OHLPersistent::getSettingList ( )
inline

Definition at line 55 of file PI_OHLPersistent.h.

void PI_OHLPersistent::handleOpChange ( OP_Node *  op,
OP_EventType  etype,
void *  data 
)
overrideprotectedvirtual

Reimplemented from PI_OpHandleLink.

void PI_OHLPersistent::setActiveColor ( const UT_Color &  c)
overridevirtual

Reimplemented from PI_OpHandleLink.

void PI_OHLPersistent::setDisplayAlways ( bool  display)
void PI_OHLPersistent::setDisplayInChild ( bool  display)
void PI_OHLPersistent::setDisplayInParent ( bool  display)
void PI_OHLPersistent::setDisplayInSibling ( bool  display)
int PI_OHLPersistent::setEqual ( const PI_OpHandleLink &  pi)
overridevirtual

Reimplemented from PI_OpHandleLink.

void PI_OHLPersistent::setExpose ( bool  expose)
void PI_OHLPersistent::setName ( const char *  name)
void PI_OHLPersistent::setPaneMask ( const char *  mask)
void PI_OHLPersistent::setPIOwner ( PI_OpHandleLink *  piowner)
inline

Definition at line 48 of file PI_OHLPersistent.h.

void PI_OHLPersistent::setSettings ( const char *  setting_string)

Friends And Related Function Documentation

friend class PI_Manager
friend

Definition at line 84 of file PI_OHLPersistent.h.

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