HDK_Sample::MSS_CustomBrushState Class Reference

#include <MSS_CustomBrushState.h>

Inheritance diagram for HDK_Sample::MSS_CustomBrushState:

List of all members.

Public Member Functions
	MSS_CustomBrushState (JEDI_View &view, PI_StateTemplate &templ, BM_SceneManager *scene, char *cursor=BM_DEFAULT_CURSOR)
virtual	~MSS_CustomBrushState ()
virtual const char *	className () const
	The name and type of this class:.
Static Public Member Functions
static BM_State *	ourConstructor (BM_View &view, PI_StateTemplate &templ, BM_SceneManager *scene)
	used by DM to create our state
Static Public Attributes
static PRM_Template *	ourTemplateList = 0
	parameters for this state
Protected Member Functions
virtual int	enter (BM_SimpleState::BM_EntryType how)
	called when the user enters the state
virtual void	exit ()
	called when the user leaves the state
virtual void	interrupt (BM_SimpleState *=0)
virtual void	resume (BM_SimpleState *=0)
virtual int	handleMouseEvent (UI_Event *event)
	Respond to mouse or keyboard events.
virtual void	doRender (RE_Render *r, short x, short y, int ghost)
	Render the brush "cursor" geometry:.
virtual void	updatePrompt ()
	sets the prompt's text
void	updateBrush (int x, int y)
	repositions the brush's guide geometry

---

Detailed Description

Definition at line 38 of file MSS_CustomBrushState.h.

---

Constructor & Destructor Documentation

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

Examples:

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

Definition at line 73 of file MSS_CustomBrushState.C.

MSS_CustomBrushState::~MSS_CustomBrushState

(

)

[virtual]

Examples:

SOP/MSS_CustomBrushState.h.

Definition at line 97 of file MSS_CustomBrushState.C.

---

Member Function Documentation

const char * MSS_CustomBrushState::className

(

void

)

const [virtual]

The name and type of this class:.

Reimplemented from MSS_SingleOpState.

Examples:

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

Definition at line 103 of file MSS_CustomBrushState.C.

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

Render the brush "cursor" geometry:.

Reimplemented from MSS_SingleOpState.

Examples:

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

Definition at line 302 of file MSS_CustomBrushState.C.

int MSS_CustomBrushState::enter

(

BM_SimpleState::BM_EntryType

how

)

[protected, virtual]

called when the user enters the state

Reimplemented from MSS_SingleOpState.

Examples:

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

Definition at line 109 of file MSS_CustomBrushState.C.

void MSS_CustomBrushState::exit

(

void

)

[protected, virtual]

called when the user leaves the state

Reimplemented from MSS_SingleOpState.

Examples:

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

Definition at line 126 of file MSS_CustomBrushState.C.

int MSS_CustomBrushState::handleMouseEvent

(

UI_Event *

event

)

[protected, virtual]

Respond to mouse or keyboard events.

Reimplemented from MSS_SingleOpState.

Examples:

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

Definition at line 161 of file MSS_CustomBrushState.C.

void MSS_CustomBrushState::interrupt

(

BM_SimpleState *

state = 0

)

[protected, virtual]

called when the user temporarily leaves the state (mouse leaves the viewport)

Reimplemented from BM_OpState.

Examples:

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

Definition at line 151 of file MSS_CustomBrushState.C.

BM_State * MSS_CustomBrushState::ourConstructor	(	BM_View &	view,
		PI_StateTemplate &	templ,
		BM_SceneManager *	scene
	)			[static]

used by DM to create our state

Reimplemented from MSS_SingleOpState.

Examples:

SOP/MSS_CustomBrushState.h.

Definition at line 67 of file MSS_CustomBrushState.C.

void MSS_CustomBrushState::resume

(

BM_SimpleState *

state = 0

)

[protected, virtual]

called when the user returns to the state after leaving temporarily (mouse re-enters the viewport)

Reimplemented from MSS_SingleOpState.

Examples:

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

Definition at line 137 of file MSS_CustomBrushState.C.

void MSS_CustomBrushState::updateBrush	(	int	x,
		int	y
	)			[protected]

repositions the brush's guide geometry

Examples:

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

Definition at line 336 of file MSS_CustomBrushState.C.

void MSS_CustomBrushState::updatePrompt

(

)

[protected, virtual]

sets the prompt's text

Examples:

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

Definition at line 330 of file MSS_CustomBrushState.C.

---

Member Data Documentation

PRM_Template * MSS_CustomBrushState::ourTemplateList = 0 [static]

parameters for this state

Reimplemented from MSS_SingleOpState.

Examples:

SOP/MSS_CustomBrushState.h.

Definition at line 51 of file MSS_CustomBrushState.h.

---

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

• samples/SOP/MSS_CustomBrushState.h
• samples/SOP/MSS_CustomBrushState.C