LLTool Class Reference

#include <lltool.h>

Inheritance diagram for LLTool:

[legend]Collaboration diagram for LLTool:

[legend]List of all members.

Public Member Functions
	LLTool (const LLString &name, LLToolComposite *composite=NULL)
virtual	~LLTool ()
virtual BOOL	isView ()
virtual BOOL	handleMouseDown (S32 x, S32 y, MASK mask)
virtual BOOL	handleMouseUp (S32 x, S32 y, MASK mask)
virtual BOOL	handleHover (S32 x, S32 y, MASK mask)
virtual BOOL	handleScrollWheel (S32 x, S32 y, S32 clicks)
virtual BOOL	handleDoubleClick (S32 x, S32 y, MASK mask)
virtual BOOL	handleRightMouseDown (S32 x, S32 y, MASK mask)
virtual BOOL	handleRightMouseUp (S32 x, S32 y, MASK mask)
virtual BOOL	handleToolTip (S32 x, S32 y, LLString &msg, LLRect *sticky_rect_screen)
virtual void	screenPointToLocal (S32 screen_x, S32 screen_y, S32 *local_x, S32 *local_y) const
virtual void	localPointToScreen (S32 local_x, S32 local_y, S32 *screen_x, S32 *screen_y) const
virtual const LLString &	getName () const
virtual LLViewerObject *	getEditingObject ()
virtual LLVector3d	getEditingPointGlobal ()
virtual BOOL	isEditing ()
virtual void	stopEditing ()
virtual BOOL	clipMouseWhenDown ()
virtual void	handleSelect ()
virtual void	handleDeselect ()
virtual LLTool *	getOverrideTool (MASK mask)
virtual BOOL	isAlwaysRendered ()
virtual void	render ()
virtual void	draw ()
virtual BOOL	handleKey (KEY key, MASK mask)
void	setMouseCapture (BOOL b)
BOOL	hasMouseCapture ()
virtual void	onMouseCaptureLost ()
Static Public Attributes
static const LLString	sNameNull
Protected Attributes
LLToolComposite *	mComposite
LLString	mName

---

Detailed Description

Definition at line 46 of file lltool.h.

---

Constructor & Destructor Documentation

LLTool::LLTool	(	const LLString &	name,
		LLToolComposite *	composite = NULL
	)

Definition at line 52 of file lltool.cpp.

Referenced by LLToolCompGun::LLToolCompGun().

LLTool::~LLTool

(

)

[virtual]

Definition at line 58 of file lltool.cpp.

References gFocusMgr, hasMouseCapture(), llendl, llwarns, and LLFocusMgr::removeMouseCaptureWithoutCallback().

---

Member Function Documentation

virtual BOOL LLTool::clipMouseWhenDown

(

)

[inline, virtual]

Reimplemented in LLToolComposite, and LLToolGun.

Definition at line 79 of file lltool.h.

References TRUE.

Referenced by LLToolComposite::clipMouseWhenDown(), LLViewerWindow::handleMouseDown(), LLViewerWindow::handleMouseUp(), LLViewerWindow::handleRightMouseDown(), and LLViewerWindow::handleRightMouseUp().

void LLTool::draw

(

)

[virtual]

Reimplemented in LLToolComposite, LLToolGrab, LLToolGun, and LLToolSelectRect.

Definition at line 149 of file lltool.cpp.

Referenced by LLViewerWindow::draw(), and LLToolComposite::draw().

virtual LLViewerObject* LLTool::getEditingObject

(

)

[inline, virtual]

Reimplemented in LLToolComposite, and LLToolGrab.

Definition at line 74 of file lltool.h.

References NULL.

Referenced by LLToolComposite::getEditingObject(), LLVOAvatar::idleUpdate(), isEditing(), and LLSelectMgr::removeObjectFromSelections().

virtual LLVector3d LLTool::getEditingPointGlobal

(

)

[inline, virtual]

Reimplemented in LLToolComposite, and LLToolGrab.

Definition at line 75 of file lltool.h.

Referenced by LLToolComposite::getEditingPointGlobal(), LLVOAvatar::idleUpdate(), and LLSelectMgr::updateSelectionCenter().

virtual const LLString& LLTool::getName

(

void

)

const [inline, virtual]

Implements LLMouseHandler.

Definition at line 71 of file lltool.h.

References mName.

Referenced by LLToolCamera::pickCallback().

LLTool * LLTool::getOverrideTool

(

MASK

mask

)

[virtual]

Reimplemented in LLToolCompTranslate, LLToolCompScale, LLToolCompRotate, LLToolCamera, LLToolGun, and LLToolPie.

Definition at line 162 of file lltool.cpp.

References gToolCamera, MASK_ALT, and NULL.

Referenced by LLToolMgr::getCurrentTool(), LLToolPie::getOverrideTool(), LLToolCompRotate::getOverrideTool(), LLToolCompScale::getOverrideTool(), and LLToolCompTranslate::getOverrideTool().

virtual void LLTool::handleDeselect

(

)

[inline, virtual]

Reimplemented in LLManip, LLManipRotate, LLManipScale, LLManipTranslate, LLToolBrushLand, LLToolComposite, LLToolCompGun, LLToolDragAndDrop, LLToolFace, LLToolCamera, LLToolGrab, LLToolGun, LLToolObjPicker, LLToolPie, LLToolPlacer, LLToolSelect, and LLToolSelectLand.

Definition at line 82 of file lltool.h.

Referenced by LLToolMgr::getCurrentTool(), LLToolObjPicker::handleDeselect(), LLToolComposite::handleDeselect(), and LLToolComposite::setCurrentTool().

BOOL LLTool::handleDoubleClick	(	S32	x,
		S32	y,
		MASK	mask
	)			[virtual]

Implements LLMouseHandler.

Reimplemented in LLToolComposite, LLToolCompInspect, LLToolCompTranslate, LLToolCompScale, LLToolCompRotate, LLToolCompCreate, LLToolCompGun, LLToolFace, LLToolGrab, LLToolIndividual, LLToolPie, LLToolSelect, and LLToolSelectLand.

Definition at line 107 of file lltool.cpp.

References FALSE.

Referenced by LLViewerWindow::handleDoubleClick(), and LLToolSelect::handleDoubleClick().

BOOL LLTool::handleHover	(	S32	x,
		S32	y,
		MASK	mask
	)			[virtual]

Implements LLMouseHandler.

Reimplemented in LLManip, LLManipRotate, LLManipScale, LLManipTranslate, LLToolTexEyedropper, LLToolBrushLand, LLToolComposite, LLToolCompTranslate, LLToolCompScale, LLToolCompRotate, LLToolCompGun, LLToolDragAndDrop, LLToolCamera, LLToolGrab, LLToolGun, LLToolObjPicker, LLToolPie, LLToolPipette, LLToolPlacer, LLToolSelectLand, and LLToolSelectRect.

Definition at line 92 of file lltool.cpp.

References LLViewerWindow::getWindow(), gViewerWindow, lldebugst, llendl, LLWindow::setCursor(), TRUE, and UI_CURSOR_ARROW.

Referenced by LLToolSelectRect::handleHover(), LLToolComposite::handleHover(), LLToolCompGun::handleHover(), LLToolCompRotate::handleHover(), LLToolCompScale::handleHover(), LLToolCompTranslate::handleHover(), LLSnapshotFloaterView::handleHover(), and LLViewerWindow::handlePerFrameHover().

BOOL LLTool::handleKey	(	KEY	key,
		MASK	mask
	)			[virtual]

Reimplemented in LLToolComposite, and LLToolDragAndDrop.

Definition at line 157 of file lltool.cpp.

References FALSE.

Referenced by LLToolComposite::handleKey().

BOOL LLTool::handleMouseDown	(	S32	x,
		S32	y,
		MASK	mask
	)			[virtual]

Implements LLMouseHandler.

Reimplemented in LLManipRotate, LLManipScale, LLManipTranslate, LLToolTexEyedropper, LLToolBrushLand, LLToolComposite, LLToolCompInspect, LLToolCompTranslate, LLToolCompScale, LLToolCompRotate, LLToolCompCreate, LLToolCompGun, LLToolFace, LLToolCamera, LLToolGrab, LLToolGun, LLToolIndividual, LLToolObjPicker, LLToolPie, LLToolPipette, LLToolSelect, LLToolSelectLand, and LLToolSelectRect.

Definition at line 68 of file lltool.cpp.

References AGENT_CONTROL_LBUTTON_DOWN, gAgent, gDebugClicks, llendl, llinfos, LLAgent::setControlFlags(), and TRUE.

Referenced by LLViewerWindow::handleMouseDown(), LLToolSelect::handleMouseDown(), LLToolObjPicker::handleMouseDown(), LLToolGrab::handleMouseDown(), LLToolCamera::handleMouseDown(), LLSnapshotFloaterView::handleMouseDown(), LLToolPie::pickAndShowMenu(), LLToolCompRotate::pickCallback(), and LLToolCompScale::pickCallback().

BOOL LLTool::handleMouseUp	(	S32	x,
		S32	y,
		MASK	mask
	)			[virtual]

Implements LLMouseHandler.

Reimplemented in LLManip, LLManipRotate, LLManipScale, LLManipTranslate, LLToolBrushLand, LLToolComposite, LLToolCompTranslate, LLToolCompScale, LLToolCompRotate, LLToolCompCreate, LLToolCompGun, LLToolDragAndDrop, LLToolCamera, LLToolGrab, LLToolObjPicker, LLToolPie, LLToolPipette, LLToolSelect, LLToolSelectLand, and LLToolSelectRect.

Definition at line 80 of file lltool.cpp.

References AGENT_CONTROL_LBUTTON_UP, gAgent, gDebugClicks, llendl, llinfos, LLAgent::setControlFlags(), and TRUE.

Referenced by LLToolSelect::handleMouseUp(), LLToolPie::handleMouseUp(), LLToolObjPicker::handleMouseUp(), LLToolGrab::handleMouseUp(), LLToolComposite::handleMouseUp(), LLSnapshotFloaterView::handleMouseUp(), and LLToolCamera::releaseMouse().

BOOL LLTool::handleRightMouseDown	(	S32	x,
		S32	y,
		MASK	mask
	)			[virtual]

Implements LLMouseHandler.

Reimplemented in LLToolComposite, LLToolCompGun, and LLToolPie.

Definition at line 114 of file lltool.cpp.

References FALSE.

Referenced by LLViewerWindow::handleRightMouseDown(), LLToolComposite::handleRightMouseDown(), and LLToolPie::pickAndShowMenu().

BOOL LLTool::handleRightMouseUp	(	S32	x,
		S32	y,
		MASK	mask
	)			[virtual]

Implements LLMouseHandler.

Reimplemented in LLToolPie.

Definition at line 121 of file lltool.cpp.

References FALSE.

Referenced by LLToolPie::handleRightMouseUp().

BOOL LLTool::handleScrollWheel	(	S32	x,
		S32	y,
		S32	clicks
	)			[virtual]

Implements LLMouseHandler.

Reimplemented in LLToolComposite, and LLToolCompGun.

Definition at line 100 of file lltool.cpp.

References FALSE.

Referenced by LLToolComposite::handleScrollWheel().

virtual void LLTool::handleSelect

(

)

[inline, virtual]

Reimplemented in LLManip, LLManipRotate, LLManipScale, LLManipTranslate, LLToolBrushLand, LLToolComposite, LLToolCompGun, LLToolFace, LLToolCamera, LLToolGrab, LLToolGun, LLToolIndividual, LLToolObjPicker, LLToolPlacer, and LLToolSelectLand.

Definition at line 81 of file lltool.h.

Referenced by LLToolMgr::getCurrentTool(), LLToolObjPicker::handleSelect(), LLToolComposite::handleSelect(), and LLToolComposite::setCurrentTool().

BOOL LLTool::handleToolTip	(	S32	x,
		S32	y,
		LLString &	msg,
		LLRect *	sticky_rect_screen
	)			[virtual]

Implements LLMouseHandler.

Reimplemented in LLToolDragAndDrop, and LLToolPipette.

Definition at line 128 of file lltool.cpp.

References FALSE.

BOOL LLTool::hasMouseCapture

(

)

[virtual]

Implements LLMouseHandler.

Definition at line 152 of file lltool.cpp.

References LLFocusMgr::getMouseCapture(), gFocusMgr, and mComposite.

Referenced by LLToolSelectRect::draw(), LLFolderView::draw(), LLToolMgr::getCurrentTool(), LLToolSelect::handleDeselect(), LLToolPie::handleDeselect(), LLToolObjPicker::handleDeselect(), LLToolGrab::handleDeselect(), LLToolSelectRect::handleHover(), LLToolSelectLand::handleHover(), LLToolPipette::handleHover(), LLToolCamera::handleHover(), LLToolCompRotate::handleHover(), LLToolCompScale::handleHover(), LLToolCompTranslate::handleHover(), LLToolBrushLand::handleHover(), LLManipTranslate::handleHover(), LLManipScale::handleHover(), LLManipRotate::handleHover(), LLManip::handleHover(), LLToolGrab::handleHoverActive(), LLToolObjPicker::handleMouseDown(), LLToolSelectLand::handleMouseUp(), LLToolObjPicker::handleMouseUp(), LLToolGrab::handleMouseUp(), LLToolCamera::handleMouseUp(), LLToolDragAndDrop::handleMouseUp(), LLToolBrushLand::handleMouseUp(), LLManipTranslate::handleMouseUp(), LLManipScale::handleMouseUp(), LLManipRotate::handleMouseUp(), LLManip::handleMouseUp(), LLSnapshotLivePreview::onIdle(), LLToolCamera::pickCallback(), LLToolSelectLand::render(), setMouseCapture(), LLToolSelect::stopEditing(), LLToolPie::stopEditing(), LLToolGrab::stopEditing(), LLManipRotate::updateVisiblity(), and ~LLTool().

virtual BOOL LLTool::isAlwaysRendered

(

)

[inline, virtual]

Reimplemented in LLToolBrushLand, and LLToolSelectLand.

Definition at line 88 of file lltool.h.

References FALSE.

Referenced by LLViewerWindow::renderSelections().

virtual BOOL LLTool::isEditing

(

)

[inline, virtual]

Reimplemented in LLToolComposite, and LLToolGrab.

Definition at line 76 of file lltool.h.

References getEditingObject(), and NULL.

Referenced by LLAgent::getRenderState(), LLVOAvatar::idleUpdate(), LLToolComposite::isEditing(), and LLSelectMgr::updateSelectionCenter().

virtual BOOL LLTool::isView

(

)

[inline, virtual]

Implements LLMouseHandler.

Definition at line 54 of file lltool.h.

References FALSE.

virtual void LLTool::localPointToScreen	(	S32	local_x,
		S32	local_y,
		S32 *	screen_x,
		S32 *	screen_y
	)			const [inline, virtual]

Implements LLMouseHandler.

Reimplemented in LLToolComposite.

Definition at line 68 of file lltool.h.

Referenced by LLToolComposite::localPointToScreen().

virtual void LLTool::onMouseCaptureLost

(

)

[inline, virtual]

Implements LLMouseHandler.

Reimplemented in LLToolBrushLand, LLToolComposite, LLToolCompGun, LLToolDragAndDrop, LLToolCamera, LLToolGrab, LLToolObjPicker, LLToolPie, and LLToolSelect.

Definition at line 98 of file lltool.h.

Referenced by LLToolCompGun::onMouseCaptureLost(), and LLToolComposite::onMouseCaptureLost().

virtual void LLTool::render

(

)

[inline, virtual]

Reimplemented in LLManipRotate, LLManipScale, LLManipTranslate, LLToolBrushLand, LLToolComposite, LLToolCompTranslate, LLToolCompScale, LLToolCompRotate, LLToolFace, LLToolGrab, LLToolPie, and LLToolSelectLand.

Definition at line 90 of file lltool.h.

Referenced by LLToolComposite::render(), LLToolCompRotate::render(), LLToolCompScale::render(), LLToolCompTranslate::render(), and LLViewerWindow::renderSelections().

virtual void LLTool::screenPointToLocal	(	S32	screen_x,
		S32	screen_y,
		S32 *	local_x,
		S32 *	local_y
	)			const [inline, virtual]

Implements LLMouseHandler.

Reimplemented in LLToolComposite.

Definition at line 66 of file lltool.h.

Referenced by LLToolComposite::screenPointToLocal().

void LLTool::setMouseCapture

(

BOOL

b

)

Definition at line 135 of file lltool.cpp.

References gViewerWindow, hasMouseCapture(), mComposite, NULL, and LLViewerWindow::setMouseCapture().

Referenced by LLToolDragAndDrop::beginDrag(), LLToolDragAndDrop::beginMultiDrag(), LLToolDragAndDrop::endDrag(), LLToolSelect::handleDeselect(), LLToolPie::handleDeselect(), LLToolObjPicker::handleDeselect(), LLToolGrab::handleDeselect(), LLToolCompGun::handleDeselect(), LLToolGrab::handleHover(), LLToolCompGun::handleHover(), LLManipScale::handleHover(), LLManipRotate::handleHover(), LLManip::handleHover(), LLToolGrab::handleHoverActive(), LLToolSelectRect::handleMouseDown(), LLToolSelectLand::handleMouseDown(), LLToolPipette::handleMouseDown(), LLToolObjPicker::handleMouseDown(), LLToolCamera::handleMouseDown(), LLToolBrushLand::handleMouseDown(), LLManipTranslate::handleMouseDownOnPart(), LLManipScale::handleMouseDownOnPart(), LLManipRotate::handleMouseDownOnPart(), LLToolSelectRect::handleMouseUp(), LLToolSelectLand::handleMouseUp(), LLToolPipette::handleMouseUp(), LLToolObjPicker::handleMouseUp(), LLToolGrab::handleMouseUp(), LLToolCamera::handleMouseUp(), LLToolBrushLand::handleMouseUp(), LLManip::handleMouseUp(), LLToolGrab::handleObjectHit(), LLToolObjPicker::handleSelect(), LLToolCompGun::handleSelect(), LLToolPie::pickAndShowMenu(), LLToolGrab::pickCallback(), LLToolSelect::stopEditing(), LLToolPie::stopEditing(), and LLToolGrab::stopEditing().

virtual void LLTool::stopEditing

(

)

[inline, virtual]

Reimplemented in LLToolComposite, LLToolGrab, LLToolPie, and LLToolSelect.

Definition at line 77 of file lltool.h.

Referenced by LLSelectMgr::removeObjectFromSelections(), and LLToolComposite::stopEditing().

---

Member Data Documentation

LLToolComposite* LLTool::mComposite [protected]

Definition at line 101 of file lltool.h.

Referenced by hasMouseCapture(), LLToolCompGun::onMouseCaptureLost(), and setMouseCapture().

LLString LLTool::mName [protected]

Definition at line 102 of file lltool.h.

Referenced by getName().

const LLString LLTool::sNameNull [static]

Definition at line 105 of file lltool.h.

---

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

• lltool.h
• lltool.cpp

---