osnap.h

Go to the documentation of this file.

/**********************************************************************
 *<
    FILE: osnap.h

    DESCRIPTION:  Classes for Osnaps

    CREATED BY: John Hutchinson

    HISTORY: December 9, 1996
 *> Copyright (c) 1994, All Rights Reserved.
 **********************************************************************/

#pragma once
#include "export.h"
#include "maxheap.h"
#include "tab.h"
#include "maxtypes.h"
#include "point2.h"
#include "strclass.h"

// forward declarations
class Point3;
class Object;
class IPoint2;
class INode;
class ViewExp;
struct SnapInfo;
class GraphicsWindow;
class ObjectState;

#define RESET 0
#define NEXT 1
#define ICON_WIDTH 32

#define HILITE_NORMAL   (1<<0)
#define HILITE_BOX      (1<<1)
#define HILITE_NODE     (1<<2)//Not implemented
#define HILITE_CROSSHAIR (1<<3)

#define OSNAP_STATE _M("ObjectSnapPluginState")

//Some types
class Candidate: public MaxHeapOperators
{
public:
    Candidate(){};
    Candidate(Point3* p, int s, int num=0, ...);
    void SetMeshPoint(int which, const Point3 p);
    ~Candidate();
    Point3 *pt;
    int type;
    int count;
    Point3 *meshverts;
};

typedef Tab<Candidate *> CandidateTab;
typedef void (*SnapCallback) (Object* pobj, IPoint2 *p) ;

class OsnapMarker; 
class HitMesh;
class IOsnapManager;
class MXS_IOsnap; // LAM: added 2/6/01 for MXS osnap exposure

//The osnap class
//===========================================================================

#pragma warning(push)
#pragma warning(disable:4100)
class Osnap: public MaxHeapOperators {
    friend class OsnapHit;
    friend class MXS_IOsnap; // LAM: added 2/6/01 for MXS osnap exposure
    friend class OsnapManager;
    friend class OSnapDecorator;

protected:
    BOOL *m_active;
    DllExport void _Snap(INode* inode, TimeValue t, ViewExp* vpt, IPoint2* p, SnapInfo* snap);
    DllExport Point3 _ReEvaluate(TimeValue t, OsnapHit *hit);
    DllExport boolean IsActive();
    DllExport void SetActive(int index, boolean state);
    DllExport boolean GetActive(int index);

    GraphicsWindow *m_hitgw;

    //Point management.
    //Some osnaps may want to maintain a list of potential hit points. 
    //Note that the points should be passed in in modeling space
    DllExport void AddCandidate(Point3 *pt, int type = -1, int num = 0,...);
    DllExport Point3 *GetCandidatePoint(int index);
    DllExport void GetCandidateMesh(int index, HitMesh *m);
    DllExport int GetCandidateType(int index);
    DllExport void ClearCandidates();
    DllExport int NumCandidates(){return point_candidates.Count();}
    DllExport virtual Point3 ReEvaluate(TimeValue t, OsnapHit *hit, Object* pobj);

    //Note: the following version uses an index into the candidate list
    DllExport BOOL CheckPotentialHit(int ptindex, Point2 cursor);
    //Note: the following version uses a remote matrix of points
    DllExport BOOL CheckPotentialHit(Point3 *p, int ptindex, Point2 cursor);
    int m_baseindex;//an index into the tool array

public:

    DllExport Osnap();
    DllExport virtual ~Osnap();
    DllExport void Init();

    virtual int numsubs(){return 1;}; //the number of subsnaps this guy has
    DllExport virtual MCHAR *Category();//JH 01/04/98 {return NULL;}
    virtual Class_ID ClassID() { return Class_ID( 0, 0); }
    virtual BOOL UseCallbacks(){return FALSE;}
    virtual int NumCallbacks(){return 0;}
    DllExport virtual BOOL GetSupportedObject(INode* iNode, TimeValue t, ObjectState* os);

    virtual MSTR *snapname(int index)=0; // the snaps name to be displayed in the UI
    virtual MSTR *tooltip(int index){return NULL;} // the snaps name to be displayed in the UI
    virtual boolean ValidInput(SClass_ID scid, Class_ID cid)=0;//the objects it supports 
    virtual OsnapMarker *GetMarker(int index)=0; // single object might contain subsnaps
    virtual WORD HiliteMode(){return HILITE_NORMAL;}
    // UI methods
    virtual boolean BeginUI(HWND hwnd){return TRUE;}
    virtual void EndUI(HWND hwnd){};
    virtual HBITMAP getTools()=0;
    virtual HBITMAP getMasks()=0;
    virtual void Snap(Object* pobj, IPoint2 *p, TimeValue t){};
    virtual BOOL HitTest(Object* pobj, IPoint2 *p, TimeValue t){return TRUE;}
    virtual SnapCallback GetSnapCallback( int sub){ return NULL;}
    virtual WORD AccelKey(int index)=0;


protected://data
    IOsnapManager *theman;
    // Holds the point candidates
    CandidateTab point_candidates; 
};
#pragma warning(pop)

//-----------------------------------------------------------------------------
//  OSnapDecorator

class OSnapDecorator : public Osnap
{
    public:
        // Ctor\Dtor
        DllExport OSnapDecorator(Osnap* pOsnap);

        DllExport virtual bool IsActive() const;
        DllExport virtual bool IsActive(const int nSnapIdx) const;
        DllExport virtual void Activate(const int nSnapIdx);
        DllExport virtual void Deactivate(const int nSnapIdx);

        // --- From Osnap
        DllExport virtual int numsubs(); 
        DllExport virtual MCHAR *Category();
        DllExport virtual Class_ID ClassID();
        DllExport virtual BOOL UseCallbacks();
        DllExport virtual int NumCallbacks();
        DllExport virtual BOOL GetSupportedObject(
            INode *iNode, TimeValue t, ObjectState *os);

        DllExport virtual MSTR *snapname(int index);
        DllExport virtual OsnapMarker *GetMarker(int index);
        DllExport virtual HBITMAP getTools();
        DllExport virtual HBITMAP getMasks();
        DllExport virtual WORD AccelKey(int index);
        DllExport virtual boolean ValidInput(SClass_ID scid, Class_ID cid);

        DllExport virtual boolean BeginUI(HWND hwnd);
        DllExport virtual void EndUI(HWND hwnd);
        DllExport virtual void Snap(Object* pobj, IPoint2 *p, TimeValue t);
        DllExport virtual BOOL HitTest(Object* pobj, IPoint2 *p, TimeValue t);
        DllExport virtual SnapCallback GetSnapCallback( int sub);

    protected:
        OSnapDecorator(); // not implemented

    private:
        Osnap*  mpOsnapImp;
};