castor3d::MouseEvent Class Reference

#include <MouseEvent.hpp>

Inheritance diagram for castor3d::MouseEvent:

Collaboration diagram for castor3d::MouseEvent:

Public Member Functions
	MouseEvent (MouseEventType type, castor::Position const &position, MouseButton button=MouseButton::eCount)
	Constructor.
MouseEventType	getMouseEventType () const
MouseButton	getButton () const
castor::Position const &	getPosition () const
Public Member Functions inherited from castor3d::UserInputEvent
C3D_API	UserInputEvent (UserInputEvent &&)=default
C3D_API	UserInputEvent (UserInputEvent const &)=default
C3D_API UserInputEvent &	operator= (UserInputEvent &&)=default
C3D_API UserInputEvent &	operator= (UserInputEvent const &)=default
	UserInputEvent (UserInputEventType type)
	Constructor.
virtual C3D_API	~UserInputEvent () noexcept=default
	Destructor.
UserInputEventType	getEventType () const

Constructor & Destructor Documentation

MouseEvent()

castor3d::MouseEvent::MouseEvent ( MouseEventType type, castor::Position const & position, MouseButton button = MouseButton::eCount )

inline

Constructor.

Parameters

[in]	type	The mouse event type.
[in]	position	The position, of wheel or mouse, depending on the event type.
[in]	button	The mouse button.

Member Function Documentation

getButton()

MouseButton castor3d::MouseEvent::getButton ( ) const

inline

Returns

The mouse button.

getMouseEventType()

MouseEventType castor3d::MouseEvent::getMouseEventType ( ) const

inline

Returns

The mouse event type.

getPosition()

castor::Position const & castor3d::MouseEvent::getPosition ( ) const

inline

Returns

The position (wheel or mouse, depending on mouse event type).

---

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

• Castor3D/Event/UserInput/MouseEvent.hpp