WMHierchClustDisplay::MainViewEventHandler Class Reference

Small event handler class to catch left mouse buttons clicks in the main view. More...

Inheritance diagram for WMHierchClustDisplay::MainViewEventHandler:

Collaboration diagram for WMHierchClustDisplay::MainViewEventHandler:

Public Types
typedef boost::signals2::signal< bool(WVector2f) >	mouseClickSignalType
	signal from a mouse button being clicked More...

Public Member Functions
bool	handle (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &)
	The OSG calls this function whenever a new event has occured. More...
void	subscribeLeftButtonPush (mouseClickSignalType::slot_type slot)
	Registers a function slot to LEFT BUTTON PUSH events. More...
void	subscribeRightButtonPush (mouseClickSignalType::slot_type slot)
	Registers a function slot to RIGHT BUTTON PUSH events. More...

Private Attributes
mouseClickSignalType	m_signalLeftButtonPush
	Signal used for notification of the LEFT BUTTON PUSH event. More...
mouseClickSignalType	m_signalRightButtonPush
	Signal used for notification of the RIGHT BUTTON PUSH event. More...

Detailed Description

Small event handler class to catch left mouse buttons clicks in the main view.

Definition at line 132 of file WMHierchClustDisplay.h.

Member Typedef Documentation

mouseClickSignalType

typedef boost::signals2::signal< bool ( WVector2f ) > WMHierchClustDisplay::MainViewEventHandler::mouseClickSignalType

signal from a mouse button being clicked

Definition at line 136 of file WMHierchClustDisplay.h.

Member Function Documentation

handle()

bool WMHierchClustDisplay::MainViewEventHandler::handle	(	const osgGA::GUIEventAdapter &	ea,
		osgGA::GUIActionAdapter &
	)

The OSG calls this function whenever a new event has occured.

Parameters

ea	Event class for storing GUI events such as mouse or keyboard interation etc.

Returns

true if the event was handled.

Definition at line 81 of file WMHierchClustDisplay.cpp.

References m_signalLeftButtonPush, and m_signalRightButtonPush.

subscribeLeftButtonPush()

void WMHierchClustDisplay::MainViewEventHandler::subscribeLeftButtonPush

(

mouseClickSignalType::slot_type

slot

)

Registers a function slot to LEFT BUTTON PUSH events.

Whenever the event occurs, the slot is called with current parameters.

Parameters

slot	Function object having the appropriate signature according to the used SignalType.

Definition at line 95 of file WMHierchClustDisplay.cpp.

subscribeRightButtonPush()

void WMHierchClustDisplay::MainViewEventHandler::subscribeRightButtonPush

(

mouseClickSignalType::slot_type

slot

)

Registers a function slot to RIGHT BUTTON PUSH events.

Whenever the event occurs, the slot is called with current parameters.

Parameters

slot	Function object having the appropriate signature according to the used SignalType.

Definition at line 100 of file WMHierchClustDisplay.cpp.

Member Data Documentation

m_signalLeftButtonPush

mouseClickSignalType WMHierchClustDisplay::MainViewEventHandler::m_signalLeftButtonPush

private

Signal used for notification of the LEFT BUTTON PUSH event.

Definition at line 165 of file WMHierchClustDisplay.h.

Referenced by handle().

m_signalRightButtonPush

mouseClickSignalType WMHierchClustDisplay::MainViewEventHandler::m_signalRightButtonPush

private

Signal used for notification of the RIGHT BUTTON PUSH event.

Definition at line 169 of file WMHierchClustDisplay.h.

Referenced by handle().

---

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

• WMHierchClustDisplay.h
• WMHierchClustDisplay.cpp