BM_SimpleState Class Reference

#include <BM_SimpleState.h>

Inheritance diagram for BM_SimpleState:

AP_Interface UI_Object BM_ParmState BM_State BM_OpState BM_SingleOpState MSS_SingleOpBaseState MSS_FaceState MSS_KnifeState MSS_PolyKnitState MSS_PolySplitState MSS_SingleOpState HDK_Sample::MSS_CustomBrushState MSS_BrushBaseState MSS_ButtonlessState MSS_CenterPivotState MSS_EditState MSS_LatticeState MSS_PeltState MSS_UVEditState MSS_UVViewportState

List of all members.

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, short x, short 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_SimpleState * getSavedState ()
const BM_SimpleState * getSavedState () const
virtual const char * replaceCursor (const char *newcursor)
const char * getCurrentCursor () const
unsigned int getViewportMask () const
const UT_UndoWorkerFinder
< BM_SimpleState > & 		undoWorkerFinder () const

Protected Member Functions

virtual const char * getUIDirectory () const =0
virtual int 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 ()
void setViewportMask (unsigned mask)
int getClickInterest ()
void addClickInterest (int buttons)
void removeClickInterest (int buttons)
void redrawScene ()

Detailed Description

Examples:

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

Definition at line 40 of file BM_SimpleState.h.

Member Enumeration Documentation

enum BM_SimpleState::BM_EntryType

Enumerator:
BM_FULLTIME_ENTRY 
BM_OVERLAY_ENTRY 

Definition at line 43 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]

Examples:
SOP/MSS_CustomBrushState.C.

void BM_SimpleState::beginDistributedUndoBlock ( const char *  operation,
UT_UndoBlockType  blocktype 
) [protected]

Examples:
SOP/MSS_CustomBrushState.C.

virtual const char* BM_SimpleState::className ( void   )  const [virtual]

Reimplemented from UI_Object.

Reimplemented in BM_OpState, BM_ParmState, BM_SingleOpState, BM_State, MSS_BrushBaseState, MSS_ButtonlessState, MSS_CaptureLayerPaintState, MSS_CenterPivotState, MSS_CombState, MSS_EditState, MSS_FaceState, MSS_KnifeState, MSS_LatticeState, MSS_PaintSlideModifierState, MSS_PaintState, MSS_PeltState, MSS_PolyKnitState, MSS_PolySplitState, MSS_SculptState, MSS_SingleOpBaseState, MSS_SingleOpState, MSS_UVBrushState, MSS_UVCenterPivotState, MSS_UVEditState, MSS_UVViewportState, HDK_Sample::MSS_BrushHairLen, and HDK_Sample::MSS_CustomBrushState.

void BM_SimpleState::endDistributedUndoBlock (  )  [protected]

Examples:
SOP/MSS_CustomBrushState.C.

virtual int BM_SimpleState::enter ( BM_EntryType  how = BM_SimpleState::BM_OVERLAY_ENTRY  )  [pure virtual]

Implemented in BM_SingleOpState, BM_State, MSS_BrushBaseState, MSS_CaptureLayerPaintState, MSS_CombState, MSS_EditState, MSS_FaceState, MSS_KnifeState, MSS_PolyKnitState, MSS_PolySplitState, MSS_SingleOpState, and HDK_Sample::MSS_CustomBrushState.

virtual void BM_SimpleState::exit ( void   )  [pure virtual]

Implemented in BM_SingleOpState, BM_State, MSS_BrushBaseState, MSS_CombState, MSS_EditState, MSS_FaceState, MSS_KnifeState, MSS_PolyKnitState, MSS_PolySplitState, MSS_SingleOpState, and HDK_Sample::MSS_CustomBrushState.

int BM_SimpleState::getClickInterest (  )  [protected]

const char* BM_SimpleState::getCurrentCursor (  )  const [inline]

Definition at line 126 of file BM_SimpleState.h.

virtual UI_Menu* BM_SimpleState::getExtraStateMenu (  )  [virtual]

Reimplemented in MSS_SingleOpState.

const BM_SimpleState* BM_SimpleState::getSavedState (  )  const [inline]

Definition at line 121 of file BM_SimpleState.h.

BM_SimpleState* BM_SimpleState::getSavedState (  )  [inline]

Definition at line 119 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]

Reimplemented in MSS_EditState.

virtual UI_Feel* BM_SimpleState::getToolbox ( int  index  )  const [virtual]

Reimplemented in BM_ParmState, BM_SingleOpState, and MSS_SingleOpState.

virtual int BM_SimpleState::getToolboxCount (  )  const [virtual]

Reimplemented in BM_ParmState, BM_SingleOpState, MSS_KnifeState, MSS_PolySplitState, and MSS_SingleOpState.

virtual const char* BM_SimpleState::getUIDirectory (  )  const [protected, pure virtual]

Implemented in MSS_SingleOpBaseState.

virtual void BM_SimpleState::getUIFileName ( UT_String &  full_path_and_name  )  const [protected, virtual]

Reimplemented in HDK_Sample::MSS_BrushHairLen.

unsigned int BM_SimpleState::getViewportMask (  )  const [inline]

Definition at line 131 of file BM_SimpleState.h.

BM_Viewport* BM_SimpleState::getVolatileViewport (  )  const [inline]

Definition at line 104 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 
) [protected, virtual]

Reimplemented in BM_OpState, MSS_BrushBaseState, MSS_CaptureLayerPaintState, MSS_CombState, MSS_EditState, MSS_FaceState, MSS_KnifeState, MSS_PaintSlideModifierState, MSS_PaintState, MSS_PolyKnitState, MSS_PolySplitState, MSS_SculptState, MSS_SingleOpBaseState, MSS_SingleOpState, MSS_UVBrushState, MSS_UVEditState, and HDK_Sample::MSS_BrushHairLen.

virtual int BM_SimpleState::handleMouseEvent ( UI_Event *  event  )  [pure virtual]

Implemented in BM_OpState, BM_State, MSS_BrushBaseState, MSS_CaptureLayerPaintState, MSS_EditState, MSS_FaceState, MSS_KnifeState, MSS_PolyKnitState, MSS_PolySplitState, MSS_SingleOpState, and HDK_Sample::MSS_CustomBrushState.

virtual int BM_SimpleState::handleParameterEvent ( UI_Event *  event  )  [virtual]

Reimplemented in BM_ParmState, MSS_BrushBaseState, MSS_CaptureLayerPaintState, MSS_CombState, MSS_EditState, MSS_FaceState, MSS_PaintBaseState, MSS_PaintSlideModifierState, MSS_PaintState, MSS_PolyKnitState, and MSS_PolySplitState.

virtual int BM_SimpleState::handlePopupMenuEvent ( UI_Event *  event  )  [protected, virtual]

virtual void BM_SimpleState::initApplication ( UI_Manager *  ,
int  c,
const char **  v 
) [protected, virtual]

Reimplemented from AP_Interface.

Reimplemented in BM_ParmState.

void BM_SimpleState::initializeUI (  )  [protected]

virtual void BM_SimpleState::interrupt ( BM_SimpleState *  = 0  )  [virtual]

Reimplemented in BM_OpState, BM_State, MSS_BrushBaseState, MSS_EditState, MSS_FaceState, MSS_KnifeState, MSS_PolyKnitState, MSS_PolySplitState, and HDK_Sample::MSS_CustomBrushState.

virtual int BM_SimpleState::isHandle (  )  const [pure virtual]

Implemented in BM_State.

virtual int BM_SimpleState::isModifier ( void   )  const [inline, virtual]

Reimplemented in BM_State.

Definition at line 110 of file BM_SimpleState.h.

int BM_SimpleState::mouseDown ( void   )  const [inline, protected]

Definition at line 171 of file BM_SimpleState.h.

void BM_SimpleState::mouseDown ( UI_Event *  event  )  [protected]

void BM_SimpleState::popCursor ( void   )  [protected]

void BM_SimpleState::pushCursor ( void   )  [protected]

void BM_SimpleState::redrawScene (  )  [protected]

Examples:
SOP/MSS_CustomBrushState.C.

void BM_SimpleState::removeClickInterest ( int  buttons  )  [protected]

Examples:
SOP/MSS_CustomBrushState.C.

virtual void BM_SimpleState::render ( RE_Render *  r,
short  x,
short  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]

Reimplemented in BM_OpState, BM_State, MSS_BrushBaseState, MSS_EditState, MSS_FaceState, MSS_KnifeState, MSS_PaintBaseState, MSS_PolyKnitState, MSS_PolySplitState, MSS_SingleOpState, and HDK_Sample::MSS_CustomBrushState.

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

Definition at line 114 of file BM_SimpleState.h.

BM_SceneManager& BM_SimpleState::sceneManager ( void   )  [inline]

Definition at line 113 of file BM_SimpleState.h.

void BM_SimpleState::setCursor ( const char *  cursorname  )  [protected]

void BM_SimpleState::setCursor ( void   )  [protected]

void BM_SimpleState::setDefaultCursor ( const char *  cursorname  )  [protected]

void BM_SimpleState::setSavedState ( BM_SimpleState *  state  )  [inline]

Definition at line 117 of file BM_SimpleState.h.

void BM_SimpleState::setViewportMask ( unsigned  mask  )  [inline, protected]

Definition at line 186 of file BM_SimpleState.h.

void BM_SimpleState::setVolatileViewport ( BM_Viewport *  view  )  [inline]

Definition at line 102 of file BM_SimpleState.h.

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

Definition at line 133 of file BM_SimpleState.h.

The documentation for this class was generated from the following file:
Generated on Mon Jan 28 00:48:02 2013 for HDK by  doxygen 1.5.9