REFERENCE MANUAL
#include <hps.h>
Public Member Functions | |
void | Assign (MouseState const &in_that) |
bool | Equals (MouseState const &in_that) const |
MouseEvent | GetActiveEvent () const |
MouseButtons | GetButtons () const |
KeyArray | GetEventPath () const |
WindowKey | GetEventSource () const |
WindowPoint | GetLocation () const |
ModifierKeys | GetModifierKeys () const |
MouseState () | |
MouseState (MouseState const &in_that) | |
MouseState (MouseState &&in_that) | |
Type | ObjectType () const |
bool | operator!= (MouseState const &in_that) const |
MouseState & | operator= (MouseState &&in_that) |
MouseState & | operator= (MouseState const &in_that) |
bool | operator== (MouseState const &in_that) const |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The MouseState class represents the state of the mouse or similar pointer device for a particular event.
MouseState::MouseState | ( | ) |
The default constructor creates an empty MouseState object.
MouseState::MouseState | ( | MouseState const & | in_that | ) |
The copy constructor creates a new MouseState object that contains the same settings as the source MouseState.
in_that | The source MouseState to copy. |
MouseState::MouseState | ( | MouseState && | in_that | ) |
The move constructor creates a MouseState by transferring the underlying impl of the rvalue reference to this MouseState thereby avoiding a copy and allocation.
in_that | An rvalue reference to a MouseState to take the impl from. |
void MouseState::Assign | ( | MouseState const & | in_that | ) |
Copies the source MouseState into this MouseState.
in_that | The source MouseState to copy. |
bool MouseState::Equals | ( | MouseState const & | in_that | ) | const |
Check if the source MouseState is equivalent to this MouseState.
in_kit | The source MouseState to compare to this MouseState. |
MouseEvent MouseState::GetActiveEvent | ( | ) | const |
Get the active event for this MouseState. This will throw an exception if there is no active action for this MouseState.
MouseButtons MouseState::GetButtons | ( | ) | const |
Get the current state of the mouse buttons immediately after the active event.
Referenced by Operator::IsMouseTriggered().
KeyArray MouseState::GetEventPath | ( | ) | const |
Get the relevant list of keys up to the window which had focus when the mouse represented by this MouseState underwent the active action. This will throw an exception if there is no event path for this MouseState.
WindowKey MouseState::GetEventSource | ( | ) | const |
Get the window which had focus when the mouse represented by this MouseState underwent the active action. This will throw an exception if there is no event source for this MouseState.
WindowPoint MouseState::GetLocation | ( | ) | const |
Get the current mouse position.
ModifierKeys MouseState::GetModifierKeys | ( | ) | const |
Get an object representing the state of modifier keys for this TouchState.
Referenced by Operator::IsMouseTriggered().
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
bool MouseState::operator!= | ( | MouseState const & | in_that | ) | const |
Check if the source MouseState is not equivalent to this MouseState.
in_kit | The source MouseState to compare to this MouseState. |
MouseState& MouseState::operator= | ( | MouseState && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this MouseState thereby avoiding a copy.
in_that | An rvalue reference to a MouseState to take the impl from. |
MouseState& MouseState::operator= | ( | MouseState const & | in_that | ) |
Copies the source MouseState into this MouseState.
in_that | The source MouseState to copy. |
bool MouseState::operator== | ( | MouseState const & | in_that | ) | const |
Check if the source MouseState is equivalent to this MouseState.
in_kit | The source MouseState to compare to this MouseState. |