Difference between revisions of "Mouse (Chili Framework)"

From Chilipedia
Jump to: navigation, search
(→‎Position)
(→‎Event)
Line 53: Line 53:
  
 
Mouse click, wheel, and move events are held in a queue in <code>Mouse</code> in the order they occurred. These events are modeled with their own <code>class</code> because they're precious fucking little snowflakes. They store the type of event and the state of the mouse after the event occurred. You pull them out of the buffer with <code>Mouse::Read()</code>.
 
Mouse click, wheel, and move events are held in a queue in <code>Mouse</code> in the order they occurred. These events are modeled with their own <code>class</code> because they're precious fucking little snowflakes. They store the type of event and the state of the mouse after the event occurred. You pull them out of the buffer with <code>Mouse::Read()</code>.
 +
 +
=== Position ===
 +
<code>std::pair<int,int> Mouse::Event::GetPos() const</code><br />
 +
<code>int Mouse::Event::GetPosX() const</code><br />
 +
<code>int Mouse::Event::GetPosY() const</code><br />
 +
 +
Get the x and y coordinates at the time of the event. You can get them separately or as a sexy double date in the form of <code>std::pair</code> (see example below).
 +
 +
<syntaxhighlight lang="cpp" line="1" >
 +
const std::pair<int,int> p = e.GetPos();
 +
if( p.first > 100 && p.second > 100 )
 +
{
 +
// do something if x and y coords are above 100
 +
}
 +
</syntaxhighlight>
 +
 +
=== Buttons ===
 +
<code>bool Mouse::Event::LeftIsPressed() const</code><br />
 +
<code>bool Mouse::Event::RightIsPressed() const</code><br />
 +
 +
Get the state of the mouse buttons at the time of the event.
  
 
=== Type ===
 
=== Type ===
Line 71: Line 92:
  
 
Returns the type of the event.
 
Returns the type of the event.
−
 
−
=== Position ===
 
−
<code>std::pair<int,int> Mouse::Event::GetPos() const</code><br />
 
−
<code>int Mouse::Event::GetPosX() const</code><br />
 
−
<code>int Mouse::Event::GetPosY() const</code><br />
 
−
 
−
Get the x and y coordinates at the time of the event. You can get them separately or as a sexy double date in the form of <code>std::pair</code> (see example below).
 
−
 
−
<syntaxhighlight lang="cpp" line="1" >
 
−
const std::pair<int,int> p = e.GetPos();
 
−
if( p.first > 100 && p.second > 100 )
 
−
{
 
−
// do something if x and y coords are above 100
 
−
}
 
−
</syntaxhighlight>
 
  
 
=== IsValid ===
 
=== IsValid ===
−
<code>bool Keyboard::Event::IsValid() const</code><br />
+
<code>bool Mouse::Event::IsValid() const</code><br />
−
 
+
−
Returns <code>true</code> if the event is a valid event (reading from an empty buffer will return an invalid event object).
+
−
 
+
−
=== GetCode ===
+
−
<code>char Keyboard::Event::GetCode() const</code><br />
+
  
−
Gets the virtual key code of the key associated with the <code>Event</code> object.
+
Returns <code>true</code> if the event is a valid event (reading from an empty queue will return an invalid event object).
  
 
== See also ==
 
== See also ==
 
* The [[Chili Framework]]
 
* The [[Chili Framework]]

Revision as of 14:50, 14 July 2016

With Mouse, you can get the current state of the mouse keys and the pointer position, and you can pop mouse events out of an Event queue contained in Mouse. You can also check whether the mouse is in the window client region. Whopee. (Note: lives in MainWindow's belly.)

Example of Use

The following code reads mouse events from the queue and processes any left button presses. 

while( !wnd.mouse.IsEmpty() )
{
	const Mouse::Event e = wnd.mouse.Read();
	if( e.GetType() == Mouse::Event::LPress )
	{
		// respond to left mouse click event
	}
}

Members

KeyIsPressed

bool Keyboard::KeyIsPressed( unsigned char keycode ) const
Checks to see if a specific key is currently in the pressed state. The function parameter is the virtual key code of the key that you want to check.

ReadKey

Event Keyboard::ReadKey()
Pull a fresh Event object out of the key press/release event queue. Erases an event from the queue and returns a copy if there is a key press event in the queue. Returns an invalid Event object if the queue is empty.

KeyIsEmpty

bool Keyboard::KeyIsEmpty() const
Returns true if the key event queue is empty.

ReadChar

char Keyboard::ReadChar()
Pull a fresh character off of the character queue. Returns a '\0' (null) character if the queue is empty. See also: ReadKey vs. ReadChar.

CharIsEmpty

bool Keyboard::CharIsEmpty() const
Returns true if the character queue is empty.

Buffer Flushing Bullshit

void Keyboard::FlushKey()
void Keyboard::FlushChar()
void Keyboard::Flush()
These functions empty the respective queues. Flush() empties both in one fell swoop. It's like taking a pee and a poo at the same time.

Autorepeat Bullshit

void Keyboard::EnableAutorepeat()
void Keyboard::DisableAutorepeat()
bool Keyboard::AutorepeatIsEnabled() const
If you hhhhhhhhhhhhhhhhhold a key down for a while, it will start machine gunning events and characters into your queues like a motherfucker. You can disable that if it pisses you off.

Event

class Mouse::Event

Mouse click, wheel, and move events are held in a queue in Mouse in the order they occurred. These events are modeled with their own class because they're precious fucking little snowflakes. They store the type of event and the state of the mouse after the event occurred. You pull them out of the buffer with Mouse::Read().

Position

std::pair<int,int> Mouse::Event::GetPos() const
int Mouse::Event::GetPosX() const
int Mouse::Event::GetPosY() const

Get the x and y coordinates at the time of the event. You can get them separately or as a sexy double date in the form of std::pair (see example below). 

const std::pair<int,int> p = e.GetPos();
if( p.first > 100 && p.second > 100 )
{
	// do something if x and y coords are above 100
}

Buttons

bool Mouse::Event::LeftIsPressed() const
bool Mouse::Event::RightIsPressed() const

Get the state of the mouse buttons at the time of the event.

Type

enum Mouse::Event::Type

This represents the different types of events that can be recorded. The options are:

  • LPress
  • LRelease
  • RPress
  • RRelease
  • WheelUp
  • WheelDown
  • Move
  • Invalid

GetType

Type Mouse::Event::GetType() const

Returns the type of the event.

IsValid

bool Mouse::Event::IsValid() const

Returns true if the event is a valid event (reading from an empty queue will return an invalid event object).

See also

Retrieved from "https://wiki.planetchili.net/index.php?title=Mouse_(Chili_Framework)&oldid=236"