Compile again

.gitignore

@@ -0,0 +1,20 @@
+*.o
+Makefile
+Makefile.in
+aclocal.m4
+autom4te.cache/
+compile
+config.h
+config.h.in
+config.log
+config.status
+configure
+depcomp
+install-sh
+missing
+src/.deps/
+src/Makefile
+src/Makefile.in
+src/bzworkbench
+stamp-h1
+

README.md

@@ -0,0 +1,25 @@
+#BZWorkbench
+
+BZWorkbench is a full featured world editor for the game BZFlag.
+
+It was initially written for the Google summer of code program in 2007.
+After a few years of activity development stalled.
+It is currently under active development again.
+
+The current version's functionality is limited, as the first
+goal was to make it compile again against the current versions
+of the libraries it depends on. Specifically Open Scene Graph.
+
+In its current state it:
+
+- Compiles under (Arch) Linux,
+- Can load and view maps,
+- Can Add, Edit and Remove objects.
+
+![Screenshot](bzworkbenchscreenshot.png "Screenshot")
+
+Background information:
+
+1. <https://developers.google.com/open-source/gsoc/2007/#bzflag>
+2.  <https://www.google-melange.com/gsoc/org2/google/gsoc2009/bzflag>
+

TODO

@@ -1,3 +1,20 @@
-Add features.
-Fix bugs.
-Improve the unix build system.
+
+Bugs:
+    - Crash on loading specific maps
+    - When (after resize?) loaidng a map the ground/grass is much smaller than
+      the map.
+
+Revive Existing currently broken Functionality
+
+Documentation:
+    - User Manual
+    - Design/Architecture
+
+Features:
+    - Button to reset the view
+    - Undo/Redo
+    - Shortcut to put an element on ground level
+    - Show the name of an object
+    - Improve the unix build system.
+    - Make it compile under Windows again.
+

UserManual/manual.md

@@ -0,0 +1,64 @@
+# User Manual
+
+## Usage Philosophy
+
+The usage model is aimed at having one hand on the keyboard
+and one hand on the mouse.
+
+Therefore most operations require only one key-stroke.
+
+## Basic Usage
+
+
+
+## Keyboard and Mouse shortcuts
+
+Action                              Result
+-------------------------------     ----------------------------------
+left mouse button                   Select an object
+shift left mouse button             Select an additional object
+left mouse button + motion          rotate view
+ctrl left mouse button + motion     shift view
+alt left mouse button + motion      scale view
+
+
+Action                              Result
+-------------------------------     ----------------------------------
+3                                   Zoom to selected object (TD)
+5                                   Zoom/out into the map  (TD)
+6                                   View the map from the top (TD)
+7                                   View the map from the front (TD)
+
+Adding objects
+
+Action                              Result
+-------------------------------     ----------------------------------
+b                                   Add a box
+p                                   Add a pyramid
+
+
+
+When on a selected object
+
+Action                              Result
+-------------------------------     ----------------------------------
+left mouse button                   Deselect an object
+left mouse button + motion          rotate view
+ctrl left mouse button + motion     shift view
+alt left mouse button + motion      scale view
+right mouse button                  configure an object (TD)
+c                                   configure an object (TD)
+s                                   switch to scale manipulator
+m                                   switch to move/translate manipulator
+r                                   switch to rotate manipulator
+3                                   Zoom to selected object(s) (TD)
+
+
+## Objects
+
+### Box
+
+### Pyramid
+
+
+vi: spell spl=en

include/dialogs/ConfigurationMenu.h

@@ -30,92 +30,95 @@ class bz2object;
 
 class ConfigurationMenu : public Fl_Menu_Button {
 
-public:
-
-	// constructor and destructor
-	ConfigurationMenu(MainWindow* parent, int x, int y, int width, int height);
-	virtual ~ConfigurationMenu() { }
-
-	// update the object
-	void setObject( bz2object* _obj ) {this->obj = _obj; this->buildMenu(); }
-
-	// static callbacks
-	static void translate_x(Fl_Widget* w, void* data) {
-		ConfigurationMenu* cm = (ConfigurationMenu*)(data);
-		cm->translate_x_real( w );
-	}
-
-	static void translate_y(Fl_Widget* w, void* data) {
-		ConfigurationMenu* cm = (ConfigurationMenu*)(data);
-		cm->translate_y_real( w );
-	}
-
-	static void translate_z(Fl_Widget* w, void* data) {
-		ConfigurationMenu* cm = (ConfigurationMenu*)(data);
-		cm->translate_z_real( w );
-	}
-
-	static void rotate_x(Fl_Widget* w, void* data) {
-		ConfigurationMenu* cm = (ConfigurationMenu*)(data);
-		cm->rotate_x_real( w );
-	}
-
-	static void rotate_y(Fl_Widget* w, void* data) {
-		ConfigurationMenu* cm = (ConfigurationMenu*)(data);
-		cm->rotate_y_real( w );
-	}
-
-	static void rotate_z(Fl_Widget* w, void* data) {
-		ConfigurationMenu* cm = (ConfigurationMenu*)(data);
-		cm->rotate_z_real( w );
-	}
-
-	static void scale_x(Fl_Widget* w, void* data) {
-		ConfigurationMenu* cm = (ConfigurationMenu*)(data);
-		cm->scale_x_real( w );
-	}
-
-	static void scale_y(Fl_Widget* w, void* data) {
-		ConfigurationMenu* cm = (ConfigurationMenu*)(data);
-		cm->scale_y_real( w );
-	}
-
-	static void scale_z(Fl_Widget* w, void* data) {
-		ConfigurationMenu* cm = (ConfigurationMenu*)(data);
-		cm->scale_z_real( w );
-	}
-
-	static void tweak(Fl_Widget* w, void* data) {
-		ConfigurationMenu* cm = (ConfigurationMenu*)(data);
-		cm->tweak_real( w );
-	}
-
-private:
-
-	// instantiated callbacks
-	void translate_x_real( Fl_Widget* w );
-	void translate_y_real( Fl_Widget* w );
-	void translate_z_real( Fl_Widget* w );
-
-	void rotate_x_real( Fl_Widget* w );
-	void rotate_y_real( Fl_Widget* w );
-	void rotate_z_real( Fl_Widget* w );
-
-	void scale_x_real( Fl_Widget* w );
-	void scale_y_real( Fl_Widget* w );
-	void scale_z_real( Fl_Widget* w );
-
-	void tweak_real( Fl_Widget* w );
-
-	// parent
-	MainWindow* parent;
-
-	// the object to configure
-	bz2object* obj;
-
-	// build the menu (helper method)
-	void buildMenu(void);
-
+    public:
+
+        // constructor and destructor
+        ConfigurationMenu(MainWindow* parent, int x, int y, int width, int height);
+        virtual ~ConfigurationMenu() { }
+
+        // update the object
+        void setObject( bz2object* _obj ) {
+            this->obj = _obj;
+            this->buildMenu();
+        }
+
+        // static callbacks
+        static void translate_x(Fl_Widget* w, void* data) {
+            ConfigurationMenu* cm = (ConfigurationMenu*)(data);
+            cm->translate_x_real( w );
+        }
+
+        static void translate_y(Fl_Widget* w, void* data) {
+            ConfigurationMenu* cm = (ConfigurationMenu*)(data);
+            cm->translate_y_real( w );
+        }
+
+        static void translate_z(Fl_Widget* w, void* data) {
+            ConfigurationMenu* cm = (ConfigurationMenu*)(data);
+            cm->translate_z_real( w );
+        }
+
+        static void rotate_x(Fl_Widget* w, void* data) {
+            ConfigurationMenu* cm = (ConfigurationMenu*)(data);
+            cm->rotate_x_real( w );
+        }
+
+        static void rotate_y(Fl_Widget* w, void* data) {
+            ConfigurationMenu* cm = (ConfigurationMenu*)(data);
+            cm->rotate_y_real( w );
+        }
+
+        static void rotate_z(Fl_Widget* w, void* data) {
+            ConfigurationMenu* cm = (ConfigurationMenu*)(data);
+            cm->rotate_z_real( w );
+        }
+
+        static void scale_x(Fl_Widget* w, void* data) {
+            ConfigurationMenu* cm = (ConfigurationMenu*)(data);
+            cm->scale_x_real( w );
+        }
+
+        static void scale_y(Fl_Widget* w, void* data) {
+            ConfigurationMenu* cm = (ConfigurationMenu*)(data);
+            cm->scale_y_real( w );
+        }
+
+        static void scale_z(Fl_Widget* w, void* data) {
+            ConfigurationMenu* cm = (ConfigurationMenu*)(data);
+            cm->scale_z_real( w );
+        }
+
+        static void tweak(Fl_Widget* w, void* data) {
+            ConfigurationMenu* cm = (ConfigurationMenu*)(data);
+            cm->tweak_real( w );
+        }
+
+    private:
+
+        // instantiated callbacks
+        void translate_x_real( Fl_Widget* w );
+        void translate_y_real( Fl_Widget* w );
+        void translate_z_real( Fl_Widget* w );
+
+        void rotate_x_real( Fl_Widget* w );
+        void rotate_y_real( Fl_Widget* w );
+        void rotate_z_real( Fl_Widget* w );
+
+        void scale_x_real( Fl_Widget* w );
+        void scale_y_real( Fl_Widget* w );
+        void scale_z_real( Fl_Widget* w );
+
+        void tweak_real( Fl_Widget* w );
+
+        // parent
+        MainWindow* parent;
+
+        // the object to configure
+        bz2object* obj;
+
+        // build the menu (helper method)
+        void buildMenu(void);
+
 };
 
 #include "../windows/MainWindow.h"