T3D Quad Menus

Download

Inspired by Ryan Mounts' T3D editor work, I started putting together 3DSMAX-style right-click context menus for T3D's editors some time ago on a weekend as I have always missed right-click menus in both the World Editor and the Gui Editor. Unfortunately, after the weekend, the thing just kept lying there incomplete so this is weekend I set out to at least get it to the state where it may at least be useful to someone.



In the current form, GuiQuadMenuCtrl is roughly feature-complete but the scripting side is still pretty rudimentary. Only the Object Editor in T3D's World Editor gets right-click menus with the current scripts and the even the menus that are there could definitely be made way more useful and complete. Also, I haven't really given this a whole lot of testing.

Still, it's a start and maybe someone finds the time and motivation to push this further along.

Installation Instructions

1. Copy the contents of the game/ folder in the zip to your game folder.
2. Copy the contents of the Engine/ folder in the zip to your Engine/ folder.
3. Re-run projectGenerator or manually add guiQuadMenuCtrl.h and .cpp.
4. Add the following to game/core/art/gui/profiles.cs (or somewhere else where's it is executed on startup)

//>rd: quad menus
if( !isObject( GuiQuadMenuProfile ) )
new GuiControlProfile( GuiQuadMenuProfile )
{
   bitmap = "./images/quadMenu";
   
   // Fonts.
   fontType = "Arial";
   fontSize = 13;
   fontColor = "0 0 0";
   
   // Border.
   border = true;
   borderThickness = 1;
   borderColor = "20 20 20";
   
   // Background.
   fillColor = "242 241 240";
   fillColorNA = "162 161 160"; // Fill color used for title entries.
   fillColorSEL = "228 228 235"; // Fill color used for mouse-overs.
};
//<rd: quad menus

5. Add the following after the existing exec()s to initializeWorldEditor() in tools/worldEditor/main.cs

//>rd: quad menus
   exec( "./scripts/quadMenus.ed.cs" );
   //<rd: quad menus

6. Finally, to allow the scripts to hook into editor right-clicks, add the following snippets to EditTSCtrl.
To where the member variables are declared in the EditTSCtrl class in editTSCtrl.h, add


//>rd: quad menus
      Point2I mRightMouseDownPos;
      Point2I mRightMouseDragDelta;
      bool mRightMouseDragDetected;

      /// @name Callbacks
      /// @{

      DECLARE_CALLBACK( void, onRightMouseClick, ( Point2I mousePos, Point3F screenPos, Point3F viewVector, S32 modifiers ) );

      /// @}
      //<rd: quad menus

Somewhere after the #includes, add


//>rd: quad menus
IMPLEMENT_CALLBACK( EditTSCtrl, onRightMouseClick, void, ( Point2I mousePos, Point3F screenPos, Point3F viewVec, S32 modifiers ),
   ( mousePos, screenPos, viewVec, modifiers ),
   "Called when the user clicks the right mouse button on the control.\n\n"
   "@param mousePos 2D screen-space mouse position.\n"
   "@param screenPos World-space position of the mouse cursor.\n"
   "@param viewVec View direction vector.\n"
   "@param modifiers Bitmask of keyboard modifiers." );
//<rd: quad menus

Right to the beginning of EditTSCtrl::onRightMouseDown add


//>rd: quad menus
   mRightMouseDownPos = event.mousePoint;
   mRightMouseDragDelta = Point2I( 0, 0 );
   mRightMouseDragDetected = false;
   //<rd: quad menus

And at the end of EditTSCtrl::onRightMouseUp add


//>rd: quad menus
   if( !mRightMouseDragDetected )
      onRightMouseClick_callback( mLastEvent.mousePoint, mLastEvent.pos, mLastEvent.vec, mLastEvent.modifier );
   //<rd: quad menus

Right to the beginning of EditTSCtrl::onInputEvent add


//>rd: quad menus

   // Detect when the right mouse button is dragged beyond
   // a 2x2 region around its press-down point.

   if( mRightMouseDown &&
       !mRightMouseDragDetected &&
       event.deviceType == MouseDeviceType &&
       ( event.objInst == SI_XAXIS || event.objInst == SI_YAXIS ) &&
       event.action == SI_MOVE )
   {
      if( event.objInst == SI_XAXIS )
         mRightMouseDragDelta.x += S32( event.fValue );
      else
         mRightMouseDragDelta.y += S32( event.fValue );

      if( mAbs( mRightMouseDragDelta.x ) > 2 && mAbs( mRightMouseDragDelta.y ) > 2 )
         mRightMouseDragDetected = true;
   }
   //<rd: quad menus

7. Optionally, add the following snippet to GuiEditor::isFilteredClass in guiEditor.ed.cs to make GuiQuadMenuCtrl not show up in the Gui Editor's palette:

//>rd: quad menus
      case "GuiQuadMenuCtrl":       return true; // Not meant to be placed on other controls like that.
      //<rd: quad menus