Loading...
Searching...
No Matches
Input::Mouse Class Reference
#include <mouse.h>
Detailed Description
An input handler which represents a mouse for polling.
- Copyright
- (C) 2007 Radon Labs GmbH (C) 2013-2020 Individual contributors, see AUTHORS file
Inherits Base::MouseBase.
Private Member Functions | |
| __DeclareClass (Mouse) | |
Additional Inherited Members | |
 Public Member Functions inherited from Base::MouseBase | |
| MouseBase () | |
| constructor | |
| virtual | ~MouseBase () |
| destructor | |
| virtual void | BeginCapture () |
| capture input to this event handler | |
| virtual void | EndCapture () |
| end input capturing to this event handler | |
| bool | ButtonPressed (Input::MouseButton::Code btn) const |
| return true if button is currently pressed | |
| bool | ButtonDown (Input::MouseButton::Code btn) const |
| return true if button was pushed down at least once in current frame | |
| bool | ButtonUp (Input::MouseButton::Code btn) const |
| return true if button was released at least once in current frame | |
| bool | ButtonDoubleClicked (Input::MouseButton::Code btn) const |
| return true if a button has been double clicked | |
| bool | WheelForward () const |
| return true if mouse wheel rotated forward | |
| bool | WheelBackward () const |
| return true if mouse wheel rotated backward | |
| const Math::vec2 & | GetPixelPosition () const |
| get current absolute mouse position (in pixels) | |
| const Math::vec2 & | GetScreenPosition () const |
| get current screen space mouse position (0.0 .. 1.0) | |
| const Math::vec2 & | GetMovement () const |
| get mouse movement | |
| virtual void | LockToPosition (bool locked, Math::vec2 &position) |
| locks the mouse to a screen position (0.0 .. 1.0) | |
| bool | IsLocked () const |
| return true if the mouse is locked | |
| Public Member Functions inherited from Input::InputHandler | |
| InputHandler () | |
| constructor | |
| virtual | ~InputHandler () |
| destructor | |
| bool | IsAttached () const |
| return true if the input handler is currently attached | |
| bool | IsCapturing () const |
| return true if this input handler captures input | |
| Public Member Functions inherited from Core::RefCounted | |
| RefCounted () | |
| constructor | |
| int | GetRefCount () const |
| get the current refcount | |
| void | AddRef () |
| increment refcount by one | |
| void | Release () |
| decrement refcount and destroy object if refcount is zero | |
| bool | IsInstanceOf (const Rtti &rtti) const |
| return true if this object is instance of given class | |
| bool | IsInstanceOf (const Util::String &className) const |
| return true if this object is instance of given class by string | |
| bool | IsInstanceOf (const Util::FourCC &classFourCC) const |
| return true if this object is instance of given class by fourcc | |
| bool | IsA (const Rtti &rtti) const |
| return true if this object is instance of given class, or a derived class | |
| bool | IsA (const Util::String &rttiName) const |
| return true if this object is instance of given class, or a derived class, by string | |
| bool | IsA (const Util::FourCC &rttiFourCC) const |
| return true if this object is instance of given class, or a derived class, by fourcc | |
| const Util::String & | GetClassName () const |
| get the class name | |
| Util::FourCC | GetClassFourCC () const |
| get the class FourCC code | |
| Static Public Member Functions inherited from Core::RefCounted | |
| static void | DumpRefCountingLeaks () |
| dump refcounting leaks, call at end of application (NEBULA_DEBUG builds only!) | |
| Protected Member Functions inherited from Base::MouseBase | |
| virtual void | OnAttach () |
| called when the handler is attached to the input server | |
| virtual void | OnBeginFrame () |
| called on InputServer::BeginFrame() | |
| virtual bool | OnEvent (const Input::InputEvent &inputEvent) |
| called when an input event should be processed | |
| virtual void | OnObtainCapture () |
| called when input handler obtains capture | |
| virtual void | OnReleaseCapture () |
| called when input handler looses capture | |
| virtual void | OnReset () |
| reset the input handler | |
| Protected Member Functions inherited from Input::InputHandler | |
| virtual void | OnRemove () |
| called when the handler is removed from the input server | |
| virtual void | OnEndFrame () |
| called on InputServer::EndFrame(); | |
| Protected Member Functions inherited from Core::RefCounted | |
| virtual | ~RefCounted () |
| destructor (called when refcount reaches zero) | |
| Protected Attributes inherited from Input::InputHandler | |
| bool | isAttached |
| bool | isCapturing |
Member Function Documentation
◆ __DeclareClass()
|
private |
The documentation for this class was generated from the following file:
- /github/workspace/code/input/input/mouse.h