#include <BM_ParmState.h>

Inheritance diagram for BM_ParmState:

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)

	~BM_ParmState () override

const UT_String &	name () const

const UT_String &	english () const

const char *	className () const override

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 const char *	getIconName () const

virtual const char *	getLabel () const

virtual const char *	getDescription () const

virtual const char *	getHotkeyString () const

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	enter (BM_EntryType how=BM_SimpleState::BM_OVERLAY_ENTRY)=0

virtual void	exit ()=0

virtual void	interrupt (BM_SimpleState *=0)

virtual void	resume (BM_SimpleState *=0)

virtual int	handleMouseEvent (UI_Event *event)=0

virtual int	handleKeyEvent (int key, UI_Event *event) final

virtual void	render (RE_Render *r, int x, int y)

virtual void	overlayRender (RE_Render *r, int x, int y)

virtual bool	isOverlay () const

virtual int	getVolatileToolboxCount () const

virtual UI_Feel *	getVolatileToolbox (int index) const

const char *	className () const override

virtual int	isHandle () const =0

void	setVolatileViewport (BM_Viewport *view)

BM_Viewport *	getVolatileViewport () const

virtual int	isModifier () const

BM_SceneManager &	sceneManager ()

const BM_SceneManager &	sceneManager () 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

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_String &	getName () 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_Value *	findValueSymbol (const char *symbol) const
	Find the UI_Value for the given named value symbol. More...

UI_Value *	getValueSymbol (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_Object *	getObjectSymbol (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 >
T *	findObject (const char *name) const

template<typename T >
T *	findValue (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_Object &	operator= (const UI_Object &)=delete

virtual int	interestingEvent (UI_EventType t, UI_DeviceEvent *event) const

virtual void	deleteReferences (UI_Object *to_whom)

UI_Object *	getParent () 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_ObjectList &	dependents () 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_ValueList &	valueInterests () const

void	interestedInValue (UI_Value *)

void	removeValueInterest (UI_Value *)

void	addKeyDelegateClientship (UI_KeyDelegate *)

void	removeKeyDelegateClientship (UI_KeyDelegate *)

Protected Member Functions
virtual const char *	getPresetTypeName () const =0

void	initApplication (UI_Manager , int, const char *) override

const PRM_Parm *	parameter (const char *name) const

PRM_Parm *	parameter (const char *name)

PRM_ParmList *	parameters () const

UI_Value *	parmValue () const

const PRM_Parm *	parameter (int index) const

PRM_Parm *	parameter (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_NamedValueMap *	getValueTable () const

UI_NamedObjectMap *	getObjectTable () const

void	processKeyBindingProxyRequests ()

Protected Member Functions inherited from UI_Object
UI_ObjectList &	dependents ()

virtual void	preTerminateCallback ()

Friends
class	BM_ParmStateUndo

Additional Inherited Members
Public Types inherited from BM_SimpleState
enum	BM_EntryType { BM_FULLTIME_ENTRY = 0x01, BM_OVERLAY_ENTRY = 0x02 }

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_Manager *	getManager ()

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)

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_Interface *	getMainApplication ()

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)

Protected Attributes inherited from AP_Interface
UT_String	myName

const char const	myValueNames

UI_EventMethod const *	myMethods

Detailed Description

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

BM_ParmState::~BM_ParmState ( )

override

Member Function Documentation

const char* BM_ParmState::className ( ) const

overridevirtual

Reimplemented from UI_Object.

Reimplemented in BM_State, BM_SingleOpState, MSS_SingleOpState, HDK_Sample::MSS_CustomBrushState, MSS_BrushBaseState, HDK_Sample::MSS_BrushHairLen, and MSS_SingleOpBaseState.

virtual UI_Feel* BM_ParmState::dialogFeel ( ) const

virtual

Reimplemented in BM_OpState.

virtual int BM_ParmState::disableParms ( )

protectedvirtual

int BM_ParmState::enableParm	(	const char *	name,
		int	onoff,
		int	refresh = `1`
	)

protected

int BM_ParmState::enableParm	(	int	index,
		int	onoff,
		int	refresh = `1`
	)

protected

const UT_String& BM_ParmState::english ( ) const

inline

Definition at line 48 of file BM_ParmState.h.

virtual bool BM_ParmState::evalStateParm	(	const char *	name,
		UT_StringHolder &	ret
	)

virtual

Reimplemented in BM_OpState.

UI_Feel* BM_ParmState::extraDialogFeel ( ) const

void BM_ParmState::getParm	(	const char *	name,
		UT_String &	value,
		fpreal	t = `0`
	)		const

protected

void BM_ParmState::getParm	(	const char *	name,
		int &	value,
		fpreal	t = `0`
	)		const

protected

void BM_ParmState::getParm	(	const char *	name,
		bool &	value,
		fpreal	t = `0`
	)		const

inlineprotected

Definition at line 132 of file BM_ParmState.h.

void BM_ParmState::getParm	(	const char *	name,
		fpreal &	value,
		fpreal	t = `0`
	)		const

protected

void BM_ParmState::getParm	(	int	index,
		UT_String &	value,
		fpreal	t = `0`
	)		const

protected

void BM_ParmState::getParm	(	int	index,
		int &	value,
		fpreal	t = `0`
	)		const

protected

void BM_ParmState::getParm	(	int	index,
		bool &	value,
		fpreal	t = `0`
	)		const

inlineprotected

Definition at line 150 of file BM_ParmState.h.

void BM_ParmState::getParm	(	int	index,
		fpreal &	value,
		fpreal	t = `0`
	)		const

protected

PSI2_DialogPRM* BM_ParmState::getParmDialog ( )

protected

virtual const char* BM_ParmState::getPresetTypeName ( ) const

protectedpure virtual

Implemented in MSS_SingleOpBaseState.

int BM_ParmState::getSaveParmForUndoFlag ( )

inlineprotected

Definition at line 209 of file BM_ParmState.h.

virtual bool BM_ParmState::getStateParmNames	(	UT_StringArray &	ret,
		const char *	prefix = `nullptr`
	)

virtual

Reimplemented in BM_OpState.

UI_Feel* BM_ParmState::getToolbox ( int index ) const

overridevirtual

Reimplemented from BM_SimpleState.

Reimplemented in MSS_SingleOpState, and BM_SingleOpState.

int BM_ParmState::getToolboxCount ( ) const

overridevirtual

Reimplemented from BM_SimpleState.

Reimplemented in MSS_SingleOpState, and BM_SingleOpState.

void BM_ParmState::getXYParm	(	const char *	name,
		fpreal &	x,
		fpreal &	y,
		fpreal	t = `0`
	)		const

protected

void BM_ParmState::getXYParm	(	const char *	name,
		int &	x,
		int &	y,
		fpreal	t = `0`
	)		const

protected

void BM_ParmState::getXYParm	(	int	index,
		fpreal &	x,
		fpreal &	y,
		fpreal	t = `0`
	)		const

protected

void BM_ParmState::getXYParm	(	int	index,
		int &	x,
		int &	y,
		fpreal	t = `0`
	)		const

protected

void BM_ParmState::getXYZParm	(	const char *	n,
		fpreal &	x,
		fpreal &	y,
		fpreal &	z,
		fpreal	t = `0`
	)		const

protected

void BM_ParmState::getXYZParm	(	int	index,
		fpreal &	x,
		fpreal &	y,
		fpreal &	z,
		fpreal	t = `0`
	)		const

protected

int BM_ParmState::handleParameterEvent ( UI_Event * event )

overrideprotectedvirtual

Reimplemented from BM_SimpleState.

Reimplemented in MSS_BrushBaseState.

virtual int BM_ParmState::handleParameterUndo ( int parm_index )

protectedvirtual

virtual int BM_ParmState::handleSaveParmForUndo ( int index )

protectedvirtual

virtual int BM_ParmState::hasDialog ( ) const

virtual

Reimplemented in BM_OpState.

void BM_ParmState::initApplication	(	UI_Manager *	uims,
		int	argc,
		const char **	argv
	)

overrideprotectedvirtual

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 MSS_SingleOpState.

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

virtual

const UT_String& BM_ParmState::name ( ) const

inline

Definition at line 47 of file BM_ParmState.h.

void BM_ParmState::overwriteParmDefault	(	const char *	name,
		fpreal	t = `0`
	)

protected

void BM_ParmState::overwriteParmDefault	(	int	index,
		fpreal	t = `0`
	)

protected

void BM_ParmState::overwriteParmDefaults ( )

protected

void BM_ParmState::overwriteXYParmDefault	(	const char *	name,
		fpreal	t = `0`
	)

protected

void BM_ParmState::overwriteXYParmDefault	(	int	index,
		fpreal	t = `0`
	)

protected

void BM_ParmState::overwriteXYZParmDefault	(	const char *	name,
		fpreal	t = `0`
	)

protected

void BM_ParmState::overwriteXYZParmDefault	(	int	index,
		fpreal	t = `0`
	)

protected

const PRM_Parm* BM_ParmState::parameter ( const char * name ) const

protected

PRM_Parm* BM_ParmState::parameter ( const char * name )

protected

const PRM_Parm* BM_ParmState::parameter ( int index ) const

protected

PRM_Parm* BM_ParmState::parameter ( int index )

protected

PRM_ParmList* BM_ParmState::parameters ( ) const

inlineprotected

Definition at line 92 of file BM_ParmState.h.

bool BM_ParmState::parmExists ( const char * name ) const

protected

bool BM_ParmState::parmExists ( int index ) const

protected

UI_Value* BM_ParmState::parmValue ( ) const

inlineprotected

Definition at line 93 of file BM_ParmState.h.

virtual void BM_ParmState::prepareDialogForDisplay ( ) const

virtual

Reimplemented in BM_OpState.

virtual bool BM_ParmState::pressStateButton ( const char * name )

virtual

Reimplemented in BM_OpState.

void BM_ParmState::refreshParm ( int index )

protected

void BM_ParmState::refreshParms ( )

bool BM_ParmState::saveParmForUndo	(	int	index,
		bool	force = `false`
	)

protected

void BM_ParmState::setParm	(	const char *	name,
		const UT_String &	value,
		CH_StringMeaning	meaning,
		fpreal	t = `0`,
		int	refresh = `1`
	)

protected

void BM_ParmState::setParm	(	const char *	name,
		int	value,
		fpreal	t = `0`,
		int	refresh = `1`
	)

protected

void BM_ParmState::setParm	(	const char *	name,
		fpreal	value,
		fpreal	t = `0`,
		int	refresh = `1`
	)

protected

void BM_ParmState::setParm	(	int	index,
		const UT_String &	v,
		CH_StringMeaning	meaning,
		fpreal	t = `0`,
		int	refresh = `1`
	)

protected

void BM_ParmState::setParm	(	int	index,
		int	value,
		fpreal	t = `0`,
		int	refresh = `1`
	)

protected

void BM_ParmState::setParm	(	int	index,
		fpreal	value,
		fpreal	t = `0`,
		int	refresh = `1`
	)

protected

void BM_ParmState::setSaveParmForUndoFlag ( int onoff )

inlineprotected

Definition at line 211 of file BM_ParmState.h.

virtual bool BM_ParmState::setStateParm	(	const char *	name,
		const UT_StringHolder &	val
	)

virtual

Reimplemented in BM_OpState.

bool BM_ParmState::setVisibleState	(	int	pi,
		bool	state,
		bool	refresh = `true`
	)

protected

bool BM_ParmState::setVisibleState	(	const char *	pn,
		bool	state,
		bool	refresh = `true`
	)

protected

void BM_ParmState::setXYParm	(	const char *	name,
		fpreal	x,
		fpreal	y,
		fpreal	t = `0`,
		int	refresh = `1`
	)

protected

void BM_ParmState::setXYParm	(	int	index,
		fpreal	x,
		fpreal	y,
		fpreal	t = `0`,
		int	refresh = `1`
	)

protected

void BM_ParmState::setXYZParm	(	const char *	name,
		fpreal	x,
		fpreal	y,
		fpreal	z,
		fpreal	t = `0`,
		int	refresh = `1`
	)

protected

void BM_ParmState::setXYZParm	(	int	index,
		fpreal	x,
		fpreal	y,
		fpreal	z,
		fpreal	t = `0`,
		int	refresh = `1`
	)

protected

Friends And Related Function Documentation

friend class BM_ParmStateUndo

friend

Definition at line 35 of file BM_ParmState.h.

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

BM/BM_ParmState.h

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation