OP3D_InputSelector Class Reference

#include <OP3D_InputSelector.h>

Inheritance diagram for OP3D_InputSelector:

List of all members.

Public Member Functions
	OP3D_InputSelector (OP3D_View &viewer, PI_SelectorTemplate &templ)
virtual	~OP3D_InputSelector ()
virtual const char *	className () const
virtual int	handleMouseEvent (UI_Event *event)
virtual bool	handleDoubleClickEvent (UI_Event *event)
virtual int	handleKeyEvent (UI_Event *event, DM_Viewport &viewport)
bool	willHandleKeyEvent (UI_Event *event)
int	selectionIndex () const
void	selectionIndex (int selection_index)
bool	inputRequired () const
void	inputRequired (bool onoff)
bool	useAsteriskToSelectAll () const
void	useAsteriskToSelectAll (bool onoff)
bool	orderedSelector () const
void	orderedSelector (bool onoff)
void	usePrimsInEdgeSelections (bool use_prims)
GEO_PrimTypeCompat::TypeMask	primMask () const
void	primMask (GEO_PrimTypeCompat::TypeMask primmask)
void	setPickAtObjLevel (bool flag)
bool	getPickAtObjLevel () const
virtual void	startSelecting (bool copy_cooked_selection=true)
virtual void	stopSelecting ()
void	addCookedSelection (SOP_Node *sop)
void	nodeIdForReselecting (int node_id)
virtual void	clearSelections ()
virtual void	setViewer (BM_View *viewer)
void	setSelectionUIValues (UI_Value *sel_type, UI_Value *sel_rule, UI_Value *sel_style, UI_Value *sel_visible, UI_Value *sel_full, UI_Value *locate_always, UI_Value *finished)
void	setCreatorStateName (const char *state_name)
const UT_String &	creatorStateName ()
void	allowDragSelect (bool yesno)
void	selectFullGeometry (bool yesno)
void	saveUndos (bool yesno)
bool	saveUndos () const
void	renderForPicking (RE_Render *r, short x, short y)
bool	connectOps (OP_Node &new_node, int op_input_index, const UT_String &input_parm, bool update_sel_buttons=true, int *menu_idx=0, bool branch_off=false, bool multi_input=false, bool force_selection_string=false)
const UT_StringArray &	selectedOpPaths () const
void	setSelectedOpPaths (const UT_StringArray &paths)
const UT_IntArray &	selectedSelInstances () const
void	setSelectedSelInstances (const UT_IntArray &selinsts)
void	addSelectedPath (const char *path, int selinstance, GU_Selection *sel)
void	movePathToEnd (const char *path)
void	removeSelectedPath (const char *path)
const UT_String &	currentPrompt () const
UT_String &	currentPrompt ()
const UT_String &	defaultPrompt () const
UT_String &	defaultPrompt ()
void	selectorFinished (bool drag=false)
void	setUndoWorker (OP3D_InputSelectorUndoWorker *worker=0)
OP3D_InputSelectorUndoWorker *	getDefaultUndoWorker ()
virtual UI_Menu *	getSelectorMenu () const
virtual UI_Menu *	getSelectorHotkeyMenu () const
virtual void	doRender (RE_Render *r, short x, short y, int ghost)
void	setValidForPickFilter (void *data, OP3D_ValidForPickFilter filter)
void	setGeometryType (DM_GeometryType geo_type, bool connected, bool update_buttons)
GU_SelectionType	selectionType () const
DM_GeometryType	getGeometryTypeAtFinish () const
bool	getConnectedAtFinish () const
int	getGroupTypeMenuValAtFinish () const
bool	getKeepOriginalObjects () const
bool	getIsView3D ()
GU_SelectionConnectivity	getConnectivity ()
const DM_GeometryTypeArray &	getSelectionAllowedTypes () const
void	setSelectionAllowedTypes (const DM_GeometryTypeArray &allowedtypes)
DM_GeometryType	getNextBestAllowedType (DM_GeometryType disallowed_type) const
virtual void	makeValidSelections (DM_GeometryType &geo_type, bool &connected, int &group_type_menu_val)=0
virtual void	generateAllSelectionStrings (UT_String &sel_string, bool destroy_selections, bool only_one_gdp)
Static Public Member Functions
static GU_Selection *	getSelection (GU_Detail &gdp, int &selinst, int selection_index, GU_SelectionType sel_type, GU_SelectionConnectivity connectivity, bool isview3d, bool create_selection)
static SOP_Node *	createObjectMerge (OP_Network *network, UT_String &path, int &selinst, int selindex, const UT_String &creator_state_name, bool keep_original_objects, bool display_origina_objects)
static GU_SelectionConnectivity	getConnectivity (DM_Workbench &bench)
static void	makeSelectionsValid (const UT_StringArray &paths, const UT_IntArray &selinstances, int selindex, DM_GeometryType geo_type, bool connected, GU_SelectionConnectivity connect, bool isview3d, GEO_PrimTypeCompat::TypeMask prmask, OP3D_InputSelector *selector)
static bool	generateSelectionString (UT_String &sel_string, const GU_Detail &gdp, GU_Selection &selection, int prim_offset, int point_offset, bool collapse_where_possible, bool use_ast_to_select_all)
static void	generateMergedSelectionString (UT_String &sel_string, UT_StringArray &paths, UT_IntArray &selinstances, int selindex, bool collapse, bool use_ast_to_select_all)
static bool	convertSelectionType (GU_Detail &gdp, GU_SelectionType stype, GU_SelectionConnectivity c, bool view3d, int selinst, int selindex)
static bool	createSelectionFromObjects (const OP_NodeList &objects, DM_Viewport &viewport, DM_GeometryType geo_type, int selindex, GU_SelectionConnectivity connectivity, bool is_view3d, UT_StringArray &paths, UT_IntArray &selinsts)
Protected Member Functions
virtual void	handleSelectionTypeChange (UI_Event *event)
virtual void	addToSelection (UI_Event *, const char *, int, GU_SelectResult &)
virtual bool	modifySelections (UI_Event *event, unsigned *pick_buffer, int num_picked, GU_SelectionRule sel_rule, int num_lasso_points, int *lasso_points, op3d_BrushData *brushdata)
virtual bool	handleNoPick (UI_Event *event)
virtual void	appendToLastNode (SOP_Node *&, const UT_String &, bool)
virtual void	generateAdditionalInputNodes (SOP_Node &, SOP_Node *, const UT_String &, const UT_String &)
virtual void	setNodeParameters (OP_Node &)
int	pickMask () const
GU_Selection *	getOrCreateSelection (GU_Detail &gdp, int &selinst)
GU_Selection *	getExistingSelection (GU_Detail &gdp, int selinst)
void	overrideSelectionValues (int sel_type, int sel_rule, int sel_style, int sel_full, int locate)
void	restoreSelectionValues ()
virtual OP_Node *	switchToChosenOp (OP_Node *parent)
virtual void	saveForUndo ()
virtual bool	getPickName (const OP3D_PickId &pickid, UT_String &name, bool descriptivename) const
virtual bool	needObjectPick () const
bool	emptySelections (const char *path_to_skip=0, bool refresh=true)
void	destroySelection (GU_Detail &gdp, int selinst)
void	dirtySelection (GU_Detail &gdp, int selinst)
void	clearSelectionArrays ()
Friends
class	OP3D_InputSelectorUndo

---

Detailed Description

Definition at line 63 of file OP3D_InputSelector.h.

---

Constructor & Destructor Documentation

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

virtual OP3D_InputSelector::~OP3D_InputSelector

(

)

[virtual]

---

Member Function Documentation

void OP3D_InputSelector::addCookedSelection

(

SOP_Node *

sop

)

void OP3D_InputSelector::addSelectedPath	(	const char *	path,
		int	selinstance,
		GU_Selection *	sel
	)

virtual void OP3D_InputSelector::addToSelection	(	UI_Event *	,
		const char *	,
		int	,
		GU_SelectResult &
	)			[inline, protected, virtual]

Reimplemented in MSS_JoinSelector, and MSS_PeltSelector.

Definition at line 367 of file OP3D_InputSelector.h.

void OP3D_InputSelector::allowDragSelect

(

bool

yesno

)

[inline]

Definition at line 169 of file OP3D_InputSelector.h.

virtual void OP3D_InputSelector::appendToLastNode	(	SOP_Node *&	,
		const UT_String &	,
		bool
	)			[inline, protected, virtual]

Reimplemented in MSS_JoinSelector.

Definition at line 386 of file OP3D_InputSelector.h.

virtual const char* OP3D_InputSelector::className

(

)

const [virtual]

Reimplemented from BM_InputSelector.

Reimplemented in MSS_CaptureLayerPaintSelector, MSS_CapturePaintSelector, MSS_CombSelector, MSS_CurveClaySelector, MSS_DeleteSelector, MSS_EditSelector, MSS_GroupPaintSelector, MSS_JoinSelector, MSS_LatticeSelector, MSS_PaintSelector, MSS_PaintSlideModifierSelector, MSS_PeltSelector, MSS_ReusableSelector, MSS_SculptSelector, MSS_UVBrushSelector, MSS_UVEditSelector, OP3D_GenericSelector, and HDK_Sample::MSS_BrushHairLenSelector.

void OP3D_InputSelector::clearSelectionArrays

(

)

[protected]

virtual void OP3D_InputSelector::clearSelections

(

)

[virtual]

Reimplemented in MSS_JoinSelector.

bool OP3D_InputSelector::connectOps	(	OP_Node &	new_node,
		int	op_input_index,
		const UT_String &	input_parm,
		bool	update_sel_buttons = true,
		int *	menu_idx = 0,
		bool	branch_off = false,
		bool	multi_input = false,
		bool	force_selection_string = false
	)

static bool OP3D_InputSelector::convertSelectionType	(	GU_Detail &	gdp,
		GU_SelectionType	stype,
		GU_SelectionConnectivity	c,
		bool	view3d,
		int	selinst,
		int	selindex
	)			[static]

static SOP_Node* OP3D_InputSelector::createObjectMerge	(	OP_Network *	network,
		UT_String &	path,
		int &	selinst,
		int	selindex,
		const UT_String &	creator_state_name,
		bool	keep_original_objects,
		bool	display_origina_objects
	)			[static]

static bool OP3D_InputSelector::createSelectionFromObjects	(	const OP_NodeList &	objects,
		DM_Viewport &	viewport,
		DM_GeometryType	geo_type,
		int	selindex,
		GU_SelectionConnectivity	connectivity,
		bool	is_view3d,
		UT_StringArray &	paths,
		UT_IntArray &	selinsts
	)			[static]

const UT_String& OP3D_InputSelector::creatorStateName

(

)

[inline]

Definition at line 165 of file OP3D_InputSelector.h.

UT_String& OP3D_InputSelector::currentPrompt

(

)

[inline]

Definition at line 220 of file OP3D_InputSelector.h.

const UT_String& OP3D_InputSelector::currentPrompt

(

)

const [inline]

Definition at line 219 of file OP3D_InputSelector.h.

UT_String& OP3D_InputSelector::defaultPrompt

(

)

[inline]

Definition at line 222 of file OP3D_InputSelector.h.

const UT_String& OP3D_InputSelector::defaultPrompt

(

)

const [inline]

Definition at line 221 of file OP3D_InputSelector.h.

void OP3D_InputSelector::destroySelection	(	GU_Detail &	gdp,
		int	selinst
	)			[protected]

void OP3D_InputSelector::dirtySelection	(	GU_Detail &	gdp,
		int	selinst
	)			[protected]

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

Reimplemented from BM_InputSelector.

Reimplemented in MSS_JoinSelector, and MSS_PeltSelector.

bool OP3D_InputSelector::emptySelections	(	const char *	path_to_skip = 0,
		bool	refresh = true
	)			[protected]

virtual void OP3D_InputSelector::generateAdditionalInputNodes	(	SOP_Node &	,
		SOP_Node *	,
		const UT_String &	,
		const UT_String &
	)			[inline, protected, virtual]

Reimplemented in MSS_CurveClaySelector, and MSS_LatticeSelector.

Definition at line 391 of file OP3D_InputSelector.h.

virtual void OP3D_InputSelector::generateAllSelectionStrings	(	UT_String &	sel_string,
		bool	destroy_selections,
		bool	only_one_gdp
	)			[virtual]

Reimplemented in MSS_JoinSelector.

static void OP3D_InputSelector::generateMergedSelectionString	(	UT_String &	sel_string,
		UT_StringArray &	paths,
		UT_IntArray &	selinstances,
		int	selindex,
		bool	collapse,
		bool	use_ast_to_select_all
	)			[static]

static bool OP3D_InputSelector::generateSelectionString	(	UT_String &	sel_string,
		const GU_Detail &	gdp,
		GU_Selection &	selection,
		int	prim_offset,
		int	point_offset,
		bool	collapse_where_possible,
		bool	use_ast_to_select_all
	)			[static]

bool OP3D_InputSelector::getConnectedAtFinish

(

)

const

static GU_SelectionConnectivity OP3D_InputSelector::getConnectivity

(

DM_Workbench &

bench

)

[static]

GU_SelectionConnectivity OP3D_InputSelector::getConnectivity

(

)

OP3D_InputSelectorUndoWorker* OP3D_InputSelector::getDefaultUndoWorker

(

)

GU_Selection* OP3D_InputSelector::getExistingSelection	(	GU_Detail &	gdp,
		int	selinst
	)			[protected]

DM_GeometryType OP3D_InputSelector::getGeometryTypeAtFinish

(

)

const

int OP3D_InputSelector::getGroupTypeMenuValAtFinish

(

)

const

bool OP3D_InputSelector::getIsView3D

(

)

bool OP3D_InputSelector::getKeepOriginalObjects

(

)

const

DM_GeometryType OP3D_InputSelector::getNextBestAllowedType

(

DM_GeometryType

disallowed_type

)

const

GU_Selection* OP3D_InputSelector::getOrCreateSelection	(	GU_Detail &	gdp,
		int &	selinst
	)			[protected]

bool OP3D_InputSelector::getPickAtObjLevel

(

)

const [inline]

Definition at line 127 of file OP3D_InputSelector.h.

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

Implements OP3D_InputSelectorBase.

static GU_Selection* OP3D_InputSelector::getSelection	(	GU_Detail &	gdp,
		int &	selinst,
		int	selection_index,
		GU_SelectionType	sel_type,
		GU_SelectionConnectivity	connectivity,
		bool	isview3d,
		bool	create_selection
	)			[static]

const DM_GeometryTypeArray& OP3D_InputSelector::getSelectionAllowedTypes

(

)

const

virtual UI_Menu* OP3D_InputSelector::getSelectorHotkeyMenu

(

)

const [virtual]

Reimplemented from OP3D_InputSelectorBase.

virtual UI_Menu* OP3D_InputSelector::getSelectorMenu

(

)

const [virtual]

Implements OP3D_InputSelectorBase.

Reimplemented in MSS_PeltSelector.

virtual bool OP3D_InputSelector::handleDoubleClickEvent

(

UI_Event *

event

)

[virtual]

Reimplemented from BM_InputSelector.

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

Implements OP3D_InputSelectorBase.

Reimplemented in MSS_JoinSelector, and MSS_PeltSelector.

virtual int OP3D_InputSelector::handleMouseEvent

(

UI_Event *

event

)

[virtual]

Reimplemented from BM_InputSelector.

Reimplemented in MSS_JoinSelector, and MSS_PeltSelector.

virtual bool OP3D_InputSelector::handleNoPick

(

UI_Event *

event

)

[protected, virtual]

Reimplemented in MSS_JoinSelector.

virtual void OP3D_InputSelector::handleSelectionTypeChange

(

UI_Event *

event

)

[protected, virtual]

void OP3D_InputSelector::inputRequired

(

bool

onoff

)

[inline]

Definition at line 96 of file OP3D_InputSelector.h.

bool OP3D_InputSelector::inputRequired

(

)

const [inline]

Definition at line 95 of file OP3D_InputSelector.h.

static void OP3D_InputSelector::makeSelectionsValid	(	const UT_StringArray &	paths,
		const UT_IntArray &	selinstances,
		int	selindex,
		DM_GeometryType	geo_type,
		bool	connected,
		GU_SelectionConnectivity	connect,
		bool	isview3d,
		GEO_PrimTypeCompat::TypeMask	prmask,
		OP3D_InputSelector *	selector
	)			[static]

virtual void OP3D_InputSelector::makeValidSelections	(	DM_GeometryType &	geo_type,
		bool &	connected,
		int &	group_type_menu_val
	)			[pure virtual]

Implemented in MSS_PeltSelector, and OP3D_GenericSelector.

virtual bool OP3D_InputSelector::modifySelections	(	UI_Event *	event,
		unsigned *	pick_buffer,
		int	num_picked,
		GU_SelectionRule	sel_rule,
		int	num_lasso_points,
		int *	lasso_points,
		op3d_BrushData *	brushdata
	)			[protected, virtual]

void OP3D_InputSelector::movePathToEnd

(

const char *

path

)

virtual bool OP3D_InputSelector::needObjectPick

(

)

const [protected, virtual]

Reimplemented from OP3D_InputSelectorBase.

void OP3D_InputSelector::nodeIdForReselecting

(

int

node_id

)

[inline]

Definition at line 138 of file OP3D_InputSelector.h.

void OP3D_InputSelector::orderedSelector

(

bool

onoff

)

[inline]

Definition at line 111 of file OP3D_InputSelector.h.

bool OP3D_InputSelector::orderedSelector

(

)

const [inline]

Definition at line 109 of file OP3D_InputSelector.h.

void OP3D_InputSelector::overrideSelectionValues	(	int	sel_type,
		int	sel_rule,
		int	sel_style,
		int	sel_full,
		int	locate
	)			[protected]

int OP3D_InputSelector::pickMask

(

)

const [protected]

void OP3D_InputSelector::primMask

(

GEO_PrimTypeCompat::TypeMask

primmask

)

[inline]

Definition at line 122 of file OP3D_InputSelector.h.

GEO_PrimTypeCompat::TypeMask OP3D_InputSelector::primMask

(

)

const [inline]

Definition at line 121 of file OP3D_InputSelector.h.

void OP3D_InputSelector::removeSelectedPath

(

const char *

path

)

void OP3D_InputSelector::renderForPicking	(	RE_Render *	r,
		short	x,
		short	y
	)

void OP3D_InputSelector::restoreSelectionValues

(

)

[protected]

virtual void OP3D_InputSelector::saveForUndo

(

)

[protected, virtual]

Reimplemented from OP3D_InputSelectorBase.

Reimplemented in MSS_JoinSelector, and MSS_PeltSelector.

bool OP3D_InputSelector::saveUndos

(

)

const [inline]

Definition at line 178 of file OP3D_InputSelector.h.

void OP3D_InputSelector::saveUndos

(

bool

yesno

)

[inline]

Definition at line 177 of file OP3D_InputSelector.h.

const UT_StringArray& OP3D_InputSelector::selectedOpPaths

(

)

const [inline]

Definition at line 201 of file OP3D_InputSelector.h.

const UT_IntArray& OP3D_InputSelector::selectedSelInstances

(

)

const [inline]

Definition at line 205 of file OP3D_InputSelector.h.

void OP3D_InputSelector::selectFullGeometry

(

bool

yesno

)

[inline]

Definition at line 173 of file OP3D_InputSelector.h.

void OP3D_InputSelector::selectionIndex

(

int

selection_index

)

[inline]

Definition at line 89 of file OP3D_InputSelector.h.

int OP3D_InputSelector::selectionIndex

(

)

const [inline]

Definition at line 88 of file OP3D_InputSelector.h.

GU_SelectionType OP3D_InputSelector::selectionType

(

)

const

void OP3D_InputSelector::selectorFinished

(

bool

drag = false

)

void OP3D_InputSelector::setCreatorStateName

(

const char *

state_name

)

[inline]

Definition at line 163 of file OP3D_InputSelector.h.

void OP3D_InputSelector::setGeometryType	(	DM_GeometryType	geo_type,
		bool	connected,
		bool	update_buttons
	)

virtual void OP3D_InputSelector::setNodeParameters

(

OP_Node &

)

[inline, protected, virtual]

Reimplemented in MSS_DeleteSelector, and MSS_JoinSelector.

Definition at line 397 of file OP3D_InputSelector.h.

void OP3D_InputSelector::setPickAtObjLevel

(

bool

flag

)

[inline]

Definition at line 125 of file OP3D_InputSelector.h.

void OP3D_InputSelector::setSelectedOpPaths

(

const UT_StringArray &

paths

)

[inline]

Definition at line 203 of file OP3D_InputSelector.h.

void OP3D_InputSelector::setSelectedSelInstances

(

const UT_IntArray &

selinsts

)

[inline]

Definition at line 207 of file OP3D_InputSelector.h.

void OP3D_InputSelector::setSelectionAllowedTypes

(

const DM_GeometryTypeArray &

allowedtypes

)

void OP3D_InputSelector::setSelectionUIValues	(	UI_Value *	sel_type,
		UI_Value *	sel_rule,
		UI_Value *	sel_style,
		UI_Value *	sel_visible,
		UI_Value *	sel_full,
		UI_Value *	locate_always,
		UI_Value *	finished
	)

void OP3D_InputSelector::setUndoWorker

(

OP3D_InputSelectorUndoWorker *

worker = 0

)

void OP3D_InputSelector::setValidForPickFilter	(	void *	data,
		OP3D_ValidForPickFilter	filter
	)

virtual void OP3D_InputSelector::setViewer

(

BM_View *

viewer

)

[virtual]

Reimplemented from OP3D_InputSelectorBase.

virtual void OP3D_InputSelector::startSelecting

(

bool

copy_cooked_selection = true

)

[virtual]

Reimplemented from OP3D_InputSelectorBase.

Reimplemented in MSS_JoinSelector, and MSS_PeltSelector.

virtual void OP3D_InputSelector::stopSelecting

(

)

[virtual]

Reimplemented from OP3D_InputSelectorBase.

virtual OP_Node* OP3D_InputSelector::switchToChosenOp

(

OP_Node *

parent

)

[protected, virtual]

Reimplemented from OP3D_InputSelectorBase.

void OP3D_InputSelector::useAsteriskToSelectAll

(

bool

onoff

)

[inline]

Definition at line 104 of file OP3D_InputSelector.h.

bool OP3D_InputSelector::useAsteriskToSelectAll

(

)

const [inline]

Definition at line 102 of file OP3D_InputSelector.h.

void OP3D_InputSelector::usePrimsInEdgeSelections

(

bool

use_prims

)

[inline]

Definition at line 117 of file OP3D_InputSelector.h.

bool OP3D_InputSelector::willHandleKeyEvent

(

UI_Event *

event

)

---

Friends And Related Function Documentation

friend class OP3D_InputSelectorUndo [friend]

Definition at line 455 of file OP3D_InputSelector.h.

---

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

• OP3D/OP3D_InputSelector.h