BM_OpState Class Reference

#include <BM_OpState.h>

Inheritance diagram for BM_OpState:

List of all members.

Public Member Functions
	BM_OpState (BM_OpView &view, PI_StateTemplate &templ, BM_SceneManager *sceneManager, const char *cursor=BM_DEFAULT_CURSOR)
virtual	~BM_OpState (void)
virtual int	handleMouseEvent (UI_Event *event)
virtual const char *	className () const
virtual void	prepareDialogForDisplay () const
virtual int	hasDialog () const
virtual UI_Feel *	dialogFeel () const
virtual int	findPI (BM_OpHandleLink *pi) const
float	getTime () const
	Obtains the current global time.
Static Public Member Functions
static int	getAutoHighlightFlag ()
static void	setAutoHighlightFlag (int o)
Protected Member Functions
BM_OpView &	baseViewer ()
const BM_OpView &	baseViewer () const
virtual void	interrupt (BM_SimpleState *=0)
virtual void	resume (BM_SimpleState *=0)
virtual int	handleKeyTypeEvent (UI_Event *event, BM_Viewport &viewport)
int	createPI (const char *pi_name, int opnum=-1, const char *description=0)
int	appendPI (BM_OpHandleLink *pi, int opnum=-1)
virtual void	removePI (int pi_idx)
void	removeAllLinkedPIs ()
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
virtual void	makePIVisible (int pi_idx, int onoff)
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)
void	switchToFolder (const char *name)
virtual void	handleDialogDeleted (OPUI_Dialog *deleted_dialog)
virtual void	removeAllDialogs ()
void	handlePIButtonChange (UI_Event *event)
void	connectNode (OP_Node &newnode, OP_Node &inputnode, int input_idx=0, int branch_off=0)
void	stampNode (OP_Node &newnode)
virtual int	matchesNode (OP_Node &node) const =0
Protected Attributes
BM_OpView &	myViewer
UT_PtrArray< opbm_DialogInfo * >	myDialogs
UT_PtrArray< opbm_PIContext * >	myPIs
UT_PtrArray< UI_Feel * >	myMiscFeels
SI_Folders *	myFolders
Static Protected Attributes
static const char *	STATE_DIALOG_FOLDER
static const char *	HANDLES_FOLDER
static const char *	OP_DIALOG_FOLDER
static int	theAutoHighlightFlag

---

Detailed Description

Definition at line 44 of file BM_OpState.h.

---

Constructor & Destructor Documentation

BM_OpState::BM_OpState	(	BM_OpView &	view,
		PI_StateTemplate &	templ,
		BM_SceneManager *	sceneManager,
		const char *	cursor = BM_DEFAULT_CURSOR
	)

virtual BM_OpState::~BM_OpState

(

void

)

[virtual]

---

Member Function Documentation

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

int BM_OpState::appendDialogToFolder	(	const char *	folder_name,
		BM_ParmState &	state_or_handle
	)			[protected]

int BM_OpState::appendDividerToFolder

(

const char *

folder_name

)

[protected]

void BM_OpState::appendFeelToFolder	(	const char *	folder_name,
		UI_Feel *	child_feel
	)			[protected]

int BM_OpState::appendFolder

(

const char *

folder_name

)

[protected]

int BM_OpState::appendPI	(	BM_OpHandleLink *	pi,
		int	opnum = -1
	)			[protected]

int BM_OpState::appendTextToFolder	(	const char *	folder_name,
		const char *	text,
		UI_LookType	look_type = UI_LOOK_HEADING_TEXT
	)			[protected]

int BM_OpState::appendThisStateDialogToFolder

(

const char *

folder_name

)

[protected]

const BM_OpView& BM_OpState::baseViewer

(

)

const [inline, protected]

Definition at line 75 of file BM_OpState.h.

BM_OpView& BM_OpState::baseViewer

(

)

[inline, protected]

Definition at line 74 of file BM_OpState.h.

virtual const char* BM_OpState::className

(

)

const [virtual]

Reimplemented from BM_State.

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

void BM_OpState::connectNode	(	OP_Node &	newnode,
		OP_Node &	inputnode,
		int	input_idx = 0,
		int	branch_off = 0
	)			[protected]

int BM_OpState::createPI	(	const char *	pi_name,
		int	opnum = -1,
		const char *	description = 0
	)			[protected]

virtual UI_Feel* BM_OpState::dialogFeel

(

)

const [virtual]

Reimplemented from BM_ParmState.

virtual int BM_OpState::findPI

(

BM_OpHandleLink *

pi

)

const [virtual]

Reimplemented from BM_State.

static int BM_OpState::getAutoHighlightFlag

(

)

[inline, static]

Definition at line 67 of file BM_OpState.h.

float BM_OpState::getTime

(

)

const

Obtains the current global time.

Examples:

SOP/MSS_CustomBrushState.C.

virtual void BM_OpState::handleDialogDeleted

(

OPUI_Dialog *

deleted_dialog

)

[protected, virtual]

Reimplemented in BM_SingleOpState.

virtual int BM_OpState::handleKeyTypeEvent	(	UI_Event *	event,
		BM_Viewport &	viewport
	)			[protected, virtual]

Reimplemented from BM_SimpleState.

Reimplemented in 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_OpState::handleMouseEvent

(

UI_Event *

event

)

[virtual]

Reimplemented from BM_State.

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

void BM_OpState::handlePIButtonChange

(

UI_Event *

event

)

[protected]

virtual int BM_OpState::hasDialog

(

)

const [virtual]

Reimplemented from BM_ParmState.

virtual void BM_OpState::interrupt

(

BM_SimpleState *

= 0

)

[protected, virtual]

Reimplemented from BM_State.

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

virtual void BM_OpState::makePIVisible	(	int	pi_idx,
		int	onoff
	)			[protected, virtual]

Reimplemented in BM_SingleOpState.

virtual int BM_OpState::matchesNode

(

OP_Node &

node

)

const [protected, pure virtual]

Implemented in BM_SingleOpState, MSS_EditState, and MSS_PolySplitState.

int BM_OpState::numPIs

(

)

const [inline, protected]

Definition at line 104 of file BM_OpState.h.

const BM_OpHandleLink* BM_OpState::pi

(

const char *

name

)

const [protected]

BM_OpHandleLink* BM_OpState::pi

(

const char *

name

)

[protected]

const BM_OpHandleLink* BM_OpState::pi

(

int

index

)

const [protected]

BM_OpHandleLink* BM_OpState::pi

(

int

index

)

[protected]

const char* BM_OpState::piDescription

(

int

index

)

const [protected]

int BM_OpState::piOpnum

(

int

index

)

const [protected]

virtual void BM_OpState::prepareDialogForDisplay

(

)

const [virtual]

Reimplemented from BM_ParmState.

virtual void BM_OpState::removeAllDialogs

(

)

[protected, virtual]

Reimplemented in BM_SingleOpState.

void BM_OpState::removeAllLinkedPIs

(

)

[protected]

int BM_OpState::removeDialog	(	OP_Node &	op_node,
		PRM_Template::PRM_Export	export_level
	)			[protected]

int BM_OpState::removeDialog

(

BM_ParmState &

state

)

[protected]

int BM_OpState::removeFolder

(

const char *

name

)

[protected]

virtual void BM_OpState::removePI

(

int

pi_idx

)

[protected, virtual]

virtual void BM_OpState::resume

(

BM_SimpleState *

= 0

)

[protected, virtual]

Reimplemented from BM_State.

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

static void BM_OpState::setAutoHighlightFlag

(

int

o

)

[inline, static]

Definition at line 68 of file BM_OpState.h.

void BM_OpState::stampNode

(

OP_Node &

newnode

)

[protected]

void BM_OpState::switchToFolder

(

const char *

name

)

[protected]

---

Member Data Documentation

const char* BM_OpState::HANDLES_FOLDER [static, protected]

Definition at line 163 of file BM_OpState.h.

UT_PtrArray<opbm_DialogInfo *> BM_OpState::myDialogs [protected]

Definition at line 157 of file BM_OpState.h.

SI_Folders* BM_OpState::myFolders [protected]

Definition at line 160 of file BM_OpState.h.

UT_PtrArray<UI_Feel *> BM_OpState::myMiscFeels [protected]

Definition at line 159 of file BM_OpState.h.

UT_PtrArray<opbm_PIContext *> BM_OpState::myPIs [protected]

Definition at line 158 of file BM_OpState.h.

BM_OpView& BM_OpState::myViewer [protected]

Definition at line 155 of file BM_OpState.h.

const char* BM_OpState::OP_DIALOG_FOLDER [static, protected]

Definition at line 164 of file BM_OpState.h.

const char* BM_OpState::STATE_DIALOG_FOLDER [static, protected]

Definition at line 162 of file BM_OpState.h.

int BM_OpState::theAutoHighlightFlag [static, protected]

Definition at line 165 of file BM_OpState.h.

---

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

• BM/BM_OpState.h