FILES IN JUMPCORE, NOT COUNTING LIBRARIES:

Files you should edit:

• program.h - Common header
• program.cpp - Game logic goes here
• display.cpp - Display logic goes here

Jumpcore “support” files:

• main.cpp — Basic bringup/teardown and event handling. You might not need to ever edit this.
• kludge.h — Per-platform OpenGL includes and some support functions. There are also some #define flags here you may want to mess with here named VSYNC_FIX and DYNAMIC_FRAMERATE, which turn on some Jumpcore features that are off by default.
• internalfile.cpp, internalfile.h — See below
• slice.cpp, slice.h, controls.cpp, controls.h — See “ControlBase” docs

FUNCTIONS IN JUMPCORE, NOT COUNTING LIBRARIES:

• ERR(”Stringhere”, arg1, arg2)

Works exactly like printf. When compiling in Debug mode, this prints the message given to STDERR. When compiling in Release mode, this does nothing.

• REALERR()

Works exactly like printf. Prints the message given to STDERR regardless of mode. This is of dubious utility (on Windows/mingw, the message will be printed to a file named “stderr.txt”; on the Mac, it will be printed to the Console application, which few people know how to use or find) but the basic Jumpcore code uses it to report fatal errors which occur before the display surface is created.

• void internalPath(char *dst, const char *fmt, int arg1 = 0, int arg2 = 0);

A function that in a cross-platform way produces the absolute path to an “internal file”– On Windows, this means a file in the directory named “Internal” that accompanies the .exe. On the mac, this means a file in the “Resources” folder inside the application package.

• void drawText(string text, double x, double y, double rot = 0, bool xcenter = true, bool ycenter = true);

An example method which draws the string “text” at screen coordinates x, y (Where the top of the screen is 1.0, and the bottom of the screen is -1.0), with rotation “rot” degrees, and optionally centered on the X and Y axes. Uses the global “uiFont” font.

• void BombBox(string why);

A maybe-overcomplicated function for displaying a fatal error (given as “why”). All event handling will halt and a window will go up explaining the error; on the next keypress after this, the program will quit. Uses the global “uiFont” font (but is not dependent on drawText()).

• void FileBombBox(string filename);

Calls BombBox with a message stating “filename” could not be found.

FUNCTIONS IN JUMPCORE, NOT COUNTING LIBRARIES (”FULL VERSION” ONLY)

• void RGBtoHSV( double r, double g, double b, double *h, double *s, double *v )
• void HSVtoRGB( double *r, double *g, double *b, double h, double s, double v )

Self-explanatory color conversion routines.

• cpVect screenToGL(int screenx, int screeny, double desiredZ);

Given the current-this-moment projection matrices, returns the pixel on the screen corresponding to the point (x, y, z) in 3-space.