Parent class for SOP custom states. More...

#include <MSS_SingleOpBaseState.h>

Inheritance diagram for MSS_SingleOpBaseState:

Public Member Functions
	MSS_SingleOpBaseState (JEDI_View &view, PI_StateTemplate &templ, BM_SceneManager scene, const char cursor=BM_DEFAULT_CURSOR)

	~MSS_SingleOpBaseState () override

const char *	className () const override

Public Member Functions inherited from BM_SingleOpState
	BM_SingleOpState (BM_OpView &view, PI_StateTemplate &templ, BM_SceneManager scene, const char cursor=BM_DEFAULT_CURSOR)

	~BM_SingleOpState () override

int	enter (BM_SimpleState::BM_EntryType how) override

void	exit () override

void	restart () override

int	generate (BM_SimpleState::BM_EntryType how, const GenerateParms &parms) override

void	stopGenerating () override

int	handleNodeDeleted (OP_Node &node) override

int	hasOpNode (const OP_Node &node) const override

void	handleOpNetClear () override

OP_Node *	getNode () const

int	getToolboxCount () const override

UI_Feel *	getToolbox (int index) const override

void	createOpHandleLink (const char handle_instance_name, const char settings=nullptr, bool load_settings=true)

bool	deleteOpHandleLink (const char *handle_instance_name, bool remove_bindings=false)

Public Member Functions inherited from BM_OpState
	BM_OpState (BM_OpView &view, PI_StateTemplate &templ, BM_SceneManager sceneManager, const char cursor=BM_DEFAULT_CURSOR)

	~BM_OpState () override

int	handleMouseEvent (UI_Event *event) override

int	handleMouseWheelEvent (UI_Event *event) override

void	prepareDialogForDisplay () const override

int	hasDialog () const override

UI_Feel *	dialogFeel () const override

int	findPI (BM_OpHandleLink *pi) const override

virtual bool	updateInvisiblePIHandleForMoveTool (bool(func)(BM_Handle handle, BM_MoveTool::Type tool, unsigned vport_mask), BM_MoveTool::Type tool, unsigned vport_mask, bool make_visible)

fpreal	getTime () const
	Obtains the current global time. More...

bool	getStateParmNames (UT_StringArray &ret, const char *prefix=nullptr) override

bool	evalStateParm (const char *name, UT_StringHolder &ret) override

bool	setStateParm (const char *name, const UT_StringHolder &val) override

bool	pressStateButton (const char *name) override

BM_OpHandleLink *	piByRootDescription (const char *description)

BM_OpHandleLink const *	piByRootDescription (const char *description) const

virtual const char *	getOperatorName () const

Public Member Functions inherited from BM_State
	BM_State (BM_SceneManager &app, PI_StateTemplate &templ, const char cursor=0, const char const vnames=0, UI_EventMethod const vmethods=0)

	~BM_State () override

int	getUniqueId () const

virtual void	status (UT_String &s) const

virtual void	renderStatusExtras (RE_Render *)

int	isHandle () const override

int	enter (BM_SimpleState::BM_EntryType how) override

void	exit () override

virtual void	concealState ()

virtual void	revealState ()

virtual void	handleVolatileChanges ()

virtual void	onVolatileState (BM_SimpleState const *volatile_state, bool overriding_state)

virtual int	preprocessSelect (UI_Event *event)

int	handleMouseEvent (UI_Event *event) override

virtual bool	handleDoubleClickEvent (UI_Event *)

virtual void	handleGeoChangedEvent (UI_Event *)

virtual void	handleDetailLookGeoChanged (BM_DetailLook *look)

void	propagateDetailLookGeoChanged (BM_DetailLook *look)

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

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

void	startGenerating (BM_State::BM_GenerateMode how=BM_State::BM_INLINE, bool requestnew=false, bool exsitu=false)

int	meetsOverlayEntryConditions (const UI_Event &event) const

virtual void	handleOpNodeChange (OP_Node &)

virtual void	handleOpUIChange (OP_Node &)

virtual void	handleOpNetChange (OP_Network &)

void	wantsLocates (int yesNo)

virtual int	hasLocates () const

virtual bool	doesHandleLocates () const

int	isPreempted () const

int	isBuilding () const

int	isEntered () const

bool	isConcealed () const

int	isGenerating () const

int	isGeneratingInline () const

bool	isRequestingNew () const

bool	isGeneratingExSitu () const

int	isRegenerating () const

bool	isOverlay () const override

int	isFullTime () const

int	isModifier () const override

virtual bool	ignoreDisplayFlagChange () const

int	isSticky () const

virtual bool	getAllowIndirectHandleDrag () const

virtual BM_RMBMenuPopupMode	getRMBMenuPopupMode (short altflags) const

const PI_StateTemplate &	getTemplate () const

PI_StateTemplate &	getTemplate ()

virtual int	isOpIndependent () const

virtual bool	canSwitchToOpDependent () const

virtual void	switchToOpDependent ()

const char *	getHotkeyString () const override

const char *	getIconName () const override

const char *	getLabel () const override

const char *	getDescription () const override

virtual void	afterUndo ()

const char *	replaceCursor (const char *newcursor) override

virtual void	getHelp (UT_String &help_text, bool &is_html)

virtual void	getHelpDirAndNameOrUrl (UT_StringHolder &dir, UT_StringHolder &name, UT_StringHolder &url)

virtual bool	showPersistent () const

virtual bool	wantFailedOrienterEvent () const

virtual bool	getShowSelectedOp () const

virtual void	resetStateForNew ()

virtual UI_Feel *	getCustomSelectModeSideBar () const

virtual bool	useSecureSelection () const

virtual bool	useVolatileSelection () const

bool	isBusyProcessing () const

virtual int	testDragDrop (DD_Source &)

virtual void	getDragDropChoice (DD_Source &, DD_ChoiceList &)

virtual int	acceptDragDrop (DD_Source &, const char *)

virtual bool	switchHandleTool (BM_MoveTool::Type tool, bool reveal_updated_handles)

virtual bool	overrideSelectState (UT_StringHolder &new_state)

virtual void	initializeHUDs ()

int	updateHUD (UT_HUDInfoArgs const &args)

void	stealNewStateHUDQueue (UT_Array< HUDInfoArgsCopyUPtr > &&queue)

void	enterHUD ()

void	exitHUD ()

void	renderHUD ()

UT_Array< int > const &	viewportEventIDs () const

UT_Array< int > &	viewportEventIDs ()

Public Member Functions inherited from 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 () override

const UT_String &	name () const

const UT_String &	english () const

UI_Feel *	extraDialogFeel () const

virtual void	initializeUI (PRM_Template *tmpl=0)

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 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	handleKeyEvent (int key, UI_Event *event) final

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

virtual int	getVolatileToolboxCount () const

virtual UI_Feel *	getVolatileToolbox (int index) const

void	setVolatileViewport (BM_Viewport *view)

BM_Viewport *	getVolatileViewport () const

BM_SceneManager &	sceneManager ()

const BM_SceneManager &	sceneManager () const

void	setSavedState (BM_SimpleState *state)

BM_SimpleState *	getSavedState ()

const BM_SimpleState *	getSavedState () const

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

OP_Node *	getChosenOp () const override

void	setNodeFlags (OP_Node &node) override
	Set the flags (display/current) of the given node: More...

void	getKeyResolveInfo (UI_KeyResolveInfo &info) override

int	handleKeyTypeEvent (int key, UI_Event *event, BM_Viewport &) override
	Respond to keyboard events. More...

virtual bool	isSelecting () const

virtual bool	needSelectMask () const

void	mapToWorld (float x, float y, UT_Vector3 &dir, UT_Vector3 &rayorig)
	Map viewport coordinates to worldspace location and direction. More...

void	xformToWorldCoord (UT_Vector3 &p)
	Transform a point from object to world space or world to object space. More...

void	xformToObjectCoord (UT_Vector3 &p)

void	xformToWorldVector (UT_Vector3 &v)
	Transform a vector from object to world space or world to object space. More...

void	xformToObjectVector (UT_Vector3 &v)

void	getViewportTransform (UT_Matrix4 &xform)
	Get worldspace to cameraspace transform. More...

void	getViewportItransform (UT_Matrix4 &xform)
	Get cameraspace to worldspace transform. More...

void	getViewportProjectionTransform (UT_Matrix4 &xform) const
	Get the projection transform. More...

bool	getViewportProjection (fpreal &focal_length, fpreal &horizontal_aperture, bool &is_ortho, fpreal &ortho_width, fpreal &aspect_ratio, fpreal &near_plane, fpreal &far_plane) const
	Get the projection parameters. More...

float	getViewportLOD () const
	Get level of detail for the viewport. More...

void	showPrompt (const char *msg)
	Set the status bar text. More...

JEDI_View &	viewer ()

const JEDI_View &	viewer () const

DM_Workbench &	workbench ()

const DM_Workbench &	workbench () const

void	interrupt (BM_SimpleState *state=0) override

void	resume (BM_SimpleState *state=0) override

Protected Member Functions inherited from BM_SingleOpState
void	makePIVisible (int pi_idx, int onoff) override

virtual void	doGenerate ()

OP_Node *	createNode (const char optype=0, const char nettype=0, OP_Network *parent=0, int explicitly=1)

virtual const char *	getCreateNodeName () const

virtual void	setNode (OP_Node *node)

void	setNodeId (int id)

virtual void	clearChosenNodeFlags ()

void	refreshBindings (int id, const char *op_type) override

void	refreshSettings (int id, const char *op_type) override

OP_Node *	savedNode () const

void	savedNode (OP_Node *n)

virtual void	initializeDialogs ()

virtual void	completeDialogs ()

int	matchesNode (OP_Node &node) const override

void	removeAllDialogs () override

void	handleDialogDeleted (OPUI_Dialog *dialog) override

virtual void	addAnyReselectionUndos ()

virtual bool	disconnectInputsOnRestart () const

void	clearOpHandleLinks ()

virtual bool	allowOpMaxExportToDialog () const

virtual bool	canCreateSelector () const

void	deleteOpHandleLinks ()

Protected Member Functions inherited from BM_OpState
BM_OpView &	baseViewer ()

const BM_OpView &	baseViewer () const

bool	handleTransitoryKey (const UI_Event &event, int hotkey_id) override

int	createPI (const char pi_name, int opnum=-1, const char description=0)

virtual void	onCreatePI (PI_OpHandleLink *pi)

virtual void	onAppendPI (PI_OpHandleLink *pi)

virtual void	onRemovePI (PI_OpHandleLink *pi)

int	appendPI (BM_OpHandleLink *pi, int opnum=-1)

virtual void	removePI (int pi_idx)

void	removeAllLinkedPIs ()

void	removeLinkedPIByDescription (const char *descr_name)

BM_OpHandleLink *	pi (int index)

const BM_OpHandleLink *	pi (int index) const

BM_OpHandleLink *	pi (const char *name)

const BM_OpHandleLink *	pi (const char *name) const

const char *	piDescription (int index) const

int	piOpnum (int index) const

int	numPIs () const

int	appendFolder (const char *folder_name)

void	appendFeelToFolder (const char folder_name, UI_Feel child_feel)

int	appendDialogToFolder (const char *folder_name, BM_ParmState &state_or_handle)

int	appendDialogToFolder (const char *folder_name, OP_Node &op_node, PRM_Template::PRM_Export export_level)

int	appendThisStateDialogToFolder (const char *folder_name)

int	appendDividerToFolder (const char *folder_name)

int	appendTextToFolder (const char folder_name, const char text, UI_LookType look_type=UI_LOOK_HEADING_TEXT)

int	removeDialog (BM_ParmState &state)

int	removeDialog (OP_Node &op_node, PRM_Template::PRM_Export export_level)

int	removeFolder (const char *name, bool only_if_empty=false)

int	appendDialogToFolder (const char folder_name, BM_ParmState &state_or_handle, BM_Handle handle)

int	appendDividerToFolder (const char folder_name, BM_Handle handle)

int	appendTextToFolder (const char folder_name, const char text, UI_LookType look_type, BM_Handle *handle)

int	removeCachedUIItems (const char folder_name, BM_Handle handle)

void	switchToFolder (const char *name)

void	handlePIVisibilityChange (UI_Event *event)

void	connectNode (OP_Node &newnode, OP_Node &inputnode, int input_idx=0, int branch_off=0)

void	stampNode (OP_Node &newnode)

Protected Member Functions inherited from BM_State
virtual void	doRender (RE_Render *r, int x, int y, int ghost)

virtual void	doRenderSaved (RE_Render *r, int x, int y, int ghost)

void	setModifier (int yn)

int	meetsBasicOverlayEntryConditions (const UI_Event &e) const

virtual void	setBuild (int onOff)

void	handleMouseEventVoidRet (UI_Event *event)

void	renderSaved (RE_Render *r, int x, int y, int ghost)

Protected Member Functions inherited from BM_ParmState
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)

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 ()

Additional Inherited Members
Public Types inherited from BM_State
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 }

using	HUDInfoArgsCopyUPtr = UT_UniquePtr< BM_HUDInfoArgsCopy >

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

Static Public Member Functions inherited from BM_OpState
static int	getAutoHighlightFlag ()

static void	setAutoHighlightFlag (int o)

Static Public Member Functions inherited from BM_State
static UT_Options &	getGlobalPrefs ()

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 BM_SingleOpState
int	myOpNodeId

OP_Node *	mySavedOpNode

OPUI_Dialog *	myOpToolbox

UT_SymbolMap< int >	myHandleTable

UT_BitArray	myHandleVisibility

UT_String	myRestartInfoFile

UT_IntArray	myRestartOpInputs

UT_StringArray	myRestartOpIndirectInputs

int	myRestartOpId

Protected Attributes inherited from BM_OpState
BM_OpView &	myViewer

UT_ValArray< opbm_DialogInfo * >	myDialogs

UT_ValArray< opbm_PIContext * >	myPIs

UT_ValArray< UI_Feel * >	myMiscFeels

SI_Folders *	myFolders

Protected Attributes inherited from BM_State
BM_StateFlags	myFlags

Protected Attributes inherited from AP_Interface
UT_String	myName

const char const	myValueNames

UI_EventMethod const *	myMethods

Static Protected Attributes inherited from BM_OpState
static const char *	STATE_DIALOG_FOLDER

static const char *	HANDLES_FOLDER

static const char *	OP_DIALOG_FOLDER

static int	theAutoHighlightFlag

Static Protected Attributes inherited from BM_State
static bool	theDelayedSelectionEventIsValid

static UI_Event	theDelayedSelectionEvent

Detailed Description

Parent class for SOP custom states.

Definition at line 24 of file MSS_SingleOpBaseState.h.

Constructor & Destructor Documentation

MSS_SingleOpBaseState::MSS_SingleOpBaseState	(	JEDI_View &	view,
		PI_StateTemplate &	templ,
		BM_SceneManager *	scene,
		const char *	cursor = `BM_DEFAULT_CURSOR`
	)

MSS_SingleOpBaseState::~MSS_SingleOpBaseState ( )

override

Member Function Documentation

const char* MSS_SingleOpBaseState::className ( ) const

overridevirtual

Reimplemented from BM_SingleOpState.

Reimplemented in MSS_SingleOpState, HDK_Sample::MSS_CustomBrushState, and HDK_Sample::MSS_BrushHairLen.

OP_Node* MSS_SingleOpBaseState::getChosenOp ( ) const

overrideprotectedvirtual

Provide the node to work with. The criteria for which node to use will be specific to each network type. This method does NOT overwrite the myOpNode pointer.

Implements BM_SingleOpState.

void MSS_SingleOpBaseState::getKeyResolveInfo ( UI_KeyResolveInfo & info )

overrideprotectedvirtual

Reimplemented from BM_OpState.

Reimplemented in MSS_SingleOpState.

const char* MSS_SingleOpBaseState::getPresetTypeName ( ) const

inlineoverrideprotectedvirtual

Implements BM_ParmState.

Definition at line 35 of file MSS_SingleOpBaseState.h.

void MSS_SingleOpBaseState::getViewportItransform ( UT_Matrix4 & xform )

protected

Get cameraspace to worldspace transform.

Examples:: SOP/MSS_CustomBrushState.C.

float MSS_SingleOpBaseState::getViewportLOD ( ) const

protected

Get level of detail for the viewport.

bool MSS_SingleOpBaseState::getViewportProjection	(	fpreal &	focal_length,
		fpreal &	horizontal_aperture,
		bool &	is_ortho,
		fpreal &	ortho_width,
		fpreal &	aspect_ratio,
		fpreal &	near_plane,
		fpreal &	far_plane
	)		const

protected

Get the projection parameters.

See Also: UT_Matrix4::perspective()

void MSS_SingleOpBaseState::getViewportProjectionTransform ( UT_Matrix4 & xform ) const

protected

Get the projection transform.

void MSS_SingleOpBaseState::getViewportTransform ( UT_Matrix4 & xform )

protected

Get worldspace to cameraspace transform.

int MSS_SingleOpBaseState::handleKeyTypeEvent	(	int	key,
		UI_Event *	event,
		BM_Viewport &
	)

overrideprotectedvirtual

Respond to keyboard events.

Reimplemented from BM_OpState.

Reimplemented in MSS_SingleOpState, and HDK_Sample::MSS_BrushHairLen.

void MSS_SingleOpBaseState::interrupt ( BM_SimpleState * state = 0 )

overrideprotectedvirtual

Reimplemented from BM_OpState.

Reimplemented in MSS_SingleOpState, and HDK_Sample::MSS_CustomBrushState.

virtual bool MSS_SingleOpBaseState::isSelecting ( ) const

protectedvirtual

Reimplemented in MSS_SingleOpState.

void MSS_SingleOpBaseState::mapToWorld	(	float	x,
		float	y,
		UT_Vector3 &	dir,
		UT_Vector3 &	rayorig
	)

protected

Map viewport coordinates to worldspace location and direction.

Examples:: SOP/MSS_CustomBrushState.C.

virtual bool MSS_SingleOpBaseState::needSelectMask ( ) const

inlineprotectedvirtual

Definition at line 54 of file MSS_SingleOpBaseState.h.

void MSS_SingleOpBaseState::resume ( BM_SimpleState * state = 0 )

overrideprotectedvirtual

Reimplemented from BM_OpState.

Reimplemented in MSS_SingleOpState, and HDK_Sample::MSS_CustomBrushState.

void MSS_SingleOpBaseState::setNodeFlags ( OP_Node & node )

overrideprotectedvirtual

Set the flags (display/current) of the given node:

Reimplemented from BM_SingleOpState.

void MSS_SingleOpBaseState::showPrompt ( const char * msg )

protected

Set the status bar text.

Examples:: SOP/MSS_CustomBrushState.C.

JEDI_View& MSS_SingleOpBaseState::viewer ( )

inlineprotected

Definition at line 94 of file MSS_SingleOpBaseState.h.

const JEDI_View& MSS_SingleOpBaseState::viewer ( ) const

inlineprotected

Definition at line 95 of file MSS_SingleOpBaseState.h.

DM_Workbench& MSS_SingleOpBaseState::workbench ( )

inlineprotected

Definition at line 97 of file MSS_SingleOpBaseState.h.

const DM_Workbench& MSS_SingleOpBaseState::workbench ( ) const

inlineprotected

Definition at line 99 of file MSS_SingleOpBaseState.h.

void MSS_SingleOpBaseState::xformToObjectCoord ( UT_Vector3 & p )

protected

Examples:: SOP/MSS_CustomBrushState.C.

void MSS_SingleOpBaseState::xformToObjectVector ( UT_Vector3 & v )

protected

Examples:: SOP/MSS_CustomBrushState.C.

void MSS_SingleOpBaseState::xformToWorldCoord ( UT_Vector3 & p )

protected

Transform a point from object to world space or world to object space.

void MSS_SingleOpBaseState::xformToWorldVector ( UT_Vector3 & v )

protected

Transform a vector from object to world space or world to object space.

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

MSS/MSS_SingleOpBaseState.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation