SDL mouse backend implementing eve::mouse::Mouse. 更多...

#include <Mouse.h>

类 eve::mouse::sdl::Mouse 继承关系图:

Public 成员函数
	Mouse ()
	Constructs the SDL mouse module with default cursor state.

virtual	~Mouse ()
	Releases cached system cursors.

eve::mouse::Cursor *	newCursor (eve::image::ImageData *data, int hotx, int hoty) override
	Builds a custom cursor from image pixels with hotspot (hotx, hoty).

eve::mouse::Cursor *	getSystemCursor (std::string cursortype) override
	Returns a named system cursor (e.g. "arrow", "ibeam"); may cache.

void	setCursor (eve::mouse::Cursor *cursor) override
	Installs a cursor as the active OS cursor.

void	setCursor () override
	Installs a cursor as the active OS cursor.

eve::mouse::Cursor *	getCursor () const override
	Currently installed cursor, or null for the default.

bool	isCursorSupported () const override
	True when the platform supports software/hardware cursors.

double	getX () const override
	Cursor X in window logical coordinates.

double	getY () const override
	Cursor Y in window logical coordinates.

void	getPosition (double &x, double &y) const override
	Writes cursor position in window logical coordinates.

void	setX (double x) override
	Warps the cursor X while keeping Y.

void	setY (double y) override
	Warps the cursor Y while keeping X.

void	setPosition (double x, double y) override
	Warps the cursor to a logical window position.

void	setVisible (bool visible) override
	Shows or hides the OS cursor.

bool	isDown (const std::vector< int > &buttons) const override
	True if any listed mouse button index is currently down.

bool	isVisible () const override
	True when the OS cursor is visible.

void	setGrabbed (bool grab) override
	Confines the cursor to the window when grab is true.

bool	isGrabbed () const override
	True when cursor grab is active.

bool	setRelativeMode (bool relative) override
	Enables relative mouse mode (hidden cursor, motion deltas).

bool	getRelativeMode () const override
	True when relative mouse mode is active.

double	getMovementX () override
	Pixel delta since the last getMovementX() (also latches Y for getMovementY).

double	getMovementY () const override
	Pixel delta latched by the most recent getMovementX(); call X then Y each frame.

Public 成员函数继承自 eve::mouse::Mouse
	Module_REG (Mouse)

float	getWheelX () const
	Horizontal scroll from the latest platform pump; event-thread read, non-consuming.

float	getWheelY () const
	Vertical scroll from the latest platform pump; event-thread read, non-consuming.

Public 成员函数继承自 eve::Module
virtual	~Module ()
	Module.

virtual std::string	getName () const =0
	Returns the name.

详细描述

SDL mouse backend implementing eve::mouse::Mouse.

在文件 Mouse.h 第 11 行定义.

构造及析构函数说明

◆ Mouse()

eve::mouse::sdl::Mouse::Mouse ( )

Constructs the SDL mouse module with default cursor state.

在文件 Mouse.cpp 第 25 行定义.

◆ ~Mouse()

eve::mouse::sdl::Mouse::~Mouse ( )

virtual

Releases cached system cursors.

重载 eve::mouse::Mouse .

在文件 Mouse.cpp 第 33 行定义.

引用了 c , 以及 setCursor().

成员函数说明

◆ getCursor()

eve::mouse::Cursor * eve::mouse::sdl::Mouse::getCursor ( ) const

overridevirtual

Currently installed cursor, or null for the default.

实现了 eve::mouse::Mouse.

在文件 Mouse.cpp 第 77 行定义.

◆ getMovementX()

double eve::mouse::sdl::Mouse::getMovementX ( )

overridevirtual

Pixel delta since the last getMovementX() (also latches Y for getMovementY).

实现了 eve::mouse::Mouse.

在文件 Mouse.cpp 第 210 行定义.

引用了 x , 以及 y.

◆ getMovementY()

double eve::mouse::sdl::Mouse::getMovementY ( ) const

overridevirtual

Pixel delta latched by the most recent getMovementX(); call X then Y each frame.

实现了 eve::mouse::Mouse.

在文件 Mouse.cpp 第 218 行定义.

◆ getPosition()

void eve::mouse::sdl::Mouse::getPosition	(	double &	x,
		double &	y
	)		const

overridevirtual

Writes cursor position in window logical coordinates.

实现了 eve::mouse::Mouse.

在文件 Mouse.cpp 第 110 行定义.

引用了 x , 以及 y.

◆ getRelativeMode()

bool eve::mouse::sdl::Mouse::getRelativeMode ( ) const

overridevirtual

True when relative mouse mode is active.

实现了 eve::mouse::Mouse.

在文件 Mouse.cpp 第 205 行定义.

◆ getSystemCursor()

eve::mouse::Cursor * eve::mouse::sdl::Mouse::getSystemCursor ( std::string cursortype )

overridevirtual

Returns a named system cursor (e.g. "arrow", "ibeam"); may cache.

实现了 eve::mouse::Mouse.

在文件 Mouse.cpp 第 49 行定义.

引用了 cursor.

◆ getX()

double eve::mouse::sdl::Mouse::getX ( ) const

overridevirtual

Cursor X in window logical coordinates.

实现了 eve::mouse::Mouse.

在文件 Mouse.cpp 第 88 行定义.

引用了 dx , 以及 x.

被这些函数引用 setY().

◆ getY()

double eve::mouse::sdl::Mouse::getY ( ) const

overridevirtual

Cursor Y in window logical coordinates.

实现了 eve::mouse::Mouse.

在文件 Mouse.cpp 第 99 行定义.

引用了 dy , 以及 y.

被这些函数引用 setX().

◆ isCursorSupported()

bool eve::mouse::sdl::Mouse::isCursorSupported ( ) const

overridevirtual

True when the platform supports software/hardware cursors.

实现了 eve::mouse::Mouse.

在文件 Mouse.cpp 第 83 行定义.

◆ isDown()

bool eve::mouse::sdl::Mouse::isDown ( const std::vector< int > & buttons ) const

overridevirtual

True if any listed mouse button index is currently down.

实现了 eve::mouse::Mouse.

在文件 Mouse.cpp 第 153 行定义.

◆ isGrabbed()

bool eve::mouse::sdl::Mouse::isGrabbed ( ) const

overridevirtual

True when cursor grab is active.

实现了 eve::mouse::Mouse.

在文件 Mouse.cpp 第 192 行定义.

◆ isVisible()

bool eve::mouse::sdl::Mouse::isVisible ( ) const

overridevirtual

True when the OS cursor is visible.

实现了 eve::mouse::Mouse.

在文件 Mouse.cpp 第 181 行定义.

◆ newCursor()

eve::mouse::Cursor * eve::mouse::sdl::Mouse::newCursor	(	eve::image::ImageData *	data,
		int	hotx,
		int	hoty
	)

overridevirtual

Builds a custom cursor from image pixels with hotspot (hotx, hoty).

实现了 eve::mouse::Mouse.

在文件 Mouse.cpp 第 44 行定义.

◆ setCursor() [1/2]

void eve::mouse::sdl::Mouse::setCursor ( )

overridevirtual

Installs a cursor as the active OS cursor.

实现了 eve::mouse::Mouse.

在文件 Mouse.cpp 第 71 行定义.

被这些函数引用 ~Mouse().

◆ setCursor() [2/2]

void eve::mouse::sdl::Mouse::setCursor ( eve::mouse::Cursor * cursor )

overridevirtual

Installs a cursor as the active OS cursor.

实现了 eve::mouse::Mouse.

在文件 Mouse.cpp 第 65 行定义.

引用了 cursor.

◆ setGrabbed()

void eve::mouse::sdl::Mouse::setGrabbed ( bool grab )

overridevirtual

Confines the cursor to the window when grab is true.

实现了 eve::mouse::Mouse.

在文件 Mouse.cpp 第 186 行定义.

◆ setPosition()

void eve::mouse::sdl::Mouse::setPosition	(	double	x,
		double	y
	)

overridevirtual

Warps the cursor to a logical window position.

实现了 eve::mouse::Mouse.

在文件 Mouse.cpp 第 120 行定义.

引用了 handle, x , 以及 y.

被这些函数引用 setX() , 以及 setY().

◆ setRelativeMode()

bool eve::mouse::sdl::Mouse::setRelativeMode ( bool relative )

overridevirtual

Enables relative mouse mode (hidden cursor, motion deltas).

实现了 eve::mouse::Mouse.

在文件 Mouse.cpp 第 200 行定义.

引用了 relative.

◆ setVisible()

void eve::mouse::sdl::Mouse::setVisible ( bool visible )

overridevirtual

Shows or hides the OS cursor.

实现了 eve::mouse::Mouse.

在文件 Mouse.cpp 第 148 行定义.

引用了 visible.

◆ setX()

void eve::mouse::sdl::Mouse::setX ( double x )

overridevirtual

Warps the cursor X while keeping Y.

实现了 eve::mouse::Mouse.

在文件 Mouse.cpp 第 138 行定义.

引用了 getY(), setPosition() , 以及 x.

◆ setY()

void eve::mouse::sdl::Mouse::setY ( double y )

overridevirtual

Warps the cursor Y while keeping X.

实现了 eve::mouse::Mouse.

在文件 Mouse.cpp 第 143 行定义.

引用了 getX(), setPosition() , 以及 y.

该类的文档由以下文件生成:

src/modules/mouse/sdl/Mouse.h
src/modules/mouse/sdl/Mouse.cpp

Public 成员函数

详细描述

构造及析构函数说明

◆ Mouse()

◆ ~Mouse()

成员函数说明

◆ getCursor()

◆ getMovementX()

◆ getMovementY()

◆ getPosition()

◆ getRelativeMode()

◆ getSystemCursor()

◆ getX()

◆ getY()

◆ isCursorSupported()

◆ isDown()

◆ isGrabbed()

◆ isVisible()

◆ newCursor()

◆ setCursor() [1/2]

◆ setCursor() [2/2]

◆ setGrabbed()

◆ setPosition()

◆ setRelativeMode()

◆ setVisible()

◆ setX()

◆ setY()