DART  6.10.1
dart::gui::osg::MouseEventHandler Class Referenceabstract

#include <MouseEventHandler.hpp>

Inheritance diagram for dart::gui::osg::MouseEventHandler:
dart::common::Subject dart::common::Observer dart::gui::osg::InteractiveFrameMouseEvent

Public Member Functions

 MouseEventHandler ()
 
virtual void update ()=0
 Overload this function to set behavior that will get triggered during a mouse event. More...
 

Protected Member Functions

void handleDestructionNotification (const Subject *_subject) override
 
void sendDestructionNotification () const
 Send a destruction notification to all Observers. More...
 
void addObserver (Observer *_observer) const
 Add an Observer to the list of Observers. More...
 
void removeObserver (Observer *_observer) const
 Remove an Observer from the list of Observers. More...
 
void receiveDestructionNotification (const Subject *_subject)
 Called whenever a Subject is destroyed (or sends out a destruction notification). More...
 
virtual void handleDestructionNotification (const Subject *_subject)
 Called by receiveDestructionNotification(). More...
 
void addSubject (const Subject *_subject)
 Add a Subject for this Observer. More...
 
void removeSubject (const Subject *_subject)
 Remove a Subject from this Observer. More...
 
void removeAllSubjects ()
 Remove all Subjects from this Observer. More...
 

Protected Attributes

DefaultEventHandlermEventHandler
 
std::set< Observer * > mObservers
 List of current Observers. More...
 
std::set< const Subject * > mSubjects
 List of current Subjects for this Observer. More...
 

Friends

class DefaultEventHandler
 

Constructor & Destructor Documentation

◆ MouseEventHandler()

dart::gui::osg::MouseEventHandler::MouseEventHandler ( )
inline

Member Function Documentation

◆ addObserver()

void dart::common::Subject::addObserver ( Observer _observer) const
protectedinherited

Add an Observer to the list of Observers.

◆ addSubject()

void dart::common::Observer::addSubject ( const Subject _subject)
protectedinherited

Add a Subject for this Observer.

◆ handleDestructionNotification() [1/2]

◆ handleDestructionNotification() [2/2]

void dart::gui::osg::MouseEventHandler::handleDestructionNotification ( const Subject _subject)
inlineoverrideprotected

◆ receiveDestructionNotification()

void dart::common::Observer::receiveDestructionNotification ( const Subject _subject)
protectedinherited

Called whenever a Subject is destroyed (or sends out a destruction notification).

Override handleDestructionNotification() in order to customize your class's response to destruction notifications.

◆ removeAllSubjects()

void dart::common::Observer::removeAllSubjects ( )
protectedinherited

Remove all Subjects from this Observer.

◆ removeObserver()

void dart::common::Subject::removeObserver ( Observer _observer) const
protectedinherited

Remove an Observer from the list of Observers.

◆ removeSubject()

void dart::common::Observer::removeSubject ( const Subject _subject)
protectedinherited

Remove a Subject from this Observer.

◆ sendDestructionNotification()

void dart::common::Subject::sendDestructionNotification ( ) const
protectedinherited

Send a destruction notification to all Observers.

This will cause all Observers to behave as if this Subject has been permanently deleted, so it should only be called when that behavior is desired.

◆ update()

virtual void dart::gui::osg::MouseEventHandler::update ( )
pure virtual

Overload this function to set behavior that will get triggered during a mouse event.

Implemented in dart::gui::osg::InteractiveFrameMouseEvent.

Friends And Related Function Documentation

◆ DefaultEventHandler

friend class DefaultEventHandler
friend

Member Data Documentation

◆ mEventHandler

DefaultEventHandler* dart::gui::osg::MouseEventHandler::mEventHandler
protected

◆ mObservers

std::set<Observer*> dart::common::Subject::mObservers
mutableprotectedinherited

List of current Observers.

◆ mSubjects

std::set<const Subject*> dart::common::Observer::mSubjects
protectedinherited

List of current Subjects for this Observer.