home *** CD-ROM | disk | FTP | other *** search
/ PC Shareware 1997 June / PC_Shareware-1997-06.iso / programy / genesis / tool.h < prev    next >
Encoding:
C/C++ Source or Header  |  1996-08-15  |  11.5 KB  |  266 lines
  1. /*------------------------------------------------------------------
  2.             Tool Include
  3.             ------------
  4.  
  5.     This is the main tool include file. Any tool DLLs should
  6.     include this file as it contains the interface for the
  7.     tool base class from which all tools are derived. It
  8.     also provides the prototypes for the main DLL entry points
  9.     used to create and delete the tool object (NB. The editor
  10.     code cannot create a derived class it doesn't know about)
  11.  
  12.     (C) Silicon Dream Ltd 1994
  13.  
  14.   ------------------------------------------------------------------
  15.  
  16. Changes:                        Date:
  17. * Created file                        27/12/94
  18. */
  19.  
  20. #ifndef TOOL
  21. #define TOOL
  22.  
  23. #ifndef STRICT
  24. #define STRICT        // For correct HDC definition, otherwise derived tools get linker error
  25. #endif
  26.  
  27. #include <windows.h>
  28. #include <atomic.h>
  29. #include <cppmaths.h>
  30. #include <cppdebug.h>
  31. #include <geometry.h>
  32.  
  33. /* Used by tool to inform editor what to redraw after a tool action */
  34.  
  35. typedef enum Redraw{REDRAW_ALL=0,        // Re-renders and redraws overlay for all views
  36.             REDRAW_NONE,        // No redraws at all
  37.             REDRAW_TOOL,        // Redraw ONLY using tools DrawSoFar() routine
  38.             REDRAW_NOTOOL,        // Refreshes screen from bitmaps and thats all
  39.             REDRAW_REFRESH,        // Refreshes screen from bitmaps and calls DrawSoFar()
  40.             REDRAW_OBJECT_WIRE,        // Redraw current object only direct to screen in XOR
  41.             REDRAW_SHADING,        // Re-renders but doesn't change the overlay
  42.             PRIVATE_REDRAW_OVERLAY,    // Reserved
  43.             PRIVATE_REDRAW_ALL_OVERLAY};// Reserved
  44.  
  45. /* Used by tool to put editor into a new mode */
  46.  
  47. typedef enum Mode{MODE_EDIT=0, MODE_VIEW=1, MODE_SELECT=2, MODE_FLIGHT=3};
  48.  
  49. /* Handle to an object archive */
  50.  
  51. typedef ulong        HanArchive;    // harch
  52.  
  53. /* Tool callback codes and router function definition */
  54.  
  55. #define CT_WRITEMESSAGE        0
  56. #define CT_SETVIEWDATA        1
  57. #define CT_ADDNAMEDOBJ        2
  58. #define CT_ADDNAMEDCSYS        3
  59. #define CT_GETOBJHANDLE        4
  60. #define CT_GETCSYSHANDLE    5
  61. #define CT_GETOBJNAME        6
  62. #define CT_GETCSYSNAME        7
  63. #define CT_UPDATEVIEWS        8
  64. #define CT_ACTIVATECSYSWIN    9
  65. #define CT_ADDUSERDATA        10
  66. #define CT_GETUSERDATA        11
  67. #define CT_REMOVEUSERDATA    12
  68. #define CT_QRYNEXTCSYS        13
  69. #define CT_NOVIEWCHANGE        14
  70. #define CT_MAKEOBJWIREFRAME    15
  71. #define CT_PARTSELECTED        16
  72. #define CT_PASTERECEIVER    17
  73. #define CT_MODIFIEDSCENE    18
  74. #define CT_AUTOSMOOTHDLG    19
  75. #define CT_SURFACEDLG        20
  76. #define CT_CHANGEMODE        21
  77. #define CT_SETCURSOR        22
  78. #define CT_ARCHIVEOBJECT    23
  79. #define CT_CREATEFROMARCHIVE    24
  80. #define CT_DELETEARCHIVE    25
  81.  
  82. typedef ulong _exp fnToolCallback(void *pvDoc, ushort usCallType,
  83.                   ulong ul1, ulong ul2, ulong ul3);
  84.  
  85. /* For updating tool specific toolbar buttons and menu items */
  86.  
  87. typedef enum CmdUpdate {ENABLE, DISABLE, CHECK, UNCHECK,
  88.             INDETER, RADIOON, RADIOOFF, SETTEXT};
  89.  
  90.  
  91. /* Marker types */
  92.  
  93. #define MT_BOX        0
  94. #define MT_PLUS        1
  95. #define MT_CROSS    2
  96. #define MT_DIAMOND    3
  97.  
  98. /* Flags for DrawArrow */
  99.  
  100. #define DA_FILLED        1
  101. #define DA_FIXEDSIZE        2
  102.  
  103. /* Maximum list object name length */
  104.  
  105. #define MAX_NAME_BUFF_LEN    35    // To allow for null and digits
  106. #define MAX_NAME_LEN        30
  107.  
  108. /* Reserved structure */
  109.  
  110. typedef struct UserDataInfotag        // pudi
  111.     {
  112.     HanObject        hobj;
  113.     Handle            han;
  114.     HandleType        htype;
  115.     } UserDataInfo;
  116.  
  117. /* Notice a lot of the functions in the Tool class are virtual as it serves
  118.    purely as a polymorphic interface for derived classes. The functions
  119.    implemented in the Tool class do nothing. We cannot however make them
  120.    pure virtual as we would then have an abstract class, and derived tools
  121.    would be required to implement every function otherwise they too would
  122.    become abstract classes (ie. we wouldn't be able to create one) */
  123.  
  124. class _cppdyn Tool
  125.     {
  126.     private:
  127.         void        *pvDoc;                // Ptr to document object
  128.         fnToolCallback    *ToolCallback;            // Callback entry point to editor
  129.         ulong        ulMaxVerts, ulMaxNorms, ulMaxPats;
  130.         HanObject    hobjPrim;
  131.         bool        bReportErrs, bUndoOnErr;
  132.  
  133.     private:
  134.         int ToolMessageBox(GeomErr gerr);
  135.  
  136.     public:
  137.         HINSTANCE    hinst;                // Instance of DLL
  138.         HWND        hwnd;                // Main frame window
  139.         HanVertex    *ahverPrim, hverPrim;        // Primitive vertex handle array
  140.         HanNormal    *ahnorPrim, hnorPrim;        // Primitive normal handle array
  141.         HanPatch    *ahpatPrim;            // Primitive patch handle array
  142.         ulong        ulNumVerts, ulNumNorms, ulNumPats; // Numbers of elements
  143.         HanCoorSys    hcsysTopLevel;            // Documents top level coor sys
  144.         HanCoorSys    hcsysActive;            // Currently active coor sys
  145.         HanSurf        hsurActive;            // Currently active surface type
  146.         ushort        usSmoothFlags;            // Global autosmoothing flags
  147.         float        fSmoothAng;            // Global autosmoothing angle threshold
  148.         bool        bOverlay;            // Overlay is switched on is active view
  149.         Mode        mode;                // Mode of active view
  150.  
  151.     public:
  152.         // Overideables
  153.  
  154.         virtual ~Tool();            // Destructor
  155.         virtual void Initialise();        // Called once when DLL loaded
  156.         virtual Redraw OnSelect(Vec &vec);    // Called when tool is selected
  157.         virtual Redraw OnUnSelect(bool *pbOkToChange); // Called when tool is selected
  158.         virtual void OnConfigure();        // Called to configure tool
  159.         virtual Redraw OnButtonDown(Vec &vec);    // Called when button pressed
  160.         virtual Redraw OnMouseMove(Vec &vec);    // Called when mouse moves with button down
  161.         virtual Redraw OnButtonUp(Vec &vec);    // Called when button is released
  162.         virtual Redraw OnSet(Vec &vec);        // Called when the 'Set' button is clicked
  163.         virtual Redraw OnUndo();        // Called when user wishes to undo effect of tool
  164.         virtual void FreeUndo();        // Called when tool no longer needs to keep stuff for undoing
  165.         virtual Redraw OnDo(Vec &vec);        // Called to end use of tool
  166.         virtual void OnViewChange(HanCoorSys hcsys, Vec &vec); // Called when active view changes
  167.         virtual Redraw OnPaste(Vec &vec, HanObject *ahobj, // Called when objects are pasted into the current view
  168.                        ulong ulNumObjects);
  169.         virtual void OnCommand(ushort usID);    // Called when a tool specific menu item/toolbar button selected
  170.         virtual CmdUpdate OnCommandUpdate(ushort usID, // Called when a tool specific menu item/toolbar button needs updating
  171.                           char *szText, ushort usBuffSize);
  172.         virtual void DrawSoFar(HDC hdc, HanCoorSys hcsys, // Called to draw object so far into the view
  173.                        void *pvViewData, bool bInvalid);
  174.  
  175.         // Tool support functions
  176.  
  177.         void WriteMessage(int iResId);        // Call to write message in status bar
  178.         void WriteMessage(const char *szMsg);    // Call to write message in status bar
  179.         int MessageBox(int iTitleId, int iMsgId, UINT uiStyle=MB_ICONEXCLAMATION); // Call to create message box
  180.         int MessageBox(int iTitleId, const char *szMsg, UINT uiStyle=MB_ICONEXCLAMATION); // Call to create message box
  181.         int MessageBox(int iTitleId, GeomErr gerr); // Call to create message box
  182.         void EndPrim (void);            // Removes buffers for handles
  183.         bool StartPrim (HanObject hobj, ulong ulMaxVerts, // Allocate buffers for handles
  184.                 ulong ulMaxNorms, ulong ulMaxPats,
  185.                 bool bReportErrs, bool bUndoOnErr);
  186.         void RemovePrim (void);            // Removes all primitive elements (verts etc.)
  187.         GeomErr AddVertex (const Vec &vec);    // Adds a vertex (records handle)
  188.         GeomErr AddNormal (const Vec &vec);    // Adds a normal (records handle)
  189.         GeomErr DefPatch (ushort usNumEdges, ushort usFlags, float fSmoothAng, // Adds a patch (records handle)
  190.                   HanVertex *ahver, HanNormal *ahnor, HanSurf hsur=NULL_HANDLE);
  191.         HanObject AddObject(HanCoorSys hcsys, char *szName, // Adds a new named object
  192.                     ushort usBuffSize, float fNewVertTol, HanObject hobj);
  193.         HanCoorSys AddCoorSys(HanCoorSys hcsysParent, char *szName, // Adds a new named coor sys
  194.                       ushort usBuffSize, HanCoorSys hcsys,
  195.                       const Mat &matToParent, const Mat &matFromParent,
  196.                       ushort usType, bool bAddView);
  197.         HanObject GetObjectHandle(const char *szName);// Returns the handle of a named object
  198.         HanCoorSys GetCoorSysHandle(const char *szName);// Returns the handle of a named coor sys
  199.         void GetObjectName(HanObject hobj, char *szName, // Returns the name of the object with the handle
  200.                    ushort usBuffSize);
  201.         void GetCoorSysName(HanCoorSys hcsys, char *szName, // Returns the name of the coor sys with the handle
  202.                     ushort usBuffSize);
  203.         void DrawMarker(HDC hdc, int iX, int iY, ushort usType); // Draws a marker on the DC
  204.         void DrawArrow(HDC hdc, int iX, int iY, ushort usFlags); // Draws an arrow onto the DC
  205.         void SetViewData(void *pvData, ushort usSize); // Sets data for all views
  206.         void BackgroundYield(const char *szWrite=NULL);// Yields control and writes message
  207.         void ForceRedraw(Redraw rd, HanCoorSys hcsys=NULL_HANDLE); // Forces a redraw independently of event
  208.         bool ActivateCSysWin(HanCoorSys hcsys);    // Activates coor sys window (brings to top)
  209.         void ModifiedScene();            // Mark scene as modified by this tool
  210.         void *AddUserData(HanObject hobj, Handle han, // Adds user data to a Geometry item
  211.                   HandleType htype, ulong ulSize);
  212.         void *GetUserData(HanObject hobj, Handle han, // Retrieves user data from a Geometry item
  213.                   HandleType htype);
  214.         bool RemoveUserData(HanObject hobj, Handle han, // Removes user data from a Geometry item
  215.                     HandleType htype);
  216.         bool IsSelected(HanObject hobj, Handle han, HandleType htype); // Returns TRUE if item is selected
  217.         Handle GetNextSelected(Handle hanParent, ulong *pulRef, HandleType htype); // Returns the next selected item
  218.         HanCoorSys QryNextCoorSys(ulong *pulRef, CoorSysInfo *pcsi); // Queries next coor sys in a scene
  219.         void EditInThisView(HanCoorSys hcsys);    // Do not allow editing in any other view
  220.         void MakeObjWireframe(HanObject hobj);    // Makes object XOR'd on REDRAW_OBJECT_WIRE
  221.         void NoneWireframe();            // Makes no objects XOR'd on REDRAW_OBJECT_WIRE
  222.         void PasteReceiver();            // Sets this tool as the paste receiver
  223.         void AutosmoothDlg();            // Calls up the autosmooth dialog
  224.         void SurfaceDlg();            // Calls up the surface type dialog
  225.         void ChangeMode(Mode mode);        // Puts editor into a new mode
  226.         void SetCursor(const Vec &vec);        // Sets the position of the 3D cursor
  227.         HanArchive ArchiveObject(HanCoorSys hcsysOrigin, // Creates an archive for an object
  228.                      HanObject hobj, bool bRemove);
  229.         HanObject CreateFromArchive(HanArchive harch, // Recreates an object from the archive
  230.                         HanCoorSys hcsys);
  231.         void DeleteArchive(HanArchive harch);    // Destroys an object archive
  232.  
  233.         // Editor support functions (not for use by derived tools)
  234.  
  235.         void Initialise(HINSTANCE hinstDLL,
  236.                 void *pvDocIn,
  237.                 HWND hwnd,
  238.                 fnToolCallback *ToolCallbackIn,
  239.                 HanCoorSys hcsysDocTop); // Called to initialise base class
  240.         Redraw OnBaseSelect(HanCoorSys hcsys, HanSurf hsur, ushort usSmoothFlagsIn,
  241.                     float fSmoothAngInVec, bool bOverlayIn, ushort usMode,
  242.                     Vec &vec); // Called to initialise tools public data
  243.         void OnBaseViewChange(HanCoorSys hcsys, bool bOverlayIn,
  244.                       ushort usMode, Vec &vec); // Called when active view changes
  245.         void OnBaseParmChange(HanSurf hsur, ushort usSmoothFlagsIn,
  246.                       float fSmoothAngIn, bool bOverlayIn, ushort usMode); // Called when a global parameter changes
  247.     };
  248.  
  249. /* The IMPLEMENT_OBJECT macro implements the CreateTool and DeleteTool functions, and the
  250.    typedefs are used by the editor to call the function */
  251.  
  252. #ifdef _MSC_VER
  253. #define IMPLEMENT_OBJECT(class) _st class tool; \
  254. _getdyn Tool *CreateTool() {DebStart(); return New class;} \
  255. _getdyn void DeleteTool(Tool *ptool) {Delete ptool;}
  256. #endif
  257. #ifndef _MSC_VER
  258. #define IMPLEMENT_OBJECT(class) _st class tool; \
  259. Tool * _getdyn CreateTool() {DebStart(); return New class;} \
  260. void _getdyn DeleteTool(Tool *ptool) {Delete ptool;}
  261. #endif
  262. typedef Tool *fnCreateTool();
  263. typedef void fnDeleteTool(Tool *ptool);
  264.  
  265. #endif
  266.