HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
BM_State Class Reference

#include <BM_State.h>

+ Inheritance diagram for BM_State:

Classes

struct  Busy
 
class  GenerateParms
 

Public Types

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 }
 

Public Member Functions

 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 int handleMouseWheelEvent (UI_Event *event)
 
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 void getKeyResolveInfo (UI_KeyResolveInfo &info)
 
virtual bool handleTransitoryKey (const UI_Event &, int)
 
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
 
virtual int findPI (BM_OpHandleLink *pi) 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 > constviewportEventIDs () 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
 
virtual void prepareDialogForDisplay () const
 
virtual int hasDialog () const
 
virtual UI_Feel * dialogFeel () const
 
int getToolboxCount () const override
 
UI_Feel * getToolbox (int index) const override
 
UI_Feel * extraDialogFeel () const
 
virtual void initializeUI (PRM_Template *tmpl=0)
 
virtual bool getStateParmNames (UT_StringArray &ret, const char *prefix=nullptr)
 
virtual bool evalStateParm (const char *name, UT_StringHolder &ret)
 
virtual bool setStateParm (const char *name, const UT_StringHolder &val)
 
virtual bool pressStateButton (const char *name)
 
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 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

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)
 
virtual int handleKeyTypeEvent (int key, UI_Event *event, BM_Viewport &viewport)
 
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_StateFlags myFlags
 
- Protected Attributes inherited from AP_Interface
UT_String myName
 
const char *constmyValueNames
 
UI_EventMethod constmyMethods
 

Static Protected Attributes

static bool theDelayedSelectionEventIsValid
 
static UI_Event theDelayedSelectionEvent
 

Friends

class Busy
 
class bmQtNotifier
 

Additional Inherited Members

- 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

Member Typedef Documentation

using BM_State::HUDInfoArgsCopyUPtr = UT_UniquePtr<BM_HUDInfoArgsCopy>

Definition at line 473 of file BM_State.h.

Member Enumeration Documentation

Enumerator
BM_INLINE 
BM_OUTLINE 
BM_REGENERATE 

Definition at line 75 of file BM_State.h.

Enumerator
BM_RMB_MENU_ALLOWED 
BM_RMB_MENU_DELAYED 
BM_RMB_MENU_DENIED 

Definition at line 321 of file BM_State.h.

Constructor & Destructor Documentation

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::~BM_State ( )
override

Member Function Documentation

virtual int BM_State::acceptDragDrop ( DD_Source ,
const char *   
)
inlinevirtual

Definition at line 430 of file BM_State.h.

virtual void BM_State::afterUndo ( )
virtual
virtual bool BM_State::canSwitchToOpDependent ( ) const
inlinevirtual

Definition at line 354 of file BM_State.h.

const char* BM_State::className ( ) const
overridevirtual
virtual void BM_State::concealState ( )
virtual
virtual bool BM_State::doesHandleLocates ( ) const
inlinevirtual

Definition at line 267 of file BM_State.h.

virtual void BM_State::doRender ( RE_Render r,
int  x,
int  y,
int  ghost 
)
protectedvirtual
virtual void BM_State::doRenderSaved ( RE_Render r,
int  x,
int  y,
int  ghost 
)
protectedvirtual
int BM_State::enter ( BM_SimpleState::BM_EntryType  how)
overridevirtual
void BM_State::enterHUD ( )
void BM_State::exit ( )
overridevirtual
void BM_State::exitHUD ( )
virtual int BM_State::findPI ( BM_OpHandleLink *  pi) const
virtual

Reimplemented in BM_OpState.

virtual int BM_State::generate ( BM_SimpleState::BM_EntryType  how,
const GenerateParms parms 
)
virtual

Reimplemented in MSS_SingleOpState, and BM_SingleOpState.

virtual bool BM_State::getAllowIndirectHandleDrag ( ) const
inlinevirtual

Reimplemented in MSS_BrushBaseState.

Definition at line 316 of file BM_State.h.

virtual UI_Feel* BM_State::getCustomSelectModeSideBar ( ) const
inlinevirtual

Definition at line 404 of file BM_State.h.

const char* BM_State::getDescription ( ) const
overridevirtual

Reimplemented from BM_SimpleState.

virtual void BM_State::getDragDropChoice ( DD_Source ,
DD_ChoiceList  
)
inlinevirtual

Definition at line 427 of file BM_State.h.

static UT_Options& BM_State::getGlobalPrefs ( )
static
virtual void BM_State::getHelp ( UT_String help_text,
bool &  is_html 
)
virtual
virtual void BM_State::getHelpDirAndNameOrUrl ( UT_StringHolder dir,
UT_StringHolder name,
UT_StringHolder url 
)
virtual
const char* BM_State::getHotkeyString ( ) const
overridevirtual

Reimplemented from BM_SimpleState.

const char* BM_State::getIconName ( ) const
overridevirtual

Reimplemented from BM_SimpleState.

virtual void BM_State::getKeyResolveInfo ( UI_KeyResolveInfo &  info)
virtual
const char* BM_State::getLabel ( ) const
overridevirtual

Reimplemented from BM_SimpleState.

virtual BM_RMBMenuPopupMode BM_State::getRMBMenuPopupMode ( short  altflags) const
virtual
virtual bool BM_State::getShowSelectedOp ( ) const
inlinevirtual

Definition at line 396 of file BM_State.h.

const PI_StateTemplate& BM_State::getTemplate ( ) const
inline

Definition at line 332 of file BM_State.h.

PI_StateTemplate& BM_State::getTemplate ( )
inline

Definition at line 333 of file BM_State.h.

int BM_State::getUniqueId ( ) const
inline

Definition at line 88 of file BM_State.h.

virtual void BM_State::handleDetailLookGeoChanged ( BM_DetailLook look)
virtual
virtual bool BM_State::handleDoubleClickEvent ( UI_Event )
virtual

Reimplemented in MSS_SingleOpState.

virtual void BM_State::handleGeoChangedEvent ( UI_Event )
virtual

Reimplemented in MSS_SingleOpState.

int BM_State::handleMouseEvent ( UI_Event event)
overridevirtual
void BM_State::handleMouseEventVoidRet ( UI_Event event)
protected
virtual int BM_State::handleMouseWheelEvent ( UI_Event event)
virtual
virtual int BM_State::handleNodeDeleted ( OP_Node )
virtual

Reimplemented in MSS_SingleOpState, and BM_SingleOpState.

virtual void BM_State::handleOpNetChange ( OP_Network )
virtual
virtual void BM_State::handleOpNetClear ( )
virtual

Reimplemented in BM_SingleOpState.

virtual void BM_State::handleOpNodeChange ( OP_Node )
virtual

Reimplemented in MSS_BrushBaseState.

virtual void BM_State::handleOpUIChange ( OP_Node )
virtual
virtual bool BM_State::handleTransitoryKey ( const UI_Event ,
int   
)
inlinevirtual

Reimplemented in MSS_SingleOpState, and BM_OpState.

Definition at line 247 of file BM_State.h.

virtual void BM_State::handleVolatileChanges ( )
inlinevirtual

Reimplemented in MSS_SingleOpState.

Definition at line 136 of file BM_State.h.

virtual int BM_State::hasLocates ( ) const
inlinevirtual

Reimplemented in MSS_SingleOpState.

Definition at line 266 of file BM_State.h.

virtual int BM_State::hasOpNode ( const OP_Node ) const
virtual

Reimplemented in BM_SingleOpState.

virtual bool BM_State::ignoreDisplayFlagChange ( ) const
inlinevirtual

Reimplemented in MSS_SingleOpState.

Definition at line 303 of file BM_State.h.

virtual void BM_State::initializeHUDs ( )
virtual
void BM_State::interrupt ( BM_SimpleState state = 0)
overridevirtual
int BM_State::isBuilding ( ) const
inline

Definition at line 271 of file BM_State.h.

bool BM_State::isBusyProcessing ( ) const
inline

Definition at line 417 of file BM_State.h.

bool BM_State::isConcealed ( ) const
inline

Definition at line 273 of file BM_State.h.

int BM_State::isEntered ( ) const
inline

Definition at line 272 of file BM_State.h.

int BM_State::isFullTime ( ) const
inline

Definition at line 290 of file BM_State.h.

int BM_State::isGenerating ( ) const
inline

Definition at line 275 of file BM_State.h.

bool BM_State::isGeneratingExSitu ( ) const
inline

Definition at line 280 of file BM_State.h.

int BM_State::isGeneratingInline ( ) const
inline

Definition at line 276 of file BM_State.h.

int BM_State::isHandle ( ) const
inlineoverridevirtual

Implements BM_SimpleState.

Definition at line 101 of file BM_State.h.

int BM_State::isModifier ( ) const
inlineoverridevirtual

Reimplemented from BM_SimpleState.

Definition at line 295 of file BM_State.h.

virtual int BM_State::isOpIndependent ( ) const
virtual
bool BM_State::isOverlay ( ) const
inlineoverridevirtual

Reimplemented from BM_SimpleState.

Definition at line 285 of file BM_State.h.

int BM_State::isPreempted ( ) const
inline
Examples:
SOP/MSS_CustomBrushState.C.

Definition at line 270 of file BM_State.h.

int BM_State::isRegenerating ( ) const
inline

Definition at line 282 of file BM_State.h.

bool BM_State::isRequestingNew ( ) const
inline

Definition at line 278 of file BM_State.h.

int BM_State::isSticky ( ) const
inline

Definition at line 312 of file BM_State.h.

int BM_State::meetsBasicOverlayEntryConditions ( const UI_Event e) const
protected
int BM_State::meetsOverlayEntryConditions ( const UI_Event event) const
virtual void BM_State::onVolatileState ( BM_SimpleState const volatile_state,
bool  overriding_state 
)
virtual
virtual bool BM_State::overrideSelectState ( UT_StringHolder new_state)
inlinevirtual

Definition at line 455 of file BM_State.h.

virtual int BM_State::preprocessSelect ( UI_Event event)
virtual
void BM_State::propagateDetailLookGeoChanged ( BM_DetailLook look)
virtual void BM_State::refreshBindings ( int  id,
const char *  op_type 
)
virtual

Reimplemented in BM_SingleOpState.

virtual void BM_State::refreshSettings ( int  id,
const char *  op_type 
)
virtual

Reimplemented in BM_SingleOpState.

void BM_State::render ( RE_Render r,
int  x,
int  y 
)
overridevirtual

Reimplemented from BM_SimpleState.

void BM_State::renderHUD ( )
virtual void BM_State::renderPartialOverlay ( RE_Render r,
int  x,
int  y 
)
virtual
void BM_State::renderSaved ( RE_Render r,
int  x,
int  y,
int  ghost 
)
protected
virtual void BM_State::renderStatusExtras ( RE_Render )
inlinevirtual

Definition at line 99 of file BM_State.h.

const char* BM_State::replaceCursor ( const char *  newcursor)
overridevirtual

Reimplemented from BM_SimpleState.

virtual void BM_State::resetStateForNew ( )
inlinevirtual

Definition at line 400 of file BM_State.h.

virtual void BM_State::restart ( )
virtual
void BM_State::resume ( BM_SimpleState state = 0)
overridevirtual
virtual void BM_State::revealState ( )
virtual
virtual void BM_State::setBuild ( int  onOff)
protectedvirtual
void BM_State::setModifier ( int  yn)
inlineprotected

Definition at line 504 of file BM_State.h.

virtual bool BM_State::showPersistent ( ) const
inlinevirtual

Definition at line 388 of file BM_State.h.

void BM_State::startGenerating ( BM_State::BM_GenerateMode  how = BM_State::BM_INLINE,
bool  requestnew = false,
bool  exsitu = false 
)
inline

Definition at line 219 of file BM_State.h.

virtual void BM_State::status ( UT_String s) const
inlinevirtual

Definition at line 94 of file BM_State.h.

void BM_State::stealNewStateHUDQueue ( UT_Array< HUDInfoArgsCopyUPtr > &&  queue)
virtual void BM_State::stopGenerating ( )
inlinevirtual

Reimplemented in BM_SingleOpState.

Definition at line 228 of file BM_State.h.

virtual bool BM_State::switchHandleTool ( BM_MoveTool::Type  tool,
bool  reveal_updated_handles 
)
inlinevirtual

Definition at line 442 of file BM_State.h.

virtual void BM_State::switchToOpDependent ( )
virtual
virtual int BM_State::testDragDrop ( DD_Source )
inlinevirtual

Definition at line 423 of file BM_State.h.

int BM_State::updateHUD ( UT_HUDInfoArgs const args)
virtual bool BM_State::useSecureSelection ( ) const
inlinevirtual

Definition at line 407 of file BM_State.h.

virtual bool BM_State::useVolatileSelection ( ) const
inlinevirtual

Definition at line 410 of file BM_State.h.

UT_Array<int> const& BM_State::viewportEventIDs ( ) const
inline

Definition at line 480 of file BM_State.h.

UT_Array<int>& BM_State::viewportEventIDs ( )
inline

Definition at line 485 of file BM_State.h.

virtual bool BM_State::wantFailedOrienterEvent ( ) const
inlinevirtual

Definition at line 393 of file BM_State.h.

void BM_State::wantsLocates ( int  yesNo)
inline
Examples:
SOP/MSS_CustomBrushState.C.

Definition at line 265 of file BM_State.h.

Friends And Related Function Documentation

friend class bmQtNotifier
friend

Definition at line 556 of file BM_State.h.

friend class Busy
friend

Definition at line 491 of file BM_State.h.

Member Data Documentation

BM_StateFlags BM_State::myFlags
protected

Definition at line 550 of file BM_State.h.

UI_Event BM_State::theDelayedSelectionEvent
staticprotected

Definition at line 553 of file BM_State.h.

bool BM_State::theDelayedSelectionEventIsValid
staticprotected

Definition at line 552 of file BM_State.h.


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