HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
DM_MouseEventHook Class Referenceabstract

#include <DM_MouseHook.h>

Public Member Functions

 DM_MouseEventHook (DM_VPortAgent &vport, DM_ViewportType view_mask)
 
virtual ~DM_MouseEventHook ()
 
virtual bool handleMouseEvent (const DM_MouseHookData &hook_data, UI_Event *event)=0
 Method called to handle a mouse motion or button event. More...
 
virtual bool handleMouseWheelEvent (const DM_MouseHookData &hook_data, UI_Event *event)=0
 Method called to handle a mouse wheel scroll event. More...
 
virtual bool handleDoubleClickEvent (const DM_MouseHookData &hook_data, UI_Event *event)=0
 Method called to handle a mouse button double click event. More...
 
virtual bool allowRMBMenu (const DM_MouseHookData &, UI_Event *)
 Method called to determine whether to allow a RMB menu popup. More...
 
DM_VPortAgentviewport () const
 Viewport this scene render is attached to. More...
 
DM_ViewportType getViewportMask () const
 

Detailed Description

Mouse event hook instance, which does the actual handling for a viewport.

Allocated by the DM_MouseHook factory object.

Examples:
DM/DM_GreedyMouseHook.C.

Definition at line 34 of file DM_MouseHook.h.

Constructor & Destructor Documentation

DM_MouseEventHook::DM_MouseEventHook ( DM_VPortAgent vport,
DM_ViewportType  view_mask 
)

A mouse event hook has a parent viewport and a view type mask which determines which viewport types it will process mouse events within (eg. perspective, ortho, UV, all).

virtual DM_MouseEventHook::~DM_MouseEventHook ( )
virtual

Member Function Documentation

virtual bool DM_MouseEventHook::allowRMBMenu ( const DM_MouseHookData ,
UI_Event  
)
inlinevirtual

Method called to determine whether to allow a RMB menu popup.

This method is called to determine if Houdini is allowed to open a RMB menu on a particular mouse event. It is called in descending order of priority with the RMB menu event allowed only if all hooks allow it.

Definition at line 74 of file DM_MouseHook.h.

DM_ViewportType DM_MouseEventHook::getViewportMask ( ) const
inline

Definition at line 80 of file DM_MouseHook.h.

virtual bool DM_MouseEventHook::handleDoubleClickEvent ( const DM_MouseHookData hook_data,
UI_Event event 
)
pure virtual

Method called to handle a mouse button double click event.

This method is called to handle a mouse double click event. It should return true when it handles the event to prevent any further code from processing it.

virtual bool DM_MouseEventHook::handleMouseEvent ( const DM_MouseHookData hook_data,
UI_Event event 
)
pure virtual

Method called to handle a mouse motion or button event.

This method is called to handle a regular mouse event. It should return true when it handles the event to prevent any further code from processing it.

virtual bool DM_MouseEventHook::handleMouseWheelEvent ( const DM_MouseHookData hook_data,
UI_Event event 
)
pure virtual

Method called to handle a mouse wheel scroll event.

This method is called to handle a mouse wheel scroll event. It should return true when it handles the event to prevent any further code from processing it.

DM_VPortAgent& DM_MouseEventHook::viewport ( ) const
inline

Viewport this scene render is attached to.

Definition at line 79 of file DM_MouseHook.h.


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