Public Member Functions | Public Attributes

MouseToolCallBack Class Reference

Search for all occurrences

#include <mousetool.h>

Inheritance diagram for MouseToolCallBack:
Inheritance graph
[legend]

List of all members.

Public Member Functions

  MouseToolCallBack ()
int  proc (HWND hwnd, int msg, int point, int flags, IPoint2 m)
  Called to handle the mouse event processing whenever a mouse event happens.
int  mouse_proc (ViewExp *vpt, int msg, int point, int flags, IPoint2 m, Matrix3 &mat, BOOL createMouseCallback=FALSE)
void  set_context_locals (ViewExp *vpx, int snap, int point, int flag, IPoint2 mp, Point3 cpp, Matrix3 &mat)
void  reset_context_locals ()

Public Attributes

MouseTool *  tool
IPoint2  last_mp
Point3  last_wp
Point3  last_cpp

Constructor & Destructor Documentation

MouseToolCallBack ( ) [inline]
{}

Member Function Documentation

int proc ( HWND  hwnd,
int  msg,
int  point,
int  flags,
IPoint2  m 
) [virtual]

Called to handle the mouse event processing whenever a mouse event happens.

Parameters:
hwnd The window handle of the window in which the user has clicked. It is one of the viewports to which an interface can be obtained from the system. To get such interface, the window handle should be passes to the functions Interface::GetViewport() as the input. Developers should call Interface::ReleaseViewport() once they are done with the viewport interface.
msg This message describes the type of event that occurred. See Mouse Call Back Flags.
point The point number. this is 0 for the first click, 1 for the second, etc.
flags These flags describe the state of the mouse buttons. See Mouse Call Back Flags.
m The 2D screen point on which that the user has clicked. Methods in the viewport interface allow this point to be converted into a world space ray or a 3D view space point. A world space ray can be intersected with the active construction plane which results in a point on the active construction plane. See Class ViewExp.
Returns:
TRUE, indicating the proc should continue to process points; or FALSE, meaning to stop processing points. If a plug-in supplied a large number of points in a command mode that uses this mouse proc, FALSE can be returned to abort the processing before all the points have been entered.

Reimplemented from MouseCallBack.

int mouse_proc ( ViewExp vpt,
int  msg,
int  point,
int  flags,
IPoint2  m,
Matrix3 mat,
BOOL  createMouseCallback = FALSE 
)
void set_context_locals ( ViewExp vpx,
int  snap,
int  point,
int  flag,
IPoint2  mp,
Point3  cpp,
Matrix3 mat 
)
void reset_context_locals ( )

Member Data Documentation

MouseTool* tool

MouseToolCallBack MouseToolCallBack MouseToolCallBack MouseToolCallBack MouseToolCallBack MouseToolCallBack MouseToolCallBack MouseToolCallBack MouseToolCallBack MouseToolCallBack
MouseToolCallBack MouseToolCallBack MouseToolCallBack MouseToolCallBack MouseToolCallBack MouseToolCallBack MouseToolCallBack MouseToolCallBack MouseToolCallBack MouseToolCallBack