Interface to manipulate the mouse cursor. More...

#include <nirtcpp/core/engine/ICursorControl.hpp>

Inheritance diagram for nirt::gui::ICursorControl:

Collaboration diagram for nirt::gui::ICursorControl:

Public Member Functions
virtual void	setVisible (bool visible)=0
	Changes the visible state of the mouse cursor.

virtual bool	isVisible () const =0
	Returns if the cursor is currently visible.

virtual void	setPosition (const core::position2d< f32 > &pos)=0
	Sets the new position of the cursor.

virtual void	setPosition (f32 x, f32 y)=0
	Sets the new position of the cursor.

virtual void	setPosition (const core::position2d< s32 > &pos)=0
	Sets the new position of the cursor.

virtual void	setPosition (s32 x, s32 y)=0
	Sets the new position of the cursor.

virtual const core::position2d< s32 > &	getPosition (bool updateCursor=true)=0
	Returns the current position of the mouse cursor.

virtual core::position2d< f32 >	getRelativePosition (bool updateCursor=true)=0
	Returns the current position of the mouse cursor.

virtual void	setReferenceRect (core::rect< s32 > *rect=0)=0
	Sets an absolute reference rect for setting and retrieving the cursor position.

virtual void	setActiveIcon (ECURSOR_ICON iconId)
	Sets the active cursor icon.

virtual ECURSOR_ICON	getActiveIcon () const
	Gets the currently active icon.

virtual ECURSOR_ICON	addIcon (const gui::SCursorSprite &icon)
	Add a custom sprite as cursor icon.

virtual void	changeIcon (ECURSOR_ICON iconId, const gui::SCursorSprite &sprite)
	replace a cursor icon.

virtual core::dimension2di	getSupportedIconSize () const
	Return a system-specific size which is supported for cursors. Larger icons will fail, smaller icons might work.

virtual void	setPlatformBehavior (ECURSOR_PLATFORM_BEHAVIOR behavior)
	Set platform specific behavior flags.

virtual ECURSOR_PLATFORM_BEHAVIOR	getPlatformBehavior () const
	Return platform specific behavior.

Public Member Functions inherited from nirt::IReferenceCounted
	IReferenceCounted ()
	Constructor.

virtual	~IReferenceCounted ()
	Destructor.

void	grab () const
	Grabs the object. Increments the reference counter by one.

bool	drop () const
	Drops the object. Decrements the reference counter by one.

s32	getReferenceCount () const
	Get the reference count.

const c8 *	getDebugName () const
	Returns the debug name of the object.

Additional Inherited Members
Protected Member Functions inherited from nirt::IReferenceCounted
void	setDebugName (const c8 *newName)
	Sets the debug name of the object.

Detailed Description

Interface to manipulate the mouse cursor.

Member Function Documentation

◆ addIcon()

virtual ECURSOR_ICON nirt::gui::ICursorControl::addIcon ( const gui::SCursorSprite & icon )

inlinevirtual

Add a custom sprite as cursor icon.

Returns: Identification for the icon

◆ changeIcon()

virtual void nirt::gui::ICursorControl::changeIcon	(	ECURSOR_ICON	iconId,
		const gui::SCursorSprite &	sprite
	)

inlinevirtual

replace a cursor icon.

Changing cursor icons is so far only supported on Win32 and Linux Note that this only changes the icons within your application, system cursors outside your application will not be affected.

◆ getPlatformBehavior()

virtual ECURSOR_PLATFORM_BEHAVIOR nirt::gui::ICursorControl::getPlatformBehavior ( ) const

inlinevirtual

Return platform specific behavior.

Returns: Behavior set by setPlatformBehavior or ECPB_NONE for platforms not implementing specific behaviors.

◆ getPosition()

virtual const core::position2d< s32 > & nirt::gui::ICursorControl::getPosition ( bool updateCursor = true )

pure virtual

Returns the current position of the mouse cursor.

Parameters

updateCursor When true ask system/OS for current cursor position. When false return the last known (buffered) position ( this is useful to check what has become of a setPosition call with float numbers).

Returns: Returns the current position of the cursor. The returned position is the position of the mouse cursor in pixel units.

◆ getRelativePosition()

virtual core::position2d< f32 > nirt::gui::ICursorControl::getRelativePosition ( bool updateCursor = true )

pure virtual

Returns the current position of the mouse cursor.

Parameters

updateCursor When true ask system/OS for current cursor position. When false return the last known (buffered) position (this is useful to check what has become of a setPosition call with float numbers and is often different from the values you passed in setPosition).

Returns: Returns the current position of the cursor. The returned position is a value between (0.0f, 0.0f) and (1.0f, 1.0f), where (0.0f, 0.0f) is the top left corner and (1.0f, 1.0f) is the bottom right corner of the render window.

◆ isVisible()

virtual bool nirt::gui::ICursorControl::isVisible ( ) const

pure virtual

Returns if the cursor is currently visible.

Returns: True if the cursor flag is set to visible, false if not.

◆ setActiveIcon()

virtual void nirt::gui::ICursorControl::setActiveIcon ( ECURSOR_ICON iconId )

inlinevirtual

Sets the active cursor icon.

Setting cursor icons is so far only supported on Win32 and Linux

◆ setPosition() [1/4]

virtual void nirt::gui::ICursorControl::setPosition ( const core::position2d< f32 > & pos )

pure virtual

Sets the new position of the cursor.

The position must be between (0.0f, 0.0f) and (1.0f, 1.0f), where (0.0f, 0.0f) is the top left corner and (1.0f, 1.0f) is the bottom right corner of the render window.

Parameters

pos	New position of the cursor.

◆ setPosition() [2/4]

virtual void nirt::gui::ICursorControl::setPosition ( const core::position2d< s32 > & pos )

pure virtual

Sets the new position of the cursor.

Parameters

pos	New position of the cursor. The coordinates are pixel units.

◆ setPosition() [3/4]

virtual void nirt::gui::ICursorControl::setPosition	(	f32	x,
		f32	y
	)

pure virtual

Sets the new position of the cursor.

The position must be between (0.0f, 0.0f) and (1.0f, 1.0f), where (0.0f, 0.0f) is the top left corner and (1.0f, 1.0f) is the bottom right corner of the render window.

Parameters

x	New x-coord of the cursor.
y	New x-coord of the cursor.

◆ setPosition() [4/4]

virtual void nirt::gui::ICursorControl::setPosition	(	s32	x,
		s32	y
	)

pure virtual

Sets the new position of the cursor.

Parameters

x	New x-coord of the cursor. The coordinates are pixel units.
y	New y-coord of the cursor. The coordinates are pixel units.

◆ setReferenceRect()

virtual void nirt::gui::ICursorControl::setReferenceRect ( core::rect< s32 > * rect = 0 )

pure virtual

Sets an absolute reference rect for setting and retrieving the cursor position.

If this rect is set, the cursor position is not being calculated relative to the rendering window but to this rect. You can set the rect pointer to 0 to disable this feature again. This feature is useful when rendering into parts of foreign windows for example in an editor.

Parameters

rect	A pointer to an reference rectangle or 0 to disable the reference rectangle.

◆ setVisible()

virtual void nirt::gui::ICursorControl::setVisible ( bool visible )

pure virtual

Changes the visible state of the mouse cursor.

Parameters

visible The new visible state. If true, the cursor will be visible, if false, it will be invisible.

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

include/nirtcpp/core/engine/ICursorControl.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addIcon()

◆ changeIcon()

◆ getPlatformBehavior()

◆ getPosition()

◆ getRelativePosition()

◆ isVisible()

◆ setActiveIcon()

◆ setPosition() [1/4]

◆ setPosition() [2/4]

◆ setPosition() [3/4]

◆ setPosition() [4/4]

◆ setReferenceRect()

◆ setVisible()