#include <Mouse.h>

Inherited by DirectInputMouse, WWMouseClass, and Win32Mouse.

Public Types
enum	MouseCursor { INVALID_MOUSE_CURSOR = -1 , NONE = 0 , FIRST_CURSOR , NORMAL = FIRST_CURSOR , ARROW , SCROLL , CROSS , MOVETO , ATTACKMOVETO , ATTACK_OBJECT , FORCE_ATTACK_OBJECT , FORCE_ATTACK_GROUND , BUILD_PLACEMENT , INVALID_BUILD_PLACEMENT , GENERIC_INVALID , SELECTING , ENTER_FRIENDLY , ENTER_AGGRESSIVELY , SET_RALLY_POINT , GET_REPAIRED , GET_HEALED , DO_REPAIR , RESUME_CONSTRUCTION , CAPTUREBUILDING , SNIPE_VEHICLE , LASER_GUIDED_MISSILES , TANKHUNTER_TNT_ATTACK , STAB_ATTACK , PLACE_REMOTE_CHARGE , PLACE_TIMED_CHARGE , DEFECTOR , DOCK , FIRE_FLAME , FIRE_BOMB , PLACE_BEACON , DISGUISE_AS_VEHICLE , WAYPOINT , OUTRANGE , STAB_ATTACK_INVALID , PLACE_CHARGE_INVALID , HACK , PARTICLE_UPLINK_CANNON , NUM_MOUSE_CURSORS }

enum	RedrawMode { RM_WINDOWS =0 , RM_W3D , RM_POLYGON , RM_DX8 , RM_MAX }

Public Member Functions
	Mouse (void)

virtual	~Mouse (void)

virtual void	parseIni (void)
	parse ini settings associated with mouse (do this before init()).

virtual void	init (void)
	init mouse, extend this functionality, do not replace

virtual void	reset (void)
	Reset the system.

virtual void	update (void)
	update the state of the mouse position and buttons

virtual void	initCursorResources (void)=0
	needed so Win32 cursors can load resources before D3D device created.

virtual void	createStreamMessages (void)

virtual void	draw (void)
	draw the mouse

virtual void	setPosition (Int x, Int y)
	set the mouse position

virtual void	setCursor (MouseCursor cursor)=0
	set mouse cursor

virtual void	capture (void)=0
	capture the mouse

virtual void	releaseCapture (void)=0
	release mouse capture

const MouseIO *	getMouseStatus (void)
	get current mouse status

Int	getCursorTooltipDelay ()

void	setCursorTooltipDelay (Int delay)

void	setCursorTooltip (UnicodeString tooltip, Int tooltipDelay=-1, const RGBColor *color=NULL, Real width=1.0f)
	set tooltip string at cursor

void	setMouseText (UnicodeString text, const RGBAColorInt color, const RGBAColorInt dropColor)
	set the cursor text, NOT the tooltip text

virtual void	setMouseLimits (void)
	update the limit extents the mouse can move in

MouseCursor	getMouseCursor (void)
	get the current mouse cursor image type

virtual void	setRedrawMode (RedrawMode mode)
	set cursor drawing method.

virtual RedrawMode	getRedrawMode (void)

virtual void	setVisibility (Bool visible)

Bool	getVisibility (void)

void	drawTooltip (void)
	draw the tooltip text

void	drawCursorText (void)
	draw the mouse cursor text

Int	getCursorIndex (const AsciiString &name)

void	resetTooltipDelay (void)

void	mouseNotifyResolutionChange (void)

Bool	isClick (const ICoord2D anchor, const ICoord2D dest, UnsignedInt previousMouseClick, UnsignedInt currentMouseClick)

virtual	~Mouse (void)

virtual void	Set_Cursor (int xhotspot, int yhotspot, ShapeSet const *cursor, int shape)=0

virtual void	Hide_Mouse (void)=0

virtual void	Show_Mouse (void)=0

virtual void	Release_Mouse (void)=0

virtual void	Capture_Mouse (void)=0

virtual bool	Is_Captured (void) const =0

virtual void	Conditional_Hide_Mouse (Rect region)=0

virtual void	Conditional_Show_Mouse (void)=0

virtual int	Get_Mouse_State (void) const =0

virtual int	Get_Mouse_X (void) const =0

virtual int	Get_Mouse_Y (void) const =0

virtual void	Set_Mouse_XY (int xpos, int ypos)=0

virtual void	Draw_Mouse (Surface *scr, bool issidebarsurface=false)=0

virtual void	Erase_Mouse (Surface *scr, bool issidebarsurface=false)=0

virtual void	Convert_Coordinate (int &x, int &y) const =0

Public Member Functions inherited from SubsystemInterface
	SubsystemInterface ()

virtual	~SubsystemInterface ()

virtual void	postProcessLoad ()

void	UPDATE (void)

void	DRAW (void)

AsciiString	getName (void)

void	setName (AsciiString name)

Public Attributes
CursorInfo	m_cursorInfo [NUM_MOUSE_CURSORS]

AsciiString	m_tooltipFontName
	tooltip font

Int	m_tooltipFontSize
	tooltip font

Bool	m_tooltipFontIsBold
	tooltip font

Bool	m_tooltipAnimateBackground
	animate the background with the text

Int	m_tooltipFillTime
	milliseconds to animate tooltip

Int	m_tooltipDelayTime
	milliseconds to wait before showing tooltip

Real	m_tooltipWidth
	default tooltip width in screen width %

Real	m_lastTooltipWidth

RGBAColorInt	m_tooltipColorText

RGBAColorInt	m_tooltipColorHighlight

RGBAColorInt	m_tooltipColorShadow

RGBAColorInt	m_tooltipColorBackground

RGBAColorInt	m_tooltipColorBorder

RedrawMode	m_currentRedrawMode
	mouse cursor drawing method

Bool	m_useTooltipAltTextColor
	draw tooltip text with house colors?

Bool	m_useTooltipAltBackColor
	draw tooltip backgrounds with house colors?

Bool	m_adjustTooltipAltColor
	adjust house colors (darker/brighter) for tooltips?

Bool	m_orthoCamera
	use an ortho camera for 3D cursors?

Real	m_orthoZoom
	uniform zoom to apply to 3D cursors when using ortho cameras

UnsignedInt	m_dragTolerance

UnsignedInt	m_dragTolerance3D

UnsignedInt	m_dragToleranceMS

Static Public Attributes
static const char *	RedrawModeName [RM_MAX]

Protected Types
enum	{ NUM_MOUSE_EVENTS = 256 }

Protected Member Functions
virtual UnsignedByte	getMouseEvent (MouseIO *result, Bool flush)=0
	you must implement getting a buffered mouse event from you device here

void	updateMouseData ()
	update the mouse with the current device data

void	processMouseEvent (Int eventToProcess)
	combine mouse events into final data

void	checkForDrag (void)
	check for mouse drag

void	moveMouse (Int x, Int y, Int relOrAbs)
	move mouse by delta or absolute

Protected Attributes
UnsignedByte	m_numButtons
	number of buttons on this mouse

UnsignedByte	m_numAxes
	number of axes this mouse has

Bool	m_forceFeedback
	set to TRUE if mouse supprots force feedback

UnicodeString	m_tooltipString
	tooltip text

DisplayString *	m_tooltipDisplayString
	tooltipDisplayString

Bool	m_displayTooltip

Bool	m_isTooltipEmpty

MouseIO	m_mouseEvents [NUM_MOUSE_EVENTS]
	for event list

MouseIO	m_currMouse
	for current mouse data

MouseIO	m_prevMouse
	for previous mouse data

Int	m_minX
	mouse is locked to this region

Int	m_maxX
	mouse is locked to this region

Int	m_minY
	mouse is locked to this region

Int	m_maxY
	mouse is locked to this region

UnsignedInt	m_inputFrame
	frame input was gathered on

UnsignedInt	m_deadInputFrame
	Frame which last input occured.

Bool	m_inputMovesAbsolute

Bool	m_visible

MouseCursor	m_currentCursor
	current mouse cursor

DisplayString *	m_cursorTextDisplayString
	text to display on the cursor (if specified)

RGBAColorInt	m_cursorTextColor
	color of the cursor text

RGBAColorInt	m_cursorTextDropColor
	color of the cursor text drop shadow

Int	m_tooltipDelay
	millisecond delay for tooltips

Int	m_highlightPos

UnsignedInt	m_highlightUpdateStart

UnsignedInt	m_stillTime

RGBAColorInt	m_tooltipTextColor

RGBAColorInt	m_tooltipBackColor

Int	m_eventsThisFrame

Protected Attributes inherited from SubsystemInterface
AsciiString	m_name

Detailed Description

Class interface for working with a mouse pointing device

Definition at line 145 of file Mouse.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerator
NUM_MOUSE_EVENTS

Definition at line 336 of file Mouse.h.

◆ MouseCursor

enum Mouse::MouseCursor

If you update this enum make sure you update CursorININames[]

Enumerator
INVALID_MOUSE_CURSOR
NONE
FIRST_CURSOR
NORMAL
ARROW
SCROLL
CROSS
MOVETO
ATTACKMOVETO
ATTACK_OBJECT
FORCE_ATTACK_OBJECT
FORCE_ATTACK_GROUND
BUILD_PLACEMENT
INVALID_BUILD_PLACEMENT
GENERIC_INVALID
SELECTING
ENTER_FRIENDLY
ENTER_AGGRESSIVELY
SET_RALLY_POINT
GET_REPAIRED
GET_HEALED
DO_REPAIR
RESUME_CONSTRUCTION
CAPTUREBUILDING
SNIPE_VEHICLE
LASER_GUIDED_MISSILES
TANKHUNTER_TNT_ATTACK
STAB_ATTACK
PLACE_REMOTE_CHARGE
PLACE_TIMED_CHARGE
DEFECTOR
DOCK
FIRE_FLAME
FIRE_BOMB
PLACE_BEACON
DISGUISE_AS_VEHICLE
WAYPOINT
OUTRANGE
STAB_ATTACK_INVALID
PLACE_CHARGE_INVALID
HACK
PARTICLE_UPLINK_CANNON
NUM_MOUSE_CURSORS

Definition at line 153 of file Mouse.h.

◆ RedrawMode

enum Mouse::RedrawMode

Enumerator
RM_WINDOWS
RM_W3D
RM_POLYGON
RM_DX8
RM_MAX

Definition at line 224 of file Mouse.h.

Constructor & Destructor Documentation

◆ Mouse()

Mouse::Mouse ( void )

Definition at line 449 of file Mouse.cpp.

◆ ~Mouse() [1/2]

Mouse::~Mouse ( void )

virtual

Definition at line 542 of file Mouse.cpp.

◆ ~Mouse() [2/2]

virtual Mouse::~Mouse ( void )

inlinevirtual

Definition at line 68 of file xmouse.h.

Member Function Documentation

◆ capture()

virtual void Mouse::capture ( void )

pure virtual

capture the mouse

Implemented in DirectInputMouse, and Win32Mouse.

◆ Capture_Mouse()

virtual void Mouse::Capture_Mouse ( void )

pure virtual

Implemented in WWMouseClass.

◆ checkForDrag()

void Mouse::checkForDrag ( void )

protected

check for mouse drag

Check for mouse drag

Definition at line 366 of file Mouse.cpp.

◆ Conditional_Hide_Mouse()

virtual void Mouse::Conditional_Hide_Mouse ( Rect region )

pure virtual

Implemented in WWMouseClass.

◆ Conditional_Show_Mouse()

virtual void Mouse::Conditional_Show_Mouse ( void )

pure virtual

Implemented in WWMouseClass.

◆ Convert_Coordinate()

virtual void Mouse::Convert_Coordinate	(	int &	x,
		int &	y ) const

pure virtual

Implemented in WWMouseClass.

◆ createStreamMessages()

void Mouse::createStreamMessages ( void )

virtual

given state of device, create messages and put them on the stream for the raw state.

Given the current state of this input device, turn the raw input data into raw stream messages and place those messages on the stream. NOTE that the click messages replace up messages in the mouse, so we are going to propagate those click messages in addition to up messages

Definition at line 666 of file Mouse.cpp.

◆ draw()

void Mouse::draw ( void )

virtual

draw the mouse

Draw the mouse

Reimplemented from SubsystemInterface.

Reimplemented in W3DMouse.

Definition at line 971 of file Mouse.cpp.

◆ Draw_Mouse()

virtual void Mouse::Draw_Mouse	(	Surface *	scr,
		bool	issidebarsurface = false )

pure virtual

Implemented in WWMouseClass.

◆ drawCursorText()

void Mouse::drawCursorText ( void )

draw the mouse cursor text

Draw the cursor text at the mouse position. Note that this is NOT the tooltip text

Definition at line 1052 of file Mouse.cpp.

◆ drawTooltip()

void Mouse::drawTooltip ( void )

draw the tooltip text

Draw the mouse tooltip if one is set

Todo: : Still need to put in display logic so it puts the tool tips in a visable position on the edge of the screen

Definition at line 987 of file Mouse.cpp.

◆ Erase_Mouse()

virtual void Mouse::Erase_Mouse	(	Surface *	scr,
		bool	issidebarsurface = false )

pure virtual

Implemented in WWMouseClass.

◆ Get_Mouse_State()

virtual int Mouse::Get_Mouse_State ( void ) const

pure virtual

Implemented in WWMouseClass.

◆ Get_Mouse_X()

virtual int Mouse::Get_Mouse_X ( void ) const

pure virtual

Implemented in WWMouseClass.

◆ Get_Mouse_Y()

virtual int Mouse::Get_Mouse_Y ( void ) const

pure virtual

Implemented in WWMouseClass.

◆ getCursorIndex()

Int Mouse::getCursorIndex ( const AsciiString & name )

Todo: This is silly to have to define these names from INI in the code ... that should be changed (CBD)

Definition at line 1084 of file Mouse.cpp.

◆ getCursorTooltipDelay()

Int Mouse::getCursorTooltipDelay ( )

inline

Definition at line 264 of file Mouse.h.

◆ getMouseCursor()

MouseCursor Mouse::getMouseCursor ( void )

inline

get the current mouse cursor image type

Definition at line 270 of file Mouse.h.

◆ getMouseEvent()

virtual UnsignedByte Mouse::getMouseEvent	(	MouseIO *	result,
		Bool	flush )

protectedpure virtual

you must implement getting a buffered mouse event from you device here

Implemented in DirectInputMouse, and Win32Mouse.

◆ getMouseStatus()

const MouseIO * Mouse::getMouseStatus ( void )

inline

get current mouse status

Definition at line 262 of file Mouse.h.

◆ getRedrawMode()

virtual RedrawMode Mouse::getRedrawMode ( void )

inlinevirtual

Definition at line 272 of file Mouse.h.

◆ getVisibility()

Bool Mouse::getVisibility ( void )

inline

Definition at line 274 of file Mouse.h.

◆ Hide_Mouse()

virtual void Mouse::Hide_Mouse ( void )

pure virtual

Implemented in WWMouseClass.

◆ init()

void Mouse::init ( void )

virtual

init mouse, extend this functionality, do not replace

Initialize the mouse

Implements SubsystemInterface.

Reimplemented in DirectInputMouse, W3DMouse, and Win32Mouse.

Definition at line 565 of file Mouse.cpp.

◆ initCursorResources()

virtual void Mouse::initCursorResources ( void )

pure virtual

needed so Win32 cursors can load resources before D3D device created.

Implemented in Win32Mouse.

◆ Is_Captured()

virtual bool Mouse::Is_Captured ( void ) const

pure virtual

Implemented in WWMouseClass.

◆ isClick()

Bool Mouse::isClick	(	const ICoord2D *	anchor,
		const ICoord2D *	dest,
		UnsignedInt	previousMouseClick,
		UnsignedInt	currentMouseClick )

Check for mouse click, using allowed drag forgiveness

Definition at line 396 of file Mouse.cpp.

◆ mouseNotifyResolutionChange()

void Mouse::mouseNotifyResolutionChange ( void )

Tell mouse system display resolution changed.

Definition at line 604 of file Mouse.cpp.

◆ moveMouse()

void Mouse::moveMouse	(	Int	x,
		Int	y,
		Int	relOrAbs )

protected

move mouse by delta or absolute

Move the mouse in either relative or absolute coords

Definition at line 120 of file Mouse.cpp.

◆ parseIni()

void Mouse::parseIni ( void )

virtual

parse ini settings associated with mouse (do this before init()).

Had to move this out of main init() because I need this data to properly initialize the Win32 version of the mouse (by preloading resources before D3D device is created).

Definition at line 556 of file Mouse.cpp.

◆ processMouseEvent()

void Mouse::processMouseEvent ( Int index )

protected

combine mouse events into final data

Combine mouse events into the main mouse variables

Definition at line 191 of file Mouse.cpp.

◆ Release_Mouse()

virtual void Mouse::Release_Mouse ( void )

pure virtual

Implemented in WWMouseClass.

◆ releaseCapture()

virtual void Mouse::releaseCapture ( void )

pure virtual

release mouse capture

Implemented in DirectInputMouse, and Win32Mouse.

◆ reset()

void Mouse::reset ( void )

virtual

Reset the system.

Reset mouse system

@ todo Write Mouse::reset() if there needs to be anything here

Implements SubsystemInterface.

Reimplemented in DirectInputMouse, W3DMouse, and Win32Mouse.

Definition at line 635 of file Mouse.cpp.

◆ resetTooltipDelay()

void Mouse::resetTooltipDelay ( void )

Definition at line 978 of file Mouse.cpp.

◆ Set_Cursor()

virtual void Mouse::Set_Cursor	(	int	xhotspot,
		int	yhotspot,
		ShapeSet const *	cursor,
		int	shape )

pure virtual

Implemented in WWMouseClass.

◆ Set_Mouse_XY()

virtual void Mouse::Set_Mouse_XY	(	int	xpos,
		int	ypos )

pure virtual

Implemented in WWMouseClass.

◆ setCursor()

void Mouse::setCursor ( MouseCursor cursor )

pure virtual

set mouse cursor

Implemented in DirectInputMouse, W3DMouse, and Win32Mouse.

Definition at line 1162 of file Mouse.cpp.

◆ setCursorTooltip()

void Mouse::setCursorTooltip	(	UnicodeString	tooltip,
		Int	delay = -1,
		const RGBColor *	color = NULL,
		Real	width = 1.0f )

set tooltip string at cursor

Set the string to display at the cursor for the tooltip

Definition at line 834 of file Mouse.cpp.

◆ setCursorTooltipDelay()

void Mouse::setCursorTooltipDelay ( Int delay )

inline

Definition at line 265 of file Mouse.h.

◆ setMouseLimits()

void Mouse::setMouseLimits ( void )

virtual

update the limit extents the mouse can move in

This default implemtation of SetMouseLimits will just set the limiting
rectangle to be the width and height of the game display with the origin in the upper left at (0,0). However, if the game is running in a windowed mode then these limits should reflect the SCREEN coords that the mouse is allowed to move in. Also, if the game is in a window you may want to adjust for any title bar available in the operating system. For system specific limits and windows etc, just override this function in the device implementation of the mouse

Reimplemented in DirectInputMouse.

Definition at line 953 of file Mouse.cpp.

◆ setMouseText()

void Mouse::setMouseText	(	UnicodeString	text,
		const RGBAColorInt *	color,
		const RGBAColorInt *	dropColor )

set the cursor text, NOT the tooltip text

Set the text for the mouse cursor ... note that this is NOT the tooltip text we can set to be at the mouse position

Definition at line 912 of file Mouse.cpp.

◆ setPosition()

void Mouse::setPosition	(	Int	x,
		Int	y )

virtual

set the mouse position

Move the mouse to the position

Reimplemented in DirectInputMouse.

Definition at line 935 of file Mouse.cpp.

◆ setRedrawMode()

virtual void Mouse::setRedrawMode ( RedrawMode mode )

inlinevirtual

set cursor drawing method.

Reimplemented in W3DMouse.

Definition at line 271 of file Mouse.h.

◆ setVisibility()

virtual void Mouse::setVisibility ( Bool visible )

inlinevirtual

Reimplemented in Win32Mouse.

Definition at line 273 of file Mouse.h.

◆ Show_Mouse()

virtual void Mouse::Show_Mouse ( void )

pure virtual

Implemented in WWMouseClass.

◆ update()

void Mouse::update ( void )

virtual

update the state of the mouse position and buttons

Update the states of the mouse position and buttons

Implements SubsystemInterface.

Reimplemented in DirectInputMouse, and Win32Mouse.

Definition at line 649 of file Mouse.cpp.

◆ updateMouseData()

void Mouse::updateMouseData ( )

protected

update the mouse with the current device data

Get the current information for the mouse from the device

Definition at line 149 of file Mouse.cpp.

Member Data Documentation

◆ m_adjustTooltipAltColor

Bool Mouse::m_adjustTooltipAltColor

adjust house colors (darker/brighter) for tooltips?

Definition at line 302 of file Mouse.h.

◆ m_currentCursor

MouseCursor Mouse::m_currentCursor

protected

current mouse cursor

Definition at line 356 of file Mouse.h.

◆ m_currentRedrawMode

RedrawMode Mouse::m_currentRedrawMode

mouse cursor drawing method

Definition at line 299 of file Mouse.h.

◆ m_currMouse

MouseIO Mouse::m_currMouse

protected

for current mouse data

Definition at line 338 of file Mouse.h.

◆ m_cursorInfo

CursorInfo Mouse::m_cursorInfo[NUM_MOUSE_CURSORS]

Definition at line 236 of file Mouse.h.

◆ m_cursorTextColor

RGBAColorInt Mouse::m_cursorTextColor

protected

color of the cursor text

Definition at line 359 of file Mouse.h.

◆ m_cursorTextDisplayString

DisplayString* Mouse::m_cursorTextDisplayString

protected

text to display on the cursor (if specified)

Definition at line 358 of file Mouse.h.

◆ m_cursorTextDropColor

RGBAColorInt Mouse::m_cursorTextDropColor

protected

color of the cursor text drop shadow

Definition at line 360 of file Mouse.h.

◆ m_deadInputFrame

UnsignedInt Mouse::m_deadInputFrame

protected

Frame which last input occured.

Definition at line 347 of file Mouse.h.

◆ m_displayTooltip

Bool Mouse::m_displayTooltip

protected

when the mouse has been still long enough this will be set to TRUE indicating it's Ok to fire off a tooltip

Definition at line 332 of file Mouse.h.

◆ m_dragTolerance

UnsignedInt Mouse::m_dragTolerance

Definition at line 305 of file Mouse.h.

◆ m_dragTolerance3D

UnsignedInt Mouse::m_dragTolerance3D

Definition at line 306 of file Mouse.h.

◆ m_dragToleranceMS

UnsignedInt Mouse::m_dragToleranceMS

Definition at line 307 of file Mouse.h.

◆ m_eventsThisFrame

Int Mouse::m_eventsThisFrame

protected

Definition at line 370 of file Mouse.h.

◆ m_forceFeedback

Bool Mouse::m_forceFeedback

protected

set to TRUE if mouse supprots force feedback

Definition at line 328 of file Mouse.h.

◆ m_highlightPos

Int Mouse::m_highlightPos

protected

Definition at line 364 of file Mouse.h.

◆ m_highlightUpdateStart

UnsignedInt Mouse::m_highlightUpdateStart

protected

Definition at line 365 of file Mouse.h.

◆ m_inputFrame

UnsignedInt Mouse::m_inputFrame

protected

frame input was gathered on

Definition at line 346 of file Mouse.h.

◆ m_inputMovesAbsolute

Bool Mouse::m_inputMovesAbsolute

protected

if TRUE, when processing mouse position chanages the movement will be done treating the coords as ABSOLUTE positions and NOT relative coordinate changes

Definition at line 349 of file Mouse.h.

◆ m_isTooltipEmpty

Bool Mouse::m_isTooltipEmpty

protected

Definition at line 334 of file Mouse.h.

◆ m_lastTooltipWidth

Real Mouse::m_lastTooltipWidth

Definition at line 293 of file Mouse.h.

◆ m_maxX

Int Mouse::m_maxX

protected

mouse is locked to this region

Definition at line 342 of file Mouse.h.

◆ m_maxY

Int Mouse::m_maxY

protected

mouse is locked to this region

Definition at line 344 of file Mouse.h.

◆ m_minX

Int Mouse::m_minX

protected

mouse is locked to this region

Definition at line 341 of file Mouse.h.

◆ m_minY

Int Mouse::m_minY

protected

mouse is locked to this region

Definition at line 343 of file Mouse.h.

◆ m_mouseEvents

MouseIO Mouse::m_mouseEvents[NUM_MOUSE_EVENTS]

protected

for event list

Definition at line 337 of file Mouse.h.

◆ m_numAxes

UnsignedByte Mouse::m_numAxes

protected

number of axes this mouse has

Definition at line 327 of file Mouse.h.

◆ m_numButtons

UnsignedByte Mouse::m_numButtons

protected

number of buttons on this mouse

Definition at line 326 of file Mouse.h.

◆ m_orthoCamera

Bool Mouse::m_orthoCamera

use an ortho camera for 3D cursors?

Definition at line 303 of file Mouse.h.

◆ m_orthoZoom

Real Mouse::m_orthoZoom

uniform zoom to apply to 3D cursors when using ortho cameras

Definition at line 304 of file Mouse.h.

◆ m_prevMouse

MouseIO Mouse::m_prevMouse

protected

for previous mouse data

Definition at line 339 of file Mouse.h.

◆ m_stillTime

UnsignedInt Mouse::m_stillTime

protected

Definition at line 366 of file Mouse.h.

◆ m_tooltipAnimateBackground

Bool Mouse::m_tooltipAnimateBackground

animate the background with the text

Definition at line 289 of file Mouse.h.

◆ m_tooltipBackColor

RGBAColorInt Mouse::m_tooltipBackColor

protected

Definition at line 368 of file Mouse.h.

◆ m_tooltipColorBackground

RGBAColorInt Mouse::m_tooltipColorBackground

Definition at line 297 of file Mouse.h.

◆ m_tooltipColorBorder

RGBAColorInt Mouse::m_tooltipColorBorder

Definition at line 298 of file Mouse.h.

◆ m_tooltipColorHighlight

RGBAColorInt Mouse::m_tooltipColorHighlight

Definition at line 295 of file Mouse.h.

◆ m_tooltipColorShadow

RGBAColorInt Mouse::m_tooltipColorShadow

Definition at line 296 of file Mouse.h.

◆ m_tooltipColorText

RGBAColorInt Mouse::m_tooltipColorText

Definition at line 294 of file Mouse.h.

◆ m_tooltipDelay

Int Mouse::m_tooltipDelay

protected

millisecond delay for tooltips

Definition at line 362 of file Mouse.h.

◆ m_tooltipDelayTime

Int Mouse::m_tooltipDelayTime

milliseconds to wait before showing tooltip

Definition at line 291 of file Mouse.h.

◆ m_tooltipDisplayString

DisplayString* Mouse::m_tooltipDisplayString

protected

tooltipDisplayString

Definition at line 331 of file Mouse.h.

◆ m_tooltipFillTime

Int Mouse::m_tooltipFillTime

milliseconds to animate tooltip

Definition at line 290 of file Mouse.h.

◆ m_tooltipFontIsBold

Bool Mouse::m_tooltipFontIsBold

tooltip font

Definition at line 288 of file Mouse.h.

◆ m_tooltipFontName

AsciiString Mouse::m_tooltipFontName

tooltip font

Definition at line 286 of file Mouse.h.

◆ m_tooltipFontSize

Int Mouse::m_tooltipFontSize

tooltip font

Definition at line 287 of file Mouse.h.

◆ m_tooltipString

UnicodeString Mouse::m_tooltipString

protected

tooltip text

Definition at line 330 of file Mouse.h.

◆ m_tooltipTextColor

RGBAColorInt Mouse::m_tooltipTextColor

protected

Definition at line 367 of file Mouse.h.

◆ m_tooltipWidth

Real Mouse::m_tooltipWidth

default tooltip width in screen width %

Definition at line 292 of file Mouse.h.

◆ m_useTooltipAltBackColor

Bool Mouse::m_useTooltipAltBackColor

draw tooltip backgrounds with house colors?

Definition at line 301 of file Mouse.h.

◆ m_useTooltipAltTextColor

Bool Mouse::m_useTooltipAltTextColor

draw tooltip text with house colors?

Definition at line 300 of file Mouse.h.

◆ m_visible

Bool Mouse::m_visible

protected

Definition at line 354 of file Mouse.h.

◆ RedrawModeName

const char * Mouse::RedrawModeName

static

Initial value:

= {
    "Mouse:Windows",
    "Mouse:W3D",
    "Mouse:Poly",
    "Mouse:DX8",
}

Definition at line 59 of file Mouse.h.

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

Code/GameEngine/Include/GameClient/Mouse.h
Code/Libraries/Source/WWVegas/WWLib/xmouse.h
Code/GameEngine/Source/GameClient/Input/Mouse.cpp

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ MouseCursor

◆ RedrawMode

Constructor & Destructor Documentation

◆ Mouse()

◆ ~Mouse() [1/2]

◆ ~Mouse() [2/2]

Member Function Documentation

◆ capture()

◆ Capture_Mouse()

◆ checkForDrag()

◆ Conditional_Hide_Mouse()

◆ Conditional_Show_Mouse()

◆ Convert_Coordinate()

◆ createStreamMessages()

◆ draw()

◆ Draw_Mouse()

◆ drawCursorText()

◆ drawTooltip()

◆ Erase_Mouse()

◆ Get_Mouse_State()

◆ Get_Mouse_X()

◆ Get_Mouse_Y()

◆ getCursorIndex()

◆ getCursorTooltipDelay()

◆ getMouseCursor()

◆ getMouseEvent()

◆ getMouseStatus()

◆ getRedrawMode()

◆ getVisibility()

◆ Hide_Mouse()

◆ init()

◆ initCursorResources()

◆ Is_Captured()

◆ isClick()

◆ mouseNotifyResolutionChange()

◆ moveMouse()

◆ parseIni()

◆ processMouseEvent()

◆ Release_Mouse()

◆ releaseCapture()

◆ reset()

◆ resetTooltipDelay()

◆ Set_Cursor()

◆ Set_Mouse_XY()

◆ setCursor()

◆ setCursorTooltip()

◆ setCursorTooltipDelay()

◆ setMouseLimits()

◆ setMouseText()

◆ setPosition()

◆ setRedrawMode()

◆ setVisibility()

◆ Show_Mouse()

◆ update()

◆ updateMouseData()

Member Data Documentation

◆ m_adjustTooltipAltColor

◆ m_currentCursor

◆ m_currentRedrawMode

◆ m_currMouse

◆ m_cursorInfo

◆ m_cursorTextColor

◆ m_cursorTextDisplayString

◆ m_cursorTextDropColor

◆ m_deadInputFrame

◆ m_displayTooltip

◆ m_dragTolerance

◆ m_dragTolerance3D

◆ m_dragToleranceMS

◆ m_eventsThisFrame