BM_State Class Reference

#include <BM_State.h>

Inheritance diagram for BM_State:

BM_ParmState BM_SimpleState AP_Interface UI_Object 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_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 }

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)
virtual ~BM_State (void)
virtual void status (UT_String &s) const
virtual void renderStatusExtras (RE_Render *)
virtual int isHandle () const
virtual int enter (BM_SimpleState::BM_EntryType how)
virtual void exit (void)
virtual void concealState ()
virtual void revealState ()
virtual void interrupt (BM_SimpleState *state=0)
virtual void resume (BM_SimpleState *state=0)
virtual int preprocessSelect (UI_Event *event)
virtual int handleMouseEvent (UI_Event *event)
virtual int handleMouseWheelEvent (UI_Event *event)
virtual bool handleDoubleClickEvent (UI_Event *)
virtual int handleArrowEvent (UI_Event *event)
virtual void handleGeoChangedEvent (UI_Event *)
virtual void render (RE_Render *r, short x, short y)
virtual void renderPartialOverlay (RE_Render *r, short x, short y)
virtual int generate (BM_SimpleState::BM_EntryType how, bool insertmode=true)
void startGenerating (BM_State::BM_GenerateMode how=BM_State::BM_INLINE)
virtual void stopGenerating (void)
virtual void restart (void)
virtual void addEntryConditions (void)
virtual void removeEntryConditions (void)
int meetsEntryConditions (const UI_Event &event) const
virtual int isEntryCondition (UI_Keyboard key) const
virtual bool handleTransitoryKey (const UI_Event &)
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 (void) const
int isPreempted () const
int isBuilding () const
int isEntered (void) const
bool isConcealed (void) const
int isGenerating () const
int isGeneratingInline () const
int isRegenerating () const
int isOverlay (void) const
int isFullTime (void) const
virtual int isModifier (void) const
virtual bool ignoreDisplayFlagChange () const
virtual int findPI (BM_OpHandleLink *pi) const
int isSticky (void) const
virtual BM_RMBMenuPopupMode getRMBMenuPopupMode () const
int index (void) const
void index (int idx)
virtual const char * className (void) const
const PI_StateTemplate & getTemplate () const
PI_StateTemplate & getTemplate ()
virtual const char * getOperationBarIconName () const
virtual const char * getOperationBarLabel () const
virtual void afterUndo ()
virtual void refreshBindings (int id, const char *op_type)
virtual void refreshSettings (int id, const char *op_type)
virtual const char * replaceCursor (const char *newcursor)
virtual void getHelp (UT_String &help_text, bool &is_html)
virtual void getHelpDirAndNameOrUrl (UT_String &dir, UT_String &name, UT_String &url)
virtual bool showPersistent () const
virtual bool wantFailedOrienterEvent () const
virtual bool getShowSelectedOp () const
virtual bool renderFloorFirst () const
virtual void resetStateForNew ()

Protected Member Functions

virtual void doRender (RE_Render *r, short x, short y, int ghost)
void setModifier (int yn)
int meetsBasicEntryConditions (const UI_Event &e) const
virtual void setBuild (int onOff)

Protected Attributes

BM_StateFlags myFlags

Static Protected Attributes

static bool theDelayedSelectionEventIsValid
static UI_Event theDelayedSelectionEvent

Detailed Description

Examples:

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

Definition at line 56 of file BM_State.h.

Member Enumeration Documentation

enum BM_State::BM_GenerateMode

Enumerator:
BM_INLINE 
BM_OUTLINE 
BM_REGENERATE 

Definition at line 59 of file BM_State.h.

enum BM_State::BM_RMBMenuPopupMode

Enumerator:
BM_RMB_MENU_ALLOWED 
BM_RMB_MENU_DELAYED 
BM_RMB_MENU_DENIED 

Definition at line 244 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 
)

virtual BM_State::~BM_State ( void   )  [virtual]

Member Function Documentation

virtual void BM_State::addEntryConditions ( void   )  [virtual]

virtual void BM_State::afterUndo (  )  [virtual]

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

Reimplemented from BM_ParmState.

Reimplemented in BM_OpState, BM_SingleOpState, 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.

virtual void BM_State::concealState (  )  [virtual]

virtual void BM_State::doRender ( RE_Render *  r,
short  x,
short  y,
int  ghost 
) [protected, virtual]

Reimplemented in MSS_BrushBaseState, MSS_CaptureLayerPaintState, MSS_CombState, MSS_EditState, MSS_FaceState, MSS_KnifeState, MSS_PeltState, MSS_PolyKnitState, MSS_PolySplitState, MSS_SingleOpState, and HDK_Sample::MSS_CustomBrushState.

virtual int BM_State::enter ( BM_SimpleState::BM_EntryType  how  )  [virtual]

Implements BM_SimpleState.

Reimplemented in BM_SingleOpState, 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_State::exit ( void   )  [virtual]

Implements BM_SimpleState.

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

virtual int BM_State::findPI ( BM_OpHandleLink *  pi  )  const [virtual]

Reimplemented in BM_OpState.

virtual int BM_State::generate ( BM_SimpleState::BM_EntryType  how,
bool  insertmode = true 
) [virtual]

Reimplemented in BM_SingleOpState, and MSS_SingleOpState.

virtual void BM_State::getHelp ( UT_String &  help_text,
bool &  is_html 
) [virtual]

virtual void BM_State::getHelpDirAndNameOrUrl ( UT_String &  dir,
UT_String &  name,
UT_String &  url 
) [virtual]

virtual const char* BM_State::getOperationBarIconName (  )  const [virtual]

Reimplemented in MSS_EditState.

virtual const char* BM_State::getOperationBarLabel (  )  const [virtual]

Reimplemented in MSS_EditState.

virtual BM_RMBMenuPopupMode BM_State::getRMBMenuPopupMode (  )  const [virtual]

virtual bool BM_State::getShowSelectedOp (  )  const [inline, virtual]

Definition at line 299 of file BM_State.h.

PI_StateTemplate& BM_State::getTemplate (  )  [inline]

Definition at line 260 of file BM_State.h.

const PI_StateTemplate& BM_State::getTemplate (  )  const [inline]

Definition at line 259 of file BM_State.h.

virtual int BM_State::handleArrowEvent ( UI_Event *  event  )  [virtual]

Implements BM_SimpleState.

virtual bool BM_State::handleDoubleClickEvent ( UI_Event *   )  [virtual]

Reimplemented in MSS_SingleOpState.

virtual void BM_State::handleGeoChangedEvent ( UI_Event *   )  [virtual]

virtual int BM_State::handleMouseEvent ( UI_Event *  event  )  [virtual]

Implements BM_SimpleState.

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

virtual int BM_State::handleMouseWheelEvent ( UI_Event *  event  )  [virtual]

virtual int BM_State::handleNodeDeleted ( OP_Node &   )  [virtual]

Reimplemented in BM_SingleOpState, MSS_FaceState, MSS_PolySplitState, and MSS_SingleOpState.

virtual void BM_State::handleOpNetChange ( OP_Network &   )  [virtual]

virtual void BM_State::handleOpNetClear (  )  [virtual]

virtual void BM_State::handleOpNodeChange ( OP_Node &   )  [virtual]

Reimplemented in MSS_BrushBaseState, MSS_EditState, MSS_FaceState, MSS_PolyKnitState, and MSS_PolySplitState.

virtual void BM_State::handleOpUIChange ( OP_Node &   )  [virtual]

virtual bool BM_State::handleTransitoryKey ( const UI_Event &   )  [inline, virtual]

Reimplemented in MSS_SingleOpState.

Definition at line 183 of file BM_State.h.

virtual int BM_State::hasLocates ( void   )  const [inline, virtual]

Reimplemented in MSS_SingleOpState.

Definition at line 201 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 [inline, virtual]

Reimplemented in MSS_SingleOpState.

Definition at line 230 of file BM_State.h.

void BM_State::index ( int  idx  )  [inline]

Definition at line 254 of file BM_State.h.

int BM_State::index ( void   )  const [inline]

Definition at line 253 of file BM_State.h.

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

Reimplemented from BM_SimpleState.

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

int BM_State::isBuilding (  )  const [inline]

Definition at line 205 of file BM_State.h.

bool BM_State::isConcealed ( void   )  const [inline]

Definition at line 207 of file BM_State.h.

int BM_State::isEntered ( void   )  const [inline]

Definition at line 206 of file BM_State.h.

virtual int BM_State::isEntryCondition ( UI_Keyboard  key  )  const [virtual]

int BM_State::isFullTime ( void   )  const [inline]

Definition at line 220 of file BM_State.h.

int BM_State::isGenerating (  )  const [inline]

Definition at line 209 of file BM_State.h.

int BM_State::isGeneratingInline (  )  const [inline]

Definition at line 210 of file BM_State.h.

virtual int BM_State::isHandle (  )  const [inline, virtual]

Implements BM_SimpleState.

Definition at line 83 of file BM_State.h.

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

Reimplemented from BM_SimpleState.

Definition at line 225 of file BM_State.h.

int BM_State::isOverlay ( void   )  const [inline]

Definition at line 215 of file BM_State.h.

int BM_State::isPreempted (  )  const [inline]

Examples:
SOP/MSS_CustomBrushState.C.

Definition at line 204 of file BM_State.h.

int BM_State::isRegenerating (  )  const [inline]

Definition at line 212 of file BM_State.h.

int BM_State::isSticky ( void   )  const [inline]

Definition at line 239 of file BM_State.h.

int BM_State::meetsBasicEntryConditions ( const UI_Event &  e  )  const [protected]

int BM_State::meetsEntryConditions ( const UI_Event &  event  )  const

virtual int BM_State::preprocessSelect ( UI_Event *  event  )  [virtual]

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.

virtual void BM_State::removeEntryConditions ( void   )  [virtual]

virtual void BM_State::render ( RE_Render *  r,
short  x,
short  y 
) [virtual]

Reimplemented from BM_SimpleState.

virtual bool BM_State::renderFloorFirst (  )  const [inline, virtual]

Definition at line 303 of file BM_State.h.

virtual void BM_State::renderPartialOverlay ( RE_Render *  r,
short  x,
short  y 
) [virtual]

virtual void BM_State::renderStatusExtras ( RE_Render *   )  [inline, virtual]

Reimplemented in MSS_CaptureLayerPaintState.

Definition at line 81 of file BM_State.h.

virtual const char* BM_State::replaceCursor ( const char *  newcursor  )  [virtual]

Reimplemented from BM_SimpleState.

virtual void BM_State::resetStateForNew (  )  [inline, virtual]

Definition at line 307 of file BM_State.h.

virtual void BM_State::restart ( void   )  [virtual]

Reimplemented in BM_SingleOpState, MSS_BrushBaseState, MSS_EditState, MSS_KnifeState, MSS_LatticeState, MSS_PeltState, MSS_PolyKnitState, MSS_PolySplitState, MSS_SingleOpState, and MSS_UVEditState.

virtual void BM_State::resume ( BM_SimpleState *  state = 0  )  [virtual]

Reimplemented from BM_SimpleState.

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

virtual void BM_State::revealState (  )  [virtual]

virtual void BM_State::setBuild ( int  onOff  )  [protected, virtual]

Reimplemented in MSS_FaceState, MSS_PolyKnitState, and MSS_PolySplitState.

void BM_State::setModifier ( int  yn  )  [inline, protected]

Definition at line 317 of file BM_State.h.

virtual bool BM_State::showPersistent (  )  const [inline, virtual]

Definition at line 291 of file BM_State.h.

void BM_State::startGenerating ( BM_State::BM_GenerateMode  how = BM_State::BM_INLINE  )  [inline]

Definition at line 158 of file BM_State.h.

virtual void BM_State::status ( UT_String &  s  )  const [inline, virtual]

Reimplemented in MSS_CaptureLayerPaintState.

Definition at line 76 of file BM_State.h.

virtual void BM_State::stopGenerating ( void   )  [inline, virtual]

Reimplemented in BM_SingleOpState, MSS_CenterPivotState, MSS_EditState, MSS_UVCenterPivotState, and MSS_UVEditState.

Definition at line 161 of file BM_State.h.

virtual bool BM_State::wantFailedOrienterEvent (  )  const [inline, virtual]

Definition at line 296 of file BM_State.h.

void BM_State::wantsLocates ( int  yesNo  )  [inline]

Examples:
SOP/MSS_CustomBrushState.C.

Definition at line 200 of file BM_State.h.

Member Data Documentation

BM_StateFlags BM_State::myFlags [protected]

Definition at line 332 of file BM_State.h.

UI_Event BM_State::theDelayedSelectionEvent [static, protected]

Definition at line 335 of file BM_State.h.

bool BM_State::theDelayedSelectionEventIsValid [static, protected]

Definition at line 334 of file BM_State.h.

The documentation for this class was generated from the following file:
Generated on Fri May 25 00:10:16 2012 for HDK by  doxygen 1.5.9