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

#include <BM_SimpleState.h>

+ Inheritance diagram for BM_SimpleState:

Public Types

enum  BM_EntryType { BM_FULLTIME_ENTRY = 0x01, BM_OVERLAY_ENTRY = 0x02 }
 

Public Member Functions

 BM_SimpleState (BM_SceneManager &app, const char *cursor, const char *name=0, const char *const *vnames=0, UI_EventMethod const *vmethods=0)
 
virtual ~BM_SimpleState (void)
 
virtual UI_Menu * getStateMenu (int ortho=0)
 
virtual UI_Menu * getSelectorMenu ()
 
virtual UI_Menu * getExtraStateMenu ()
 
virtual int enter (BM_EntryType how=BM_SimpleState::BM_OVERLAY_ENTRY)=0
 
virtual void exit (void)=0
 
virtual void interrupt (BM_SimpleState *=0)
 
virtual void resume (BM_SimpleState *=0)
 
virtual int handleMouseEvent (UI_Event *event)=0
 
virtual int handleArrowEvent (UI_Event *event)=0
 
virtual int handleKeyEvent (UI_Event *event)
 
virtual int handleParameterEvent (UI_Event *event)
 
virtual void render (RE_Render *r, int x, int y)
 
virtual void overlayRender (RE_Render *r, int x, int y)
 
virtual int getToolboxCount () const
 
virtual UI_Feel * getToolbox (int index) const
 
virtual const char * className (void) const
 
virtual int isHandle () const =0
 
void setVolatileViewport (BM_Viewport *view)
 
BM_Viewport * getVolatileViewport () const
 
virtual int isModifier (void) const
 
BM_SceneManager & sceneManager (void)
 
const BM_SceneManager & sceneManager (void) const
 
void setSavedState (BM_SimpleState *state)
 
BM_SimpleStategetSavedState ()
 
const BM_SimpleStategetSavedState () const
 
virtual const char * replaceCursor (const char *newcursor)
 
const char * getCurrentCursor () const
 
unsigned int getViewportMask () const
 
const UT_UndoWorkerFinder
< BM_SimpleState > & 
undoWorkerFinder () const
 
- Public Member Functions inherited from AP_Interface
 AP_Interface ()
 
 AP_Interface (const char *myname, const char *const *names, UI_EventMethod const *methods)
 
virtual ~AP_Interface ()
 
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
 
void removeObjectSymbol (const char *symbol)
 Delete the entry for the given object symbol name. More...
 
template<typename T >
TfindObject (const char *name) const
 
template<typename T >
TfindValue (const char *name) const
 
void resetApplication ()
 
virtual void handleEvent (UI_Event *event)
 
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)
 
bool restoreUIInitPrefs ()
 
bool getFunctionKeyScript (UI_Event *event, UT_String &script)
 
- 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_String &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 *)
 

Protected Member Functions

virtual void handlePopupMenuEvent (UI_Event *event)
 
virtual int handleKeyTypeEvent (UI_Event *event, BM_Viewport &viewport)
 
void pushCursor (void)
 
void popCursor (void)
 
void setCursor (void)
 
void setCursor (const char *cursorname)
 
void setDefaultCursor (const char *cursorname)
 
void initializeUI ()
 
virtual void initApplication (UI_Manager *, int c, const char **v)
 
virtual void getUIFileName (UT_String &full_path_and_name) const
 
void mouseDown (UI_Event *event)
 
int mouseDown (void) const
 
void beginDistributedUndoBlock (const char *operation, UT_UndoBlockType blocktype)
 
void endDistributedUndoBlock ()
 
bool inDistributedUndoBlock ()
 
void setViewportMask (unsigned mask)
 
int getClickInterest ()
 
void addClickInterest (int buttons)
 
void removeClickInterest (int buttons)
 
void redrawScene ()
 
- Protected Member Functions inherited from AP_Interface
UI_NamedValueMapgetValueTable (void) const
 
UI_NamedObjectMapgetObjectTable (void) const
 
virtual void getSignalList (int *signals, int max_signals)
 
- Protected Member Functions inherited from UI_Object
UI_ObjectListdependents ()
 
virtual void preTerminateCallback ()
 

Additional Inherited Members

- Static Public Member Functions inherited from AP_Interface
static FILE * createPreferenceFile (const char *filename)
 
static int mapStrToInt (const char *label, const UT_Pair< const char *, int > *map)
 
static const char * mapIntToStr (int index, const UT_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 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 Public Attributes inherited from AP_Interface
static const UT_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 setAppForeground ()
 
static void setTheMainApplication (AP_Interface *app)
 
static AP_InterfacegetMainApplication ()
 
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)
 
- Protected Attributes inherited from AP_Interface
UT_String myName
 
const char *constmyValueNames
 
UI_EventMethod constmyMethods
 

Detailed Description

Examples:
SOP/MSS_CustomBrushState.C, and SOP/MSS_CustomBrushState.h.

Definition at line 33 of file BM_SimpleState.h.

Member Enumeration Documentation

Enumerator
BM_FULLTIME_ENTRY 
BM_OVERLAY_ENTRY 

Definition at line 36 of file BM_SimpleState.h.

Constructor & Destructor Documentation

BM_SimpleState::BM_SimpleState ( BM_SceneManager &  app,
const char *  cursor,
const char *  name = 0,
const char *const vnames = 0,
UI_EventMethod const vmethods = 0 
)
virtual BM_SimpleState::~BM_SimpleState ( void  )
virtual

Member Function Documentation

void BM_SimpleState::addClickInterest ( int  buttons)
protected
void BM_SimpleState::beginDistributedUndoBlock ( const char *  operation,
UT_UndoBlockType  blocktype 
)
protected
virtual const char* BM_SimpleState::className ( void  ) const
virtual
void BM_SimpleState::endDistributedUndoBlock ( )
protected
virtual void BM_SimpleState::exit ( void  )
pure virtual
int BM_SimpleState::getClickInterest ( )
protected
const char* BM_SimpleState::getCurrentCursor ( ) const
inline

Definition at line 122 of file BM_SimpleState.h.

virtual UI_Menu* BM_SimpleState::getExtraStateMenu ( )
virtual

Reimplemented in MSS_SingleOpState.

BM_SimpleState* BM_SimpleState::getSavedState ( )
inline

Definition at line 115 of file BM_SimpleState.h.

const BM_SimpleState* BM_SimpleState::getSavedState ( ) const
inline

Definition at line 117 of file BM_SimpleState.h.

virtual UI_Menu* BM_SimpleState::getSelectorMenu ( )
virtual

Reimplemented in MSS_SingleOpState.

virtual UI_Menu* BM_SimpleState::getStateMenu ( int  ortho = 0)
virtual
virtual UI_Feel* BM_SimpleState::getToolbox ( int  index) const
virtual
virtual int BM_SimpleState::getToolboxCount ( ) const
virtual
virtual void BM_SimpleState::getUIFileName ( UT_String full_path_and_name) const
protectedvirtual

Reimplemented in HDK_Sample::MSS_BrushHairLen.

unsigned int BM_SimpleState::getViewportMask ( ) const
inline

Definition at line 127 of file BM_SimpleState.h.

BM_Viewport* BM_SimpleState::getVolatileViewport ( ) const
inline

Definition at line 100 of file BM_SimpleState.h.

virtual int BM_SimpleState::handleArrowEvent ( UI_Event event)
pure virtual

Implemented in BM_State.

virtual int BM_SimpleState::handleKeyEvent ( UI_Event event)
virtual
virtual int BM_SimpleState::handleKeyTypeEvent ( UI_Event event,
BM_Viewport &  viewport 
)
protectedvirtual
virtual int BM_SimpleState::handleMouseEvent ( UI_Event event)
pure virtual
virtual int BM_SimpleState::handleParameterEvent ( UI_Event event)
virtual

Reimplemented in BM_ParmState, and MSS_BrushBaseState.

virtual void BM_SimpleState::handlePopupMenuEvent ( UI_Event event)
protectedvirtual
bool BM_SimpleState::inDistributedUndoBlock ( )
protected
virtual void BM_SimpleState::initApplication ( UI_Manager uims,
int  argc,
const char **  argv 
)
protectedvirtual

Initialize this object. This method is intended to be overriden by subclasses since the base class implementation is empty. The subclass typically calls readUIFile() here to create the interface which populates the object and value symbols.

Reimplemented from AP_Interface.

Reimplemented in BM_ParmState.

void BM_SimpleState::initializeUI ( )
protected
virtual void BM_SimpleState::interrupt ( BM_SimpleState = 0)
virtual
virtual int BM_SimpleState::isHandle ( ) const
pure virtual

Implemented in BM_State.

virtual int BM_SimpleState::isModifier ( void  ) const
inlinevirtual

Reimplemented in BM_State.

Definition at line 106 of file BM_SimpleState.h.

void BM_SimpleState::mouseDown ( UI_Event event)
protected
int BM_SimpleState::mouseDown ( void  ) const
inlineprotected

Definition at line 164 of file BM_SimpleState.h.

virtual void BM_SimpleState::overlayRender ( RE_Render r,
int  x,
int  y 
)
virtual
void BM_SimpleState::popCursor ( void  )
protected
void BM_SimpleState::pushCursor ( void  )
protected
void BM_SimpleState::redrawScene ( )
protected
void BM_SimpleState::removeClickInterest ( int  buttons)
protected
virtual void BM_SimpleState::render ( RE_Render r,
int  x,
int  y 
)
virtual

Reimplemented in BM_State.

virtual const char* BM_SimpleState::replaceCursor ( const char *  newcursor)
virtual

Reimplemented in BM_State.

virtual void BM_SimpleState::resume ( BM_SimpleState = 0)
virtual
BM_SceneManager& BM_SimpleState::sceneManager ( void  )
inline

Definition at line 109 of file BM_SimpleState.h.

const BM_SceneManager& BM_SimpleState::sceneManager ( void  ) const
inline

Definition at line 110 of file BM_SimpleState.h.

void BM_SimpleState::setCursor ( void  )
protected
void BM_SimpleState::setCursor ( const char *  cursorname)
protected
void BM_SimpleState::setDefaultCursor ( const char *  cursorname)
protected
void BM_SimpleState::setSavedState ( BM_SimpleState state)
inline

Definition at line 113 of file BM_SimpleState.h.

void BM_SimpleState::setViewportMask ( unsigned  mask)
inlineprotected

Definition at line 180 of file BM_SimpleState.h.

void BM_SimpleState::setVolatileViewport ( BM_Viewport *  view)
inline

Definition at line 98 of file BM_SimpleState.h.

const UT_UndoWorkerFinder<BM_SimpleState>& BM_SimpleState::undoWorkerFinder ( ) const
inline

Definition at line 129 of file BM_SimpleState.h.


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