Detailed Description

See also:: Class MouseCallBack, Class ViewExp, Class Object, Class Interface, Class Point3, Class Matrtix3, Class CreateMouseCallBack.

Description:

This class is available in release 3.0 and later only.

This mouse proc allows drawing in multiple viewports, offsetting from the contruction plane, and orthogonal and angle snapping. This allows developers to support orthogonal snapping and angle snapping on creation (as the Bezier line tool does). If the user presses Shift while dragging the mouse, the point is snapped to the nearest quadrant (ortho snapping). If the Alt key is held, the point is snapped using the setting of the angle snap system.

The typical control flow of this class is that the OnPointSelected() method is called every time the user clicks in the viewport, and OnMouseAbort() is called when the user right clicks to finish the curve. RemoveLastPoint() is called when backspace is pressed, and OnMouseMove(Point3& p) is called every time the mouse moves (this lets the developer update the curve continuously).

This class is a sub-class of MouseCallBack, but it can also be used as a CreateMouseCallBack to create curves from the creation panel. To do this you embed a DataEntryMouseProc in a CreateMouseCallBack as show below. Notice the implementation of the virtual member StartNewCreation(). This is a new virtual method on CreateMouseCallBack that tells the system whether the mouse proc is in a state ready to create a new object. This was required, becase the "proc" function now always returns "CREATE_STOP" in order to implement multi-viewport input.

class TopCVCurveCreateMouseProc : public Em3DDataEntryMouseProc
{
    TopCVCurveCreateMouseProc() :
    Em3DDataEntryMouseProc() {}
    virtual BOOL OnPointSelected();
    virtual void OnMouseMove(Point3& p);
    virtual BOOL AllowAnyViewport();
    virtual void RemoveLastPoint();
    virtual int OnMouseAbort();
    virtual BOOL PerformRedraw() { return FALSE; }
    void SetObj(EditableCVCurve* o) { mpOb = o; }
    virtual BOOL StartNewCreation() { return mMouseClick == 0; }
    friend class EditableCVCurve;
    private:
        EditableCVCurve * mpOb;
};
class EditableCVCurveCreateCallBack: public CreateMouseCallBack
{
    EditableCVCurveCreateCallBack() {}
    virtual int proc( ViewExp* vpt,int msg, int point, int flags, IPoint2 m,
        Matrix3& mat );
    friend class CVBackspaceUser;
    friend class EditableCVCurve;
    virtual BOOL StartNewCreation() {
        return mMouseProc.StartNewCreation();
    }
    private:
        void RemoveLastPoint();
        TopCVCurveCreateMouseProc mMouseProc;
};
int EditableCVCurveCreateCallBack::proc(ViewExp* vpt,int msg, int point, int
flags, IPoint2 m, Matrix3& mat)
{
    spTransformMat = &mat;
    return mMouseProc.proc(vpt->GetHWnd(), msg, point, flags, m);
}

static EditableCVCurveCreateCallBack nsCreateCB;
CreateMouseCallBack* EditableCVCurve::GetCreateMouseCallBack()
{
    nsCreateCB.mMouseProc.SetObj(this);
    nsCreateCB.mMouseProc.SetParams(hInstance, mpEM, 0);
    return(&nsCreateCB);
}

Data Members:: protected:

Object* mpObject;

This a pointer to the object that is using the mouse proc.

int mMouseClick;

The number of clicks (i.e. selected points) the user has entered in creating this object. It is like the "point" parameter to "proc".

Tab<Point3> mPoints;

These are the 3D values of the points the user has selected.

Tab<IPoint2> mClickPoints;

These are the 2D viewport coordinates the user selected.

BOOL mLiftOffCP;

TRUE when in the mode where we lift off the construction plane

#include <mouseproc.h>

Inheritance diagram for DataEntryMouseProc:

[legend]

List of all members.

Public Member Functions
CoreExport	DataEntryMouseProc (Object *pObj, int cursor, HINSTANCE hInst)
CoreExport	DataEntryMouseProc ()
virtual CoreExport BOOL	OnPointSelected ()
virtual CoreExport void	OnMouseMove (Point3 &p)
virtual CoreExport BOOL	AllowAnyViewport ()
virtual CoreExport void	RemoveLastPoint ()
virtual CoreExport int	OnMouseAbort ()
virtual CoreExport BOOL	PerformRedraw ()
virtual CoreExport void	SetUseConstructionLine (BOOL useLine)=0
virtual CoreExport void	SetConstructionLine (int i, Point3 p)=0
CoreExport int	proc (HWND hwnd, int msg, int point, int flags, IPoint2 m)
CoreExport void	ClearCreationParams ()
CoreExport void	SetParams (HINSTANCE hInst, Object *pObj, int cursor)
Protected Attributes
Object *	mpObject
int	mMouseClick
Tab< Point3 >	mPoints
Tab< IPoint2 >	mClickPoints
BOOL	mLiftOffCP
HWND	mHwnd
IPoint2	mLastMovePoint
Friends
class	DataEntryBackspaceUser

Constructor & Destructor Documentation

CoreExport DataEntryMouseProc	(	Object *	pObj,
		int	cursor,
		HINSTANCE	hInst
	)

Remarks:: Constructor. The data members are initialized as follows:

mpObject = pObj;

mCursor = cursor;

mInstance = hInst;

mMouseClick = 0;

mDoNotDouble = TRUE;

mLiftOffCP = FALSE;

mPreviousFlags = 0;

CoreExport DataEntryMouseProc ( )

Remarks:: Constructor. The data members are initialized as follows:

mpObject = NULL;

mpIp = NULL;

mMouseClick = 0;

mDoNotDouble = TRUE;

mCursor = 0;

mLiftOffCP = FALSE;

mPreviousFlags = 0;

mInstance = 0;

Member Function Documentation

virtual CoreExport BOOL OnPointSelected ( ) [inline, virtual]

virtual CoreExport void SetConstructionLine	(	int	i,
		Point3	p
	)		`[pure virtual]`

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

CoreExport void SetParams	(	HINSTANCE	hInst,
		Object *	pObj,
		int	cursor
	)

DataEntryMouseProc Class Reference

Detailed Description

Public Member Functions

Protected Attributes

Friends

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation