BM_ParmState Class Reference

#include <BM_ParmState.h>

Inheritance diagram for BM_ParmState:

BM_SimpleState AP_Interface UI_Object 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 Member Functions

 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)
virtual ~BM_ParmState ()
const UT_String & name (void) const
const UT_String & english (void) const
virtual const char * className () const
virtual void prepareDialogForDisplay () const
virtual int hasDialog (void) const
virtual UI_Feel * dialogFeel (void) const
virtual int getToolboxCount () const
virtual UI_Feel * getToolbox (int index) const
UI_Feel * extraDialogFeel () const
virtual void initializeUI (PRM_Template *tmpl=0)

Protected Member Functions

virtual void initApplication (UI_Manager *, int c, const char **v)
PRM_ParmList * parameters (void) const
UI_Value * parmValue (void) const
PRM_Parm * parameter (const char *name)
PRM_Parm * parameter (int index)
void setParm (const char *name, const UT_String &value, CH_StringMeaning meaning, float t=0, int refresh=1)
void setParm (const char *name, int value, float t=0, int refresh=1)
void setParm (const char *name, fpreal32 value, float t=0, int refresh=1)
void setParm (const char *name, fpreal64 value, float t=0, int refresh=1)
void setXYParm (const char *name, float x, float y, float t=0, int refresh=1)
void setXYZParm (const char *name, float x, float y, float z, float t=0, int refresh=1)
void setParm (int index, const UT_String &v, CH_StringMeaning meaning, float t=0, int refresh=1)
void setParm (int index, int value, float t=0, int refresh=1)
void setParm (int index, fpreal32 value, float t=0, int refresh=1)
void setParm (int index, fpreal64 value, float t=0, int refresh=1)
void setXYParm (int index, float x, float y, float t=0, int refresh=1)
void setXYZParm (int index, float x, float y, float z, float t=0, int refresh=1)
bool parmExists (const char *name) const
bool parmExists (int index) const
void getParm (const char *name, UT_String &value, float t=0) const
void getParm (const char *name, int &value, float t=0) const
void getParm (const char *name, fpreal32 &value, float t=0) const
void getParm (const char *name, fpreal64 &value, float t=0) const
void getXYParm (const char *name, float &x, float &y, float t=0) const
void getXYParm (const char *name, int &x, int &y, float t=0) const
void getXYZParm (const char *n, float &x, float &y, float &z, float t=0) const
void getParm (int index, UT_String &value, float t=0) const
void getParm (int index, int &value, float t=0) const
void getParm (int index, fpreal32 &value, float t=0) const
void getParm (int index, fpreal64 &value, float t=0) const
void getXYParm (int index, float &x, float &y, float t=0) const
void getXYParm (int index, int &x, int &y, float t=0) const
void getXYZParm (int index, float &x, float &y, float &z, float t=0) const
void overwriteParmDefault (const char *name, float t=0)
void overwriteXYParmDefault (const char *name, float t=0)
void overwriteXYZParmDefault (const char *name, float t=0)
void overwriteParmDefault (int index, float t=0)
void overwriteXYParmDefault (int index, float t=0)
void overwriteXYZParmDefault (int index, float t=0)
void overwriteParmDefaults ()
virtual int disableParms (void)
int enableParm (const char *name, int onoff, int refresh=1)
int enableParm (int index, int onoff, int refresh=1)
void refreshParms (void)
void refreshParm (int index)
virtual int handleParameterEvent (UI_Event *event)
bool saveParmForUndo (int index, bool force=false)
virtual int handleSaveParmForUndo (int index)
virtual int handleParameterUndo (int parm_index)
int getSaveParmForUndoFlag ()
void setSaveParmForUndoFlag (int onoff)

Friends

class BM_ParmStateUndo

Detailed Description

Definition at line 38 of file BM_ParmState.h.

Constructor & Destructor Documentation

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 
)

virtual BM_ParmState::~BM_ParmState (  )  [virtual]

Member Function Documentation

virtual const char* BM_ParmState::className (  )  const [virtual]

Reimplemented from BM_SimpleState.

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

virtual UI_Feel* BM_ParmState::dialogFeel ( void   )  const [virtual]

Reimplemented in BM_OpState.

virtual int BM_ParmState::disableParms ( void   )  [protected, virtual]

int BM_ParmState::enableParm ( int  index,
int  onoff,
int  refresh = 1 
) [protected]

int BM_ParmState::enableParm ( const char *  name,
int  onoff,
int  refresh = 1 
) [protected]

const UT_String& BM_ParmState::english ( void   )  const [inline]

Definition at line 56 of file BM_ParmState.h.

UI_Feel* BM_ParmState::extraDialogFeel (  )  const

void BM_ParmState::getParm ( int  index,
fpreal64 &  value,
float  t = 0 
) const [protected]

void BM_ParmState::getParm ( int  index,
fpreal32 &  value,
float  t = 0 
) const [protected]

void BM_ParmState::getParm ( int  index,
int &  value,
float  t = 0 
) const [protected]

void BM_ParmState::getParm ( int  index,
UT_String &  value,
float  t = 0 
) const [protected]

void BM_ParmState::getParm ( const char *  name,
fpreal64 &  value,
float  t = 0 
) const [protected]

void BM_ParmState::getParm ( const char *  name,
fpreal32 &  value,
float  t = 0 
) const [protected]

void BM_ParmState::getParm ( const char *  name,
int &  value,
float  t = 0 
) const [protected]

void BM_ParmState::getParm ( const char *  name,
UT_String &  value,
float  t = 0 
) const [protected]

int BM_ParmState::getSaveParmForUndoFlag (  )  [inline, protected]

Definition at line 186 of file BM_ParmState.h.

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

Reimplemented from BM_SimpleState.

Reimplemented in BM_SingleOpState, and MSS_SingleOpState.

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

Reimplemented from BM_SimpleState.

Reimplemented in BM_SingleOpState, MSS_KnifeState, MSS_PolySplitState, and MSS_SingleOpState.

void BM_ParmState::getXYParm ( int  index,
int &  x,
int &  y,
float  t = 0 
) const [protected]

void BM_ParmState::getXYParm ( int  index,
float &  x,
float &  y,
float  t = 0 
) const [protected]

void BM_ParmState::getXYParm ( const char *  name,
int &  x,
int &  y,
float  t = 0 
) const [protected]

void BM_ParmState::getXYParm ( const char *  name,
float &  x,
float &  y,
float  t = 0 
) const [protected]

void BM_ParmState::getXYZParm ( int  index,
float &  x,
float &  y,
float &  z,
float  t = 0 
) const [protected]

void BM_ParmState::getXYZParm ( const char *  n,
float &  x,
float &  y,
float &  z,
float  t = 0 
) const [protected]

virtual int BM_ParmState::handleParameterEvent ( UI_Event *  event  )  [protected, virtual]

Reimplemented from BM_SimpleState.

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

virtual int BM_ParmState::handleParameterUndo ( int  parm_index  )  [protected, virtual]

virtual int BM_ParmState::handleSaveParmForUndo ( int  index  )  [protected, virtual]

virtual int BM_ParmState::hasDialog ( void   )  const [virtual]

Reimplemented in BM_OpState.

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

Reimplemented from BM_SimpleState.

virtual void BM_ParmState::initializeUI ( PRM_Template *  tmpl = 0  )  [virtual]

Reimplemented in MSS_PolyKnitState, and MSS_PolySplitState.

const UT_String& BM_ParmState::name ( void   )  const [inline]

Definition at line 55 of file BM_ParmState.h.

void BM_ParmState::overwriteParmDefault ( int  index,
float  t = 0 
) [protected]

void BM_ParmState::overwriteParmDefault ( const char *  name,
float  t = 0 
) [protected]

void BM_ParmState::overwriteParmDefaults (  )  [protected]

void BM_ParmState::overwriteXYParmDefault ( int  index,
float  t = 0 
) [protected]

void BM_ParmState::overwriteXYParmDefault ( const char *  name,
float  t = 0 
) [protected]

void BM_ParmState::overwriteXYZParmDefault ( int  index,
float  t = 0 
) [protected]

void BM_ParmState::overwriteXYZParmDefault ( const char *  name,
float  t = 0 
) [protected]

PRM_Parm* BM_ParmState::parameter ( int  index  )  [protected]

PRM_Parm* BM_ParmState::parameter ( const char *  name  )  [protected]

PRM_ParmList* BM_ParmState::parameters ( void   )  const [inline, protected]

Definition at line 83 of file BM_ParmState.h.

bool BM_ParmState::parmExists ( int  index  )  const [protected]

bool BM_ParmState::parmExists ( const char *  name  )  const [protected]

UI_Value* BM_ParmState::parmValue ( void   )  const [inline, protected]

Definition at line 84 of file BM_ParmState.h.

virtual void BM_ParmState::prepareDialogForDisplay (  )  const [virtual]

Reimplemented in BM_OpState.

void BM_ParmState::refreshParm ( int  index  )  [protected]

void BM_ParmState::refreshParms ( void   )  [protected]

bool BM_ParmState::saveParmForUndo ( int  index,
bool  force = false 
) [protected]

void BM_ParmState::setParm ( int  index,
fpreal64  value,
float  t = 0,
int  refresh = 1 
) [protected]

void BM_ParmState::setParm ( int  index,
fpreal32  value,
float  t = 0,
int  refresh = 1 
) [protected]

void BM_ParmState::setParm ( int  index,
int  value,
float  t = 0,
int  refresh = 1 
) [protected]

void BM_ParmState::setParm ( int  index,
const UT_String &  v,
CH_StringMeaning  meaning,
float  t = 0,
int  refresh = 1 
) [protected]

void BM_ParmState::setParm ( const char *  name,
fpreal64  value,
float  t = 0,
int  refresh = 1 
) [protected]

void BM_ParmState::setParm ( const char *  name,
fpreal32  value,
float  t = 0,
int  refresh = 1 
) [protected]

void BM_ParmState::setParm ( const char *  name,
int  value,
float  t = 0,
int  refresh = 1 
) [protected]

void BM_ParmState::setParm ( const char *  name,
const UT_String &  value,
CH_StringMeaning  meaning,
float  t = 0,
int  refresh = 1 
) [protected]

void BM_ParmState::setSaveParmForUndoFlag ( int  onoff  )  [inline, protected]

Definition at line 188 of file BM_ParmState.h.

void BM_ParmState::setXYParm ( int  index,
float  x,
float  y,
float  t = 0,
int  refresh = 1 
) [protected]

void BM_ParmState::setXYParm ( const char *  name,
float  x,
float  y,
float  t = 0,
int  refresh = 1 
) [protected]

void BM_ParmState::setXYZParm ( int  index,
float  x,
float  y,
float  z,
float  t = 0,
int  refresh = 1 
) [protected]

void BM_ParmState::setXYZParm ( const char *  name,
float  x,
float  y,
float  z,
float  t = 0,
int  refresh = 1 
) [protected]

Friends And Related Function Documentation

friend class BM_ParmStateUndo [friend]

Definition at line 43 of file BM_ParmState.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