HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
BM_OpState Class Referenceabstract

#include <BM_OpState.h>

+ Inheritance diagram for BM_OpState:

Public Member Functions

 BM_OpState (BM_OpView &view, PI_StateTemplate &templ, BM_SceneManager *sceneManager, const char *cursor=BM_DEFAULT_CURSOR)
 
 ~BM_OpState () override
 
int handleMouseEvent (UI_Event *event) override
 
int handleMouseWheelEvent (UI_Event *event) override
 
const char * className () const override
 
void prepareDialogForDisplay () const override
 
int hasDialog () const override
 
UI_Feel * dialogFeel () const override
 
int findPI (BM_OpHandleLink *pi) const override
 
virtual bool updateInvisiblePIHandleForMoveTool (bool(*func)(BM_Handle *handle, BM_MoveTool::Type tool, unsigned vport_mask), BM_MoveTool::Type tool, unsigned vport_mask, bool make_visible)
 
fpreal getTime () const
 Obtains the current global time. More...
 
bool getStateParmNames (UT_StringArray &ret, const char *prefix=nullptr) override
 
bool evalStateParm (const char *name, UT_StringHolder &ret) override
 
bool setStateParm (const char *name, const UT_StringHolder &val) override
 
bool pressStateButton (const char *name) override
 
BM_OpHandleLink * piByRootDescription (const char *description)
 
BM_OpHandleLink const * piByRootDescription (const char *description) const
 
virtual const char * getOperatorName () const
 
- Public Member Functions inherited from BM_State
 BM_State (BM_SceneManager &app, PI_StateTemplate &templ, const char *cursor=0, const char *const *vnames=0, UI_EventMethod const *vmethods=0)
 
 ~BM_State () override
 
int getUniqueId () const
 
virtual void status (UT_String &s) const
 
virtual void renderStatusExtras (RE_Render *)
 
int isHandle () const override
 
int enter (BM_SimpleState::BM_EntryType how) override
 
void exit () override
 
virtual void concealState ()
 
virtual void revealState ()
 
void interrupt (BM_SimpleState *state=0) override
 
void resume (BM_SimpleState *state=0) override
 
virtual void handleVolatileChanges ()
 
virtual void onVolatileState (BM_SimpleState const *volatile_state, bool overriding_state)
 
virtual int preprocessSelect (UI_Event *event)
 
int handleMouseEvent (UI_Event *event) override
 
virtual bool handleDoubleClickEvent (UI_Event *)
 
virtual void handleGeoChangedEvent (UI_Event *)
 
virtual void handleDetailLookGeoChanged (BM_DetailLook *look)
 
void propagateDetailLookGeoChanged (BM_DetailLook *look)
 
void render (RE_Render *r, int x, int y) override
 
virtual void renderPartialOverlay (RE_Render *r, int x, int y)
 
virtual int generate (BM_SimpleState::BM_EntryType how, const GenerateParms &parms)
 
void startGenerating (BM_State::BM_GenerateMode how=BM_State::BM_INLINE, bool requestnew=false, bool exsitu=false)
 
virtual void stopGenerating ()
 
virtual void restart ()
 
int meetsOverlayEntryConditions (const UI_Event &event) const
 
virtual int hasOpNode (const OP_Node &) const
 
virtual void handleOpNodeChange (OP_Node &)
 
virtual void handleOpUIChange (OP_Node &)
 
virtual void handleOpNetChange (OP_Network &)
 
virtual void handleOpNetClear ()
 
virtual int handleNodeDeleted (OP_Node &)
 
void wantsLocates (int yesNo)
 
virtual int hasLocates () const
 
virtual bool doesHandleLocates () const
 
int isPreempted () const
 
int isBuilding () const
 
int isEntered () const
 
bool isConcealed () const
 
int isGenerating () const
 
int isGeneratingInline () const
 
bool isRequestingNew () const
 
bool isGeneratingExSitu () const
 
int isRegenerating () const
 
bool isOverlay () const override
 
int isFullTime () const
 
int isModifier () const override
 
virtual bool ignoreDisplayFlagChange () const
 
int isSticky () const
 
virtual bool getAllowIndirectHandleDrag () const
 
virtual BM_RMBMenuPopupMode getRMBMenuPopupMode (short altflags) const
 
const char * className () const override
 
const PI_StateTemplategetTemplate () const
 
PI_StateTemplategetTemplate ()
 
virtual int isOpIndependent () const
 
virtual bool canSwitchToOpDependent () const
 
virtual void switchToOpDependent ()
 
const char * getHotkeyString () const override
 
const char * getIconName () const override
 
const char * getLabel () const override
 
const char * getDescription () const override
 
virtual void afterUndo ()
 
virtual void refreshBindings (int id, const char *op_type)
 
virtual void refreshSettings (int id, const char *op_type)
 
const char * replaceCursor (const char *newcursor) override
 
virtual void getHelp (UT_String &help_text, bool &is_html)
 
virtual void getHelpDirAndNameOrUrl (UT_StringHolder &dir, UT_StringHolder &name, UT_StringHolder &url)
 
virtual bool showPersistent () const
 
virtual bool wantFailedOrienterEvent () const
 
virtual bool getShowSelectedOp () const
 
virtual void resetStateForNew ()
 
virtual UI_Feel * getCustomSelectModeSideBar () const
 
virtual bool useSecureSelection () const
 
virtual bool useVolatileSelection () const
 
bool isBusyProcessing () const
 
virtual int testDragDrop (DD_Source &)
 
virtual void getDragDropChoice (DD_Source &, DD_ChoiceList &)
 
virtual int acceptDragDrop (DD_Source &, const char *)
 
virtual bool switchHandleTool (BM_MoveTool::Type tool, bool reveal_updated_handles)
 
virtual bool overrideSelectState (UT_StringHolder &new_state)
 
virtual void initializeHUDs ()
 
int updateHUD (UT_HUDInfoArgs const &args)
 
void stealNewStateHUDQueue (UT_Array< HUDInfoArgsCopyUPtr > &&queue)
 
void enterHUD ()
 
void exitHUD ()
 
void renderHUD ()
 
UT_Array< int > const & viewportEventIDs () const
 
UT_Array< int > & viewportEventIDs ()
 
- Public Member Functions inherited from BM_ParmState
 BM_ParmState (BM_SceneManager &app, const char *cursor, const char *vname=0, const char *english=0, const char *const *vnames=0, UI_EventMethod const *vmethods=0)
 
 ~BM_ParmState () override
 
const UT_Stringname () const
 
const UT_Stringenglish () const
 
int getToolboxCount () const override
 
UI_Feel * getToolbox (int index) const override
 
UI_Feel * extraDialogFeel () const
 
virtual void initializeUI (PRM_Template *tmpl=0)
 
void refreshParms ()
 
- Public Member Functions inherited from BM_SimpleState
 BM_SimpleState (BM_SceneManager &app, const char *cursor, const char *name=0, const char *const *vnames=0, UI_EventMethod const *vmethods=0)
 
 ~BM_SimpleState () override
 
virtual UI_Menu * getStateMenu (int ortho=0)
 
virtual UI_Menu * getSelectorMenu ()
 
virtual UI_Menu * getExtraStateMenu ()
 
virtual void onBeginRMBMenu (UI_Event *)
 
virtual bool canShowStateMenu () const
 
virtual int handleKeyEvent (int key, UI_Event *event) final
 
virtual void overlayRender (RE_Render *r, int x, int y)
 
virtual int getVolatileToolboxCount () const
 
virtual UI_Feel * getVolatileToolbox (int index) const
 
void setVolatileViewport (BM_Viewport *view)
 
BM_Viewport * getVolatileViewport () const
 
BM_SceneManager & sceneManager ()
 
const BM_SceneManager & sceneManager () const
 
void setSavedState (BM_SimpleState *state)
 
BM_SimpleStategetSavedState ()
 
const BM_SimpleStategetSavedState () const
 
const char * getCurrentCursor () const
 
unsigned int getViewportMask () const
 
const UT_UndoWorkerFinder
< BM_SimpleState > & 
undoWorkerFinder () const
 
void beginDistributedUndoBlock (const char *operation, UT_UndoBlockType blocktype, bool ignore_log=false)
 
void endDistributedUndoBlock (bool ignore_log=false)
 
bool inDistributedUndoBlock ()
 
- Public Member Functions inherited from AP_Interface
 AP_Interface ()
 
 AP_Interface (const char *myname, const char *const *names, UI_EventMethod const *methods)
 
 ~AP_Interface () override
 
const char * className () const override
 
const UT_StringgetName () const
 Return the name passed in the constructor. More...
 
void wireInterface (UI_Manager *uims)
 
void unwireInterface (UI_Manager *uims)
 
bool readUIFile (const char *ui_filename, bool quiet=false)
 
bool readPreferenceFile (const char *pref_filename, bool quiet=false)
 
void setValueSymbol (const char *symbol, UI_Value *value, bool warn=true)
 
UI_ValuefindValueSymbol (const char *symbol) const
 Find the UI_Value for the given named value symbol. More...
 
UI_ValuegetValueSymbol (const char *symbol, int create=1)
 
int getValueSymbols (UT_StringArray &symbols, UT_Array< UI_Value * > &values) const
 
void setObjectSymbol (const char *symbol, UI_Object *who, int warn=1)
 
UI_ObjectgetObjectSymbol (const char *symbol) const
 
UI_Feel * getFeelSymbol (const char *symbol) const
 
UI_Feel * findValueFeel (UI_Value *value) const
 
int getFeelSymbols (UT_StringArray &symbols, UT_Array< UI_Feel * > &feels) const
 
void setKeyDelegateSymbol (const char *symbol, UI_KeyDelegateSPtr delegate, bool warn=true)
 
bool hasKeyDelegateSymbol (const char *symbol) const
 Returns whether the current key delegate symbol is defined. More...
 
UI_KeyDelegateSPtr findKeyDelegateSymbol (const char *symbol) const
 Find the UI_KeyDelegate for the given named key delegate symbol. More...
 
UI_KeyDelegateSPtr getKeyDelegateSymbol (const char *symbol, int create=1)
 
void removeObjectSymbol (const char *symbol)
 Delete the entry for the given object symbol name. More...
 
void removeValueSymbol (const char *symbol)
 Delete the entry for the given value symbol name. More...
 
template<typename T >
TfindObject (const char *name) const
 
template<typename T >
TfindValue (const char *name) const
 
virtual void outputUsage (int argc, const char **argv) const
 
void resetApplication ()
 
void handleEvent (UI_Event *event) override
 
virtual int saveAppData (const char *filename)
 
virtual int loadAppState ()
 
virtual int saveAppState ()
 
virtual void saveOnCoreDump ()
 
virtual bool getCoreDumpFileName (UT_WorkBuffer &name)
 
bool loadUIInitPrefs ()
 
void saveUIInitPrefs (const char *layout_level, fpreal uiscale, int playbarui)
 
bool restoreUIInitPrefs ()
 
bool getFunctionKeyScript (int key, UI_Event *event, UT_String &script)
 
void setKeyBindingProxySrc (const char *symbol, UI_Feel *src, bool warn=true)
 
void addKeyBindingProxyRef (const char *symbol, UI_Feel *ref, bool warn=true)
 
- Public Member Functions inherited from UI_Object
 UI_Object ()
 
virtual ~UI_Object ()
 
 UI_Object (const UI_Object &)=delete
 
UI_Objectoperator= (const UI_Object &)=delete
 
virtual int interestingEvent (UI_EventType t, UI_DeviceEvent *event) const
 
virtual void deleteReferences (UI_Object *to_whom)
 
UI_ObjectgetParent () const
 
void setParent (UI_Object *p)
 
bool isAncestor (const UI_Object *who) const
 
void addDependent (UI_Object *who)
 
bool removeDependent (UI_Object *who)
 
bool replaceDependent (UI_Object *who, UI_Object *with)
 
bool isDependent (UI_Object *who) const
 
bool hasDependents () const
 
const UI_ObjectListdependents () const
 
void sendEvent (const UI_Event &e) const
 
void distributeEvent (UI_Event *event, int upwards)
 
void relayEvent (UI_Event *event, UI_Object *target)
 
void generateEvent (UI_EventType t, UI_Object *target)
 
void purgeEvents (UI_EventType t, UI_Object *target, UI_EventMethod method=0)
 
void triggerImmediateEvent (UI_Event *event, int upwards)
 
int getProxyId ()
 
void bumpQueueCount (int dir)
 
void setName (const char *symbolName)
 
const char * getName () const
 
void buildFullPath (UT_WorkBuffer &string) const
 
void debugQueueEventsFor (const UI_Value *value, const char *name, UI_EventType t=UI_EVENT_NO_EVENT) const
 
const UI_ValueListvalueInterests () const
 
void interestedInValue (UI_Value *)
 
void removeValueInterest (UI_Value *)
 
void addKeyDelegateClientship (UI_KeyDelegate *)
 
void removeKeyDelegateClientship (UI_KeyDelegate *)
 

Static Public Member Functions

static int getAutoHighlightFlag ()
 
static void setAutoHighlightFlag (int o)
 
- Static Public Member Functions inherited from BM_State
static UT_OptionsgetGlobalPrefs ()
 
- Static Public Member Functions inherited from AP_Interface
static FILE * createPreferenceFile (const char *filename)
 
static int mapStrToInt (const char *label, const std::pair< const char *, int > *map)
 
static const char * mapIntToStr (int index, const std::pair< const char *, int > *map)
 
static void setAppExitCode (int exit_code)
 
static int getAppExitCode ()
 
static bool isAppExiting ()
 Returns true if the application is exiting. More...
 
static const char * getStartupDesktop ()
 
- Static Public Member Functions inherited from UI_Object
static UI_ManagergetManager ()
 
static UI_Queue * getInputQueue ()
 
static int keycmp (const char *, int key)
 
static int keycmp (const char *, int key, const UI_HotkeyEcho &)
 
static void keyEcho (const char *, const UI_HotkeyEcho &)
 
static void actionKeyEcho (const char *, const char *custom_suffix=0)
 
static void toggleKeyEcho (const char *, bool new_value)
 

Protected Member Functions

BM_OpView & baseViewer ()
 
const BM_OpView & baseViewer () const
 
void interrupt (BM_SimpleState *=0) override
 
void resume (BM_SimpleState *=0) override
 
void getKeyResolveInfo (UI_KeyResolveInfo &info) override
 
int handleKeyTypeEvent (int key, UI_Event *event, BM_Viewport &viewport) override
 
bool handleTransitoryKey (const UI_Event &event, int hotkey_id) override
 
int createPI (const char *pi_name, int opnum=-1, const char *description=0)
 
virtual void onCreatePI (PI_OpHandleLink *pi)
 
virtual void onAppendPI (PI_OpHandleLink *pi)
 
virtual void onRemovePI (PI_OpHandleLink *pi)
 
int appendPI (BM_OpHandleLink *pi, int opnum=-1)
 
virtual void removePI (int pi_idx)
 
void removeAllLinkedPIs ()
 
void removeLinkedPIByDescription (const char *descr_name)
 
BM_OpHandleLink * pi (int index)
 
const BM_OpHandleLink * pi (int index) const
 
BM_OpHandleLink * pi (const char *name)
 
const BM_OpHandleLink * pi (const char *name) const
 
const char * piDescription (int index) const
 
int piOpnum (int index) const
 
int numPIs () const
 
virtual void makePIVisible (int pi_idx, int onoff)
 
int appendFolder (const char *folder_name)
 
void appendFeelToFolder (const char *folder_name, UI_Feel *child_feel)
 
int appendDialogToFolder (const char *folder_name, BM_ParmState &state_or_handle)
 
int appendDialogToFolder (const char *folder_name, OP_Node &op_node, PRM_Template::PRM_Export export_level)
 
int appendThisStateDialogToFolder (const char *folder_name)
 
int appendDividerToFolder (const char *folder_name)
 
int appendTextToFolder (const char *folder_name, const char *text, UI_LookType look_type=UI_LOOK_HEADING_TEXT)
 
int removeDialog (BM_ParmState &state)
 
int removeDialog (OP_Node &op_node, PRM_Template::PRM_Export export_level)
 
int removeFolder (const char *name, bool only_if_empty=false)
 
int appendDialogToFolder (const char *folder_name, BM_ParmState &state_or_handle, BM_Handle *handle)
 
int appendDividerToFolder (const char *folder_name, BM_Handle *handle)
 
int appendTextToFolder (const char *folder_name, const char *text, UI_LookType look_type, BM_Handle *handle)
 
int removeCachedUIItems (const char *folder_name, BM_Handle *handle)
 
void switchToFolder (const char *name)
 
virtual void handleDialogDeleted (OPUI_Dialog *deleted_dialog)
 
virtual void removeAllDialogs ()
 
void handlePIVisibilityChange (UI_Event *event)
 
void connectNode (OP_Node &newnode, OP_Node &inputnode, int input_idx=0, int branch_off=0)
 
void stampNode (OP_Node &newnode)
 
virtual int matchesNode (OP_Node &node) const =0
 
- Protected Member Functions inherited from BM_State
virtual void doRender (RE_Render *r, int x, int y, int ghost)
 
virtual void doRenderSaved (RE_Render *r, int x, int y, int ghost)
 
void setModifier (int yn)
 
int meetsBasicOverlayEntryConditions (const UI_Event &e) const
 
virtual void setBuild (int onOff)
 
void handleMouseEventVoidRet (UI_Event *event)
 
void renderSaved (RE_Render *r, int x, int y, int ghost)
 
- Protected Member Functions inherited from BM_ParmState
virtual const char * getPresetTypeName () const =0
 
void initApplication (UI_Manager *, int, const char **) override
 
const PRM_Parmparameter (const char *name) const
 
PRM_Parmparameter (const char *name)
 
PRM_ParmListparameters () const
 
UI_ValueparmValue () const
 
const PRM_Parmparameter (int index) const
 
PRM_Parmparameter (int index)
 
void setParm (const char *name, const UT_String &value, CH_StringMeaning meaning, fpreal t=0, int refresh=1)
 
void setParm (const char *name, int value, fpreal t=0, int refresh=1)
 
void setParm (const char *name, fpreal value, fpreal t=0, int refresh=1)
 
void setXYParm (const char *name, fpreal x, fpreal y, fpreal t=0, int refresh=1)
 
void setXYZParm (const char *name, fpreal x, fpreal y, fpreal z, fpreal t=0, int refresh=1)
 
void setParm (int index, const UT_String &v, CH_StringMeaning meaning, fpreal t=0, int refresh=1)
 
void setParm (int index, int value, fpreal t=0, int refresh=1)
 
void setParm (int index, fpreal value, fpreal t=0, int refresh=1)
 
void setXYParm (int index, fpreal x, fpreal y, fpreal t=0, int refresh=1)
 
void setXYZParm (int index, fpreal x, fpreal y, fpreal z, fpreal t=0, int refresh=1)
 
bool parmExists (const char *name) const
 
bool parmExists (int index) const
 
void getParm (const char *name, UT_String &value, fpreal t=0) const
 
void getParm (const char *name, int &value, fpreal t=0) const
 
void getParm (const char *name, bool &value, fpreal t=0) const
 
void getParm (const char *name, fpreal &value, fpreal t=0) const
 
void getXYParm (const char *name, fpreal &x, fpreal &y, fpreal t=0) const
 
void getXYParm (const char *name, int &x, int &y, fpreal t=0) const
 
void getXYZParm (const char *n, fpreal &x, fpreal &y, fpreal &z, fpreal t=0) const
 
void getParm (int index, UT_String &value, fpreal t=0) const
 
void getParm (int index, int &value, fpreal t=0) const
 
void getParm (int index, bool &value, fpreal t=0) const
 
void getParm (int index, fpreal &value, fpreal t=0) const
 
void getXYParm (int index, fpreal &x, fpreal &y, fpreal t=0) const
 
void getXYParm (int index, int &x, int &y, fpreal t=0) const
 
void getXYZParm (int index, fpreal &x, fpreal &y, fpreal &z, fpreal t=0) const
 
void overwriteParmDefault (const char *name, fpreal t=0)
 
void overwriteXYParmDefault (const char *name, fpreal t=0)
 
void overwriteXYZParmDefault (const char *name, fpreal t=0)
 
void overwriteParmDefault (int index, fpreal t=0)
 
void overwriteXYParmDefault (int index, fpreal t=0)
 
void overwriteXYZParmDefault (int index, fpreal t=0)
 
void overwriteParmDefaults ()
 
virtual int disableParms ()
 
int enableParm (const char *name, int onoff, int refresh=1)
 
int enableParm (int index, int onoff, int refresh=1)
 
bool setVisibleState (int pi, bool state, bool refresh=true)
 
bool setVisibleState (const char *pn, bool state, bool refresh=true)
 
void refreshParm (int index)
 
int handleParameterEvent (UI_Event *event) override
 
bool saveParmForUndo (int index, bool force=false)
 
virtual int handleSaveParmForUndo (int index)
 
virtual int handleParameterUndo (int parm_index)
 
int getSaveParmForUndoFlag ()
 
void setSaveParmForUndoFlag (int onoff)
 
PSI2_DialogPRM * getParmDialog ()
 
- Protected Member Functions inherited from BM_SimpleState
virtual void handlePopupMenuEvent (UI_Event *event)
 
void pushCursor ()
 
void popCursor ()
 
void setCursor ()
 
void setCursor (const char *cursorname)
 
void setDefaultCursor (const char *cursorname)
 
void initializeUI ()
 
void initApplication (UI_Manager *, int, const char **) override
 
virtual void getUIFileName (UT_String &full_path_and_name) const
 
void mouseDown (UI_Event *event)
 
int mouseDown () const
 
void setViewportMask (unsigned mask)
 
int getClickInterest ()
 
void addClickInterest (int buttons)
 
void removeClickInterest (int buttons)
 
void redrawScene ()
 
void closeOpenUndoBlock ()
 
- Protected Member Functions inherited from AP_Interface
UI_NamedValueMapgetValueTable () const
 
UI_NamedObjectMapgetObjectTable () const
 
void processKeyBindingProxyRequests ()
 
- Protected Member Functions inherited from UI_Object
UI_ObjectListdependents ()
 
virtual void preTerminateCallback ()
 

Protected Attributes

BM_OpView & myViewer
 
UT_ValArray< opbm_DialogInfo * > myDialogs
 
UT_ValArray< opbm_PIContext * > myPIs
 
UT_ValArray< UI_Feel * > myMiscFeels
 
SI_Folders * myFolders
 
- Protected Attributes inherited from BM_State
BM_StateFlags myFlags
 
- Protected Attributes inherited from AP_Interface
UT_String myName
 
const char *const * myValueNames
 
UI_EventMethod const * myMethods
 

Static Protected Attributes

static const char * STATE_DIALOG_FOLDER
 
static const char * HANDLES_FOLDER
 
static const char * OP_DIALOG_FOLDER
 
static int theAutoHighlightFlag
 
- Static Protected Attributes inherited from BM_State
static bool theDelayedSelectionEventIsValid
 
static UI_Event theDelayedSelectionEvent
 

Additional Inherited Members

- Public Types inherited from BM_State
enum  BM_GenerateMode { BM_INLINE = 0x01, BM_OUTLINE = 0x02, BM_REGENERATE = 0x04 }
 
enum  BM_RMBMenuPopupMode { BM_RMB_MENU_ALLOWED, BM_RMB_MENU_DELAYED, BM_RMB_MENU_DENIED }
 
using HUDInfoArgsCopyUPtr = UT_UniquePtr< BM_HUDInfoArgsCopy >
 
- Public Types inherited from BM_SimpleState
enum  BM_EntryType { BM_FULLTIME_ENTRY = 0x01, BM_OVERLAY_ENTRY = 0x02 }
 
- Static Public Attributes inherited from AP_Interface
static const std::pair< const
char *, int
theFileChooserStyleMap []
 Menu items and their mapping for file chooser style preference. More...
 
- Static Protected Member Functions inherited from AP_Interface
static void setTheMainApplication (AP_Interface *app)
 
static AP_InterfacegetMainApplication ()
 
static void clearTheMainApplication ()
 
static void loadWindowGeometry (UI_Window *window, bool default_maximized, bool use_pref)
 
static bool getWindowGeometry (int &width, int &height, int &left, int &bottom, bool &maximized, bool use_pref)
 
static bool getSaveWindowGeoPref ()
 
static void saveWindowGeoPref ()
 
static bool loadWindowGeoPref (int &w, int &h, int &left, int &bottom, bool &maximized)
 

Detailed Description

Definition at line 40 of file BM_OpState.h.

Constructor & Destructor Documentation

BM_OpState::BM_OpState ( BM_OpView &  view,
PI_StateTemplate templ,
BM_SceneManager *  sceneManager,
const char *  cursor = BM_DEFAULT_CURSOR 
)
BM_OpState::~BM_OpState ( )
override

Member Function Documentation

int BM_OpState::appendDialogToFolder ( const char *  folder_name,
BM_ParmState state_or_handle 
)
protected
int BM_OpState::appendDialogToFolder ( const char *  folder_name,
OP_Node op_node,
PRM_Template::PRM_Export  export_level 
)
protected
int BM_OpState::appendDialogToFolder ( const char *  folder_name,
BM_ParmState state_or_handle,
BM_Handle *  handle 
)
protected
int BM_OpState::appendDividerToFolder ( const char *  folder_name)
protected
int BM_OpState::appendDividerToFolder ( const char *  folder_name,
BM_Handle *  handle 
)
protected
void BM_OpState::appendFeelToFolder ( const char *  folder_name,
UI_Feel *  child_feel 
)
protected
int BM_OpState::appendFolder ( const char *  folder_name)
protected
int BM_OpState::appendPI ( BM_OpHandleLink *  pi,
int  opnum = -1 
)
protected
int BM_OpState::appendTextToFolder ( const char *  folder_name,
const char *  text,
UI_LookType  look_type = UI_LOOK_HEADING_TEXT 
)
protected
int BM_OpState::appendTextToFolder ( const char *  folder_name,
const char *  text,
UI_LookType  look_type,
BM_Handle *  handle 
)
protected
int BM_OpState::appendThisStateDialogToFolder ( const char *  folder_name)
protected
BM_OpView& BM_OpState::baseViewer ( )
inlineprotected

Definition at line 106 of file BM_OpState.h.

const BM_OpView& BM_OpState::baseViewer ( ) const
inlineprotected

Definition at line 107 of file BM_OpState.h.

const char* BM_OpState::className ( ) const
overridevirtual
void BM_OpState::connectNode ( OP_Node newnode,
OP_Node inputnode,
int  input_idx = 0,
int  branch_off = 0 
)
protected
int BM_OpState::createPI ( const char *  pi_name,
int  opnum = -1,
const char *  description = 0 
)
protected
UI_Feel* BM_OpState::dialogFeel ( ) const
overridevirtual

Reimplemented from BM_ParmState.

bool BM_OpState::evalStateParm ( const char *  name,
UT_StringHolder ret 
)
overridevirtual

Reimplemented from BM_ParmState.

int BM_OpState::findPI ( BM_OpHandleLink *  pi) const
overridevirtual

Reimplemented from BM_State.

static int BM_OpState::getAutoHighlightFlag ( )
inlinestatic

Definition at line 76 of file BM_OpState.h.

void BM_OpState::getKeyResolveInfo ( UI_KeyResolveInfo &  info)
overrideprotectedvirtual

Reimplemented from BM_State.

Reimplemented in MSS_SingleOpState, MSS_BrushBaseState, and MSS_SingleOpBaseState.

virtual const char* BM_OpState::getOperatorName ( ) const
virtual

Reimplemented in MSS_SingleOpState.

bool BM_OpState::getStateParmNames ( UT_StringArray ret,
const char *  prefix = nullptr 
)
overridevirtual

Reimplemented from BM_ParmState.

fpreal BM_OpState::getTime ( ) const

Obtains the current global time.

Examples:
SOP/MSS_CustomBrushState.C.
virtual void BM_OpState::handleDialogDeleted ( OPUI_Dialog *  deleted_dialog)
protectedvirtual

Reimplemented in BM_SingleOpState.

int BM_OpState::handleKeyTypeEvent ( int  key,
UI_Event event,
BM_Viewport &  viewport 
)
overrideprotectedvirtual
int BM_OpState::handleMouseEvent ( UI_Event event)
overridevirtual
int BM_OpState::handleMouseWheelEvent ( UI_Event event)
overridevirtual

Reimplemented from BM_State.

Reimplemented in MSS_SingleOpState, and MSS_BrushBaseState.

void BM_OpState::handlePIVisibilityChange ( UI_Event event)
protected
bool BM_OpState::handleTransitoryKey ( const UI_Event event,
int  hotkey_id 
)
overrideprotectedvirtual

Reimplemented from BM_State.

Reimplemented in MSS_SingleOpState.

int BM_OpState::hasDialog ( ) const
overridevirtual

Reimplemented from BM_ParmState.

void BM_OpState::interrupt ( BM_SimpleState = 0)
overrideprotectedvirtual
virtual void BM_OpState::makePIVisible ( int  pi_idx,
int  onoff 
)
protectedvirtual

Reimplemented in BM_SingleOpState.

virtual int BM_OpState::matchesNode ( OP_Node node) const
protectedpure virtual

Implemented in BM_SingleOpState.

int BM_OpState::numPIs ( ) const
inlineprotected

Definition at line 149 of file BM_OpState.h.

virtual void BM_OpState::onAppendPI ( PI_OpHandleLink pi)
protectedvirtual
virtual void BM_OpState::onCreatePI ( PI_OpHandleLink pi)
protectedvirtual
virtual void BM_OpState::onRemovePI ( PI_OpHandleLink pi)
protectedvirtual
BM_OpHandleLink* BM_OpState::pi ( int  index)
protected
const BM_OpHandleLink* BM_OpState::pi ( int  index) const
protected
BM_OpHandleLink* BM_OpState::pi ( const char *  name)
protected
const BM_OpHandleLink* BM_OpState::pi ( const char *  name) const
protected
BM_OpHandleLink* BM_OpState::piByRootDescription ( const char *  description)
BM_OpHandleLink const* BM_OpState::piByRootDescription ( const char *  description) const
const char* BM_OpState::piDescription ( int  index) const
protected
int BM_OpState::piOpnum ( int  index) const
protected
void BM_OpState::prepareDialogForDisplay ( ) const
overridevirtual

Reimplemented from BM_ParmState.

bool BM_OpState::pressStateButton ( const char *  name)
overridevirtual

Reimplemented from BM_ParmState.

virtual void BM_OpState::removeAllDialogs ( )
protectedvirtual

Reimplemented in BM_SingleOpState.

void BM_OpState::removeAllLinkedPIs ( )
protected
int BM_OpState::removeCachedUIItems ( const char *  folder_name,
BM_Handle *  handle 
)
protected
int BM_OpState::removeDialog ( BM_ParmState state)
protected
int BM_OpState::removeDialog ( OP_Node op_node,
PRM_Template::PRM_Export  export_level 
)
protected
int BM_OpState::removeFolder ( const char *  name,
bool  only_if_empty = false 
)
protected
void BM_OpState::removeLinkedPIByDescription ( const char *  descr_name)
protected
virtual void BM_OpState::removePI ( int  pi_idx)
protectedvirtual
void BM_OpState::resume ( BM_SimpleState = 0)
overrideprotectedvirtual
static void BM_OpState::setAutoHighlightFlag ( int  o)
inlinestatic

Definition at line 77 of file BM_OpState.h.

bool BM_OpState::setStateParm ( const char *  name,
const UT_StringHolder val 
)
overridevirtual

Reimplemented from BM_ParmState.

void BM_OpState::stampNode ( OP_Node newnode)
protected
void BM_OpState::switchToFolder ( const char *  name)
protected
virtual bool BM_OpState::updateInvisiblePIHandleForMoveTool ( bool(*)(BM_Handle *handle, BM_MoveTool::Type tool, unsigned vport_mask)  func,
BM_MoveTool::Type  tool,
unsigned  vport_mask,
bool  make_visible 
)
virtual

Member Data Documentation

const char* BM_OpState::HANDLES_FOLDER
staticprotected

Definition at line 220 of file BM_OpState.h.

UT_ValArray<opbm_DialogInfo *> BM_OpState::myDialogs
protected

Definition at line 214 of file BM_OpState.h.

SI_Folders* BM_OpState::myFolders
protected

Definition at line 217 of file BM_OpState.h.

UT_ValArray<UI_Feel *> BM_OpState::myMiscFeels
protected

Definition at line 216 of file BM_OpState.h.

UT_ValArray<opbm_PIContext *> BM_OpState::myPIs
protected

Definition at line 215 of file BM_OpState.h.

BM_OpView& BM_OpState::myViewer
protected

Definition at line 212 of file BM_OpState.h.

const char* BM_OpState::OP_DIALOG_FOLDER
staticprotected

Definition at line 221 of file BM_OpState.h.

const char* BM_OpState::STATE_DIALOG_FOLDER
staticprotected

Definition at line 219 of file BM_OpState.h.

int BM_OpState::theAutoHighlightFlag
staticprotected

Definition at line 222 of file BM_OpState.h.


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