OP3D_InputSelectorBase Class Reference

#include <OP3D_InputSelectorBase.h>

Inheritance diagram for OP3D_InputSelectorBase:

List of all members.

Public Member Functions
	OP3D_InputSelectorBase (OP3D_View &viewer, PI_SelectorTemplate &templ)
virtual	~OP3D_InputSelectorBase ()
virtual void	setViewer (BM_View *viewer)
virtual void	startSelecting (bool copy_cooked_selection=true)
virtual void	stopSelecting ()
UI_Value &	finishedValue ()
const UI_Value &	finishedValue () const
UI_Feel *	getCustomToolbox () const
void	setPreferredSelectMode (DM_SelectMode selmode)
DM_SelectMode	getPreferredSelectMode () const
bool	allowDragging () const
void	allowDragging (bool on)
bool	allowFinishing () const
void	allowFinishing (bool onoff)
bool	allowFinishWithExistingSelection () const
void	allowFinishWithExistingSelection (bool onoff)
bool	allowQuickSelect () const
void	allowQuickSelect (bool on)
bool	justDisplayedOp () const
void	justDisplayedOp (bool onoff)
virtual int	handleKeyEvent (UI_Event *event, DM_Viewport &viewport)=0
virtual bool	handleTransitoryKey (const UI_Event &event)
virtual UI_Menu *	getSelectorMenu () const =0
virtual UI_Menu *	getSelectorHotkeyMenu () const
virtual const char *	cursor () const
void	handleSelectionStyleChange (UI_Event *event)
Static Public Member Functions
static bool	getPickingMenuOn ()
static void	setPickingMenuOn (bool val)
static bool	getAllowUseExistingSelection ()
static void	setAllowUseExistingSelection (bool val)
static GU_Detail *	getGeometryFromPath (const char *path)
static OP_Node *	getNodeFromPath (const char *path)
static const SIM_Object *	getSimObjectFromPath (const char *path)
static const SIM_Data *	getSimModifierFromPath (const char *path)
Protected Member Functions
OP3D_View &	viewer ()
const OP3D_View &	viewer () const
DM_Workbench &	workbench ()
const DM_Workbench &	workbench () const
void	setFinishedValuePtr (UI_Value *new_value)
UI_Value *	getFinishedValuePtr () const
void	setSelectionStylePtr (UI_Value *new_value)
UI_Value *	getSelectionStylePtr () const
DM_SelectionStyle	selectionStyle () const
void	setSelectionRulePtr (UI_Value *new_value)
UI_Value *	getSelectionRulePtr () const
GU_SelectionRule	selectionRule () const
void	selectionRule (GU_SelectionRule srule)
SI_Brush *	getPickBrushPtr () const
virtual bool	needObjectPick () const
bool	selectModeMatchesTemplateType ()
bool	pickChosenOp (unsigned *pick_buffer, int num_picked)
void	userFilterPicks (uint *pickbuf, int &npicked, UI_Event *event)
virtual OP_Node *	switchToChosenOp (OP_Node *parent)
virtual void	saveForUndo ()
virtual bool	getPickName (const OP3D_PickId &pickid, UT_String &name, bool descriptivename) const =0
void	enablePicker (UI_Event *event)
virtual void	handleBoxPickEvent (UI_Event *event)=0
virtual void	handleLassoPickEvent (UI_Event *event)=0
virtual void	handleBrushPickEvent (UI_Event *event)=0
Static Protected Member Functions
static float	getTime ()

---

Detailed Description

Definition at line 72 of file OP3D_InputSelectorBase.h.

---

Constructor & Destructor Documentation

OP3D_InputSelectorBase::OP3D_InputSelectorBase	(	OP3D_View &	viewer,
		PI_SelectorTemplate &	templ
	)

virtual OP3D_InputSelectorBase::~OP3D_InputSelectorBase

(

)

[virtual]

---

Member Function Documentation

void OP3D_InputSelectorBase::allowDragging

(

bool

on

)

[inline]

Definition at line 112 of file OP3D_InputSelectorBase.h.

bool OP3D_InputSelectorBase::allowDragging

(

)

const [inline]

Definition at line 111 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::allowFinishing

(

bool

onoff

)

[inline]

Definition at line 118 of file OP3D_InputSelectorBase.h.

bool OP3D_InputSelectorBase::allowFinishing

(

)

const [inline]

Definition at line 116 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::allowFinishWithExistingSelection

(

bool

onoff

)

bool OP3D_InputSelectorBase::allowFinishWithExistingSelection

(

)

const

void OP3D_InputSelectorBase::allowQuickSelect

(

bool

on

)

[inline]

Definition at line 129 of file OP3D_InputSelectorBase.h.

bool OP3D_InputSelectorBase::allowQuickSelect

(

)

const [inline]

Definition at line 128 of file OP3D_InputSelectorBase.h.

virtual const char* OP3D_InputSelectorBase::cursor

(

)

const [virtual]

Reimplemented from BM_InputSelector.

void OP3D_InputSelectorBase::enablePicker

(

UI_Event *

event

)

[protected]

const UI_Value& OP3D_InputSelectorBase::finishedValue

(

)

const [inline]

Definition at line 100 of file OP3D_InputSelectorBase.h.

UI_Value& OP3D_InputSelectorBase::finishedValue

(

)

[inline]

Definition at line 99 of file OP3D_InputSelectorBase.h.

static bool OP3D_InputSelectorBase::getAllowUseExistingSelection

(

)

[inline, static]

Definition at line 164 of file OP3D_InputSelectorBase.h.

UI_Feel* OP3D_InputSelectorBase::getCustomToolbox

(

)

const

UI_Value* OP3D_InputSelectorBase::getFinishedValuePtr

(

)

const [inline, protected]

Definition at line 186 of file OP3D_InputSelectorBase.h.

static GU_Detail* OP3D_InputSelectorBase::getGeometryFromPath

(

const char *

path

)

[static]

static OP_Node* OP3D_InputSelectorBase::getNodeFromPath

(

const char *

path

)

[static]

SI_Brush* OP3D_InputSelectorBase::getPickBrushPtr

(

)

const [inline, protected]

Definition at line 220 of file OP3D_InputSelectorBase.h.

static bool OP3D_InputSelectorBase::getPickingMenuOn

(

)

[inline, static]

Definition at line 162 of file OP3D_InputSelectorBase.h.

virtual bool OP3D_InputSelectorBase::getPickName	(	const OP3D_PickId &	pickid,
		UT_String &	name,
		bool	descriptivename
	)			const [protected, pure virtual]

Implemented in OP3D_InputSelector.

DM_SelectMode OP3D_InputSelectorBase::getPreferredSelectMode

(

)

const [inline]

Definition at line 106 of file OP3D_InputSelectorBase.h.

UI_Value* OP3D_InputSelectorBase::getSelectionRulePtr

(

)

const [inline, protected]

Definition at line 204 of file OP3D_InputSelectorBase.h.

UI_Value* OP3D_InputSelectorBase::getSelectionStylePtr

(

)

const [inline, protected]

Definition at line 191 of file OP3D_InputSelectorBase.h.

virtual UI_Menu* OP3D_InputSelectorBase::getSelectorHotkeyMenu

(

)

const [inline, virtual]

Reimplemented in OP3D_InputSelector.

Definition at line 153 of file OP3D_InputSelectorBase.h.

virtual UI_Menu* OP3D_InputSelectorBase::getSelectorMenu

(

)

const [pure virtual]

Implemented in MSS_PeltSelector, and OP3D_InputSelector.

static const SIM_Data* OP3D_InputSelectorBase::getSimModifierFromPath

(

const char *

path

)

[static]

static const SIM_Object* OP3D_InputSelectorBase::getSimObjectFromPath

(

const char *

path

)

[static]

static float OP3D_InputSelectorBase::getTime

(

)

[static, protected]

virtual void OP3D_InputSelectorBase::handleBoxPickEvent

(

UI_Event *

event

)

[protected, pure virtual]

virtual void OP3D_InputSelectorBase::handleBrushPickEvent

(

UI_Event *

event

)

[protected, pure virtual]

virtual int OP3D_InputSelectorBase::handleKeyEvent	(	UI_Event *	event,
		DM_Viewport &	viewport
	)			[pure virtual]

Implemented in MSS_JoinSelector, MSS_PeltSelector, and OP3D_InputSelector.

virtual void OP3D_InputSelectorBase::handleLassoPickEvent

(

UI_Event *

event

)

[protected, pure virtual]

void OP3D_InputSelectorBase::handleSelectionStyleChange

(

UI_Event *

event

)

virtual bool OP3D_InputSelectorBase::handleTransitoryKey

(

const UI_Event &

event

)

[virtual]

void OP3D_InputSelectorBase::justDisplayedOp

(

bool

onoff

)

[inline]

Definition at line 139 of file OP3D_InputSelectorBase.h.

bool OP3D_InputSelectorBase::justDisplayedOp

(

)

const [inline]

Definition at line 137 of file OP3D_InputSelectorBase.h.

virtual bool OP3D_InputSelectorBase::needObjectPick

(

)

const [protected, virtual]

Reimplemented in OP3D_InputSelector.

bool OP3D_InputSelectorBase::pickChosenOp	(	unsigned *	pick_buffer,
		int	num_picked
	)			[protected]

virtual void OP3D_InputSelectorBase::saveForUndo

(

)

[protected, virtual]

Reimplemented in MSS_JoinSelector, MSS_PeltSelector, and OP3D_InputSelector.

void OP3D_InputSelectorBase::selectionRule

(

GU_SelectionRule

srule

)

[inline, protected]

Definition at line 214 of file OP3D_InputSelectorBase.h.

GU_SelectionRule OP3D_InputSelectorBase::selectionRule

(

)

const [inline, protected]

Definition at line 206 of file OP3D_InputSelectorBase.h.

DM_SelectionStyle OP3D_InputSelectorBase::selectionStyle

(

)

const [inline, protected]

Definition at line 193 of file OP3D_InputSelectorBase.h.

bool OP3D_InputSelectorBase::selectModeMatchesTemplateType

(

)

[protected]

static void OP3D_InputSelectorBase::setAllowUseExistingSelection

(

bool

val

)

[inline, static]

Definition at line 166 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::setFinishedValuePtr

(

UI_Value *

new_value

)

[inline, protected]

Definition at line 184 of file OP3D_InputSelectorBase.h.

static void OP3D_InputSelectorBase::setPickingMenuOn

(

bool

val

)

[inline, static]

Definition at line 163 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::setPreferredSelectMode

(

DM_SelectMode

selmode

)

[inline]

Definition at line 104 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::setSelectionRulePtr

(

UI_Value *

new_value

)

[inline, protected]

Definition at line 202 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::setSelectionStylePtr

(

UI_Value *

new_value

)

[inline, protected]

Definition at line 189 of file OP3D_InputSelectorBase.h.

virtual void OP3D_InputSelectorBase::setViewer

(

BM_View *

viewer

)

[virtual]

Reimplemented from BM_InputSelector.

Reimplemented in OP3D_InputSelector.

virtual void OP3D_InputSelectorBase::startSelecting

(

bool

copy_cooked_selection = true

)

[virtual]

Reimplemented from BM_InputSelector.

Reimplemented in MSS_JoinSelector, MSS_PeltSelector, and OP3D_InputSelector.

virtual void OP3D_InputSelectorBase::stopSelecting

(

)

[virtual]

Reimplemented from BM_InputSelector.

Reimplemented in OP3D_InputSelector.

virtual OP_Node* OP3D_InputSelectorBase::switchToChosenOp

(

OP_Node *

parent

)

[protected, virtual]

Reimplemented in OP3D_InputSelector.

void OP3D_InputSelectorBase::userFilterPicks	(	uint *	pickbuf,
		int &	npicked,
		UI_Event *	event
	)			[protected]

const OP3D_View& OP3D_InputSelectorBase::viewer

(

)

const [inline, protected]

Definition at line 179 of file OP3D_InputSelectorBase.h.

OP3D_View& OP3D_InputSelectorBase::viewer

(

)

[inline, protected]

Examples:

SOP/MSS_BrushHairLenSelector.h.

Definition at line 178 of file OP3D_InputSelectorBase.h.

const DM_Workbench& OP3D_InputSelectorBase::workbench

(

)

const [inline, protected]

Definition at line 182 of file OP3D_InputSelectorBase.h.

DM_Workbench& OP3D_InputSelectorBase::workbench

(

)

[inline, protected]

Definition at line 181 of file OP3D_InputSelectorBase.h.

---

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

• OP3D/OP3D_InputSelectorBase.h