/************************************************/
/*												*/
/*	Snakes.h - Snakes Header file.				*/
/*												*/
/*	Revised 7/6/94	by RMR						*/
/*												*/
/************************************************/

#include <TransSkel.h>
#include <TransDisplay.h>
#include <GestaltEqu.h>
#include <QDOffScreen.h>
#include <Palettes.h>

/************************************************/
/*												*/
/*		DEFINITIONS								*/
/*												*/
/************************************************/

#define	kMovableModal	5
#define	kPictHeaderSize	512
#define GRAY_RAMP		32

#define QD32TRAP		0xAB03
#define UNIMPL_TRAP		0xA89F

#define MAXMODELS		10
#define	MAXRUNGS		10
#define	MAXSPRINGS		(5 * (MAXRUNGS - 1) + 1)
#define	PARTICLE_RADIUS	3

#define	MINVALUE		0
#define	MIDVALUE		127
#define	MAXVALUE		255

#define UpdateLines		5	/* Progress Bar Freq. */

/*	----------------							*/
/*	Resource numbers      						*/
/*	----------------							*/

#define kCustomPalette		128

#define	kAboutAlrtRes		300
#define kErrorAlertID		301

#define	kProgressDlog		302
#define kGlobalDlog			303
#define	kRefParamDlog		304
#define	kTestParamDlog		305
#define	kThresholdDlog		306
#define	kOptionsDlog		307
#define kPlaceDlog			308
#define	kExecuteDlog		309
#define	kHistDlog			310

#define kInfoWindow			400
#define	kPictWindow			401
#define	kGradWindow			402
#define	kThrsWindow			404

#define kGlobalParams		600
#define kRefModelParams		601
#define kTestModelParams	602
#define kRefModel			603
#define kTestModel			604
#define	kOptions			605

#define	kCreatorID			'SNAK'
#define	kImageFileType		'PICT'
#define	kGlobalParamType	'GPRM'
#define	kModelType			'MODL'
#define	kWPosType			'WPOS'
#define	kOptionsType		'OPTN'

/*	------------								*/
/*	Menu numbers  	    						*/
/*	------------								*/

#define mSmoothKernel	201
#define mGradKernel		203
#define	mFile			1001
#define	mImage			1002
#define	mModel			1003


/*	------------------							*/
/*	Parametized Macros      					*/
/*	------------------							*/

#define ScreenDepth(gdh)	((*((*gdh)->gdPMap))->pixelSize)
#define MaxColors(gdh)		(1<<ScreenDepth(gdh))

/************************************************/
/*												*/
/*	TYPEDEFS			      					*/
/*												*/
/************************************************/

typedef unsigned char	Value;
typedef Value 			*ValPtr;
typedef Value			**ValHandle;

/* 	--------------------------					*/
/* 	Menu & Dialog item numbers 					*/
/* 	--------------------------					*/

typedef enum {	i3x3=1, i5x5, i7x7, i9x9 } KernelItem;

typedef enum { 	iOpen=1, iClose, iSave, iSaveAs, 
				iSep1a, iLoadModel, iSaveModel, iSep1b,
				iGlobal, iOption, iSep1c, iQuit } FileItem;

typedef enum { 	iHist=1, iThrs, iBlobs, iFill, iSep2a, iEqual,  
				iNoise, iSmooth, iGrad, iSep2b, iUndo } ImageItem;

typedef enum { 	iRefParams=1, iTestParams, iPlacement, 
				iClearAll, iExecute, iRelax } ModelItem;

typedef enum { 	iCancelButton=1, iProgressText, iProgressBar } ProgressItem;

typedef enum {	iGlobalOK=1, iGlobalCancel, iTimeIncrStr, iGravConstStr,
				iViscFrictStr, iThresholdStr, iGradScaleStr,
				iSmoothKern, iGradKern } GlobalParamItem;

typedef enum {	iModelOK=1, iModelCancel, iWSize, iKLimit,
				iFLimit, iPMass, iPColor, iRStiff, iRFriction,
				iRColor, iEStiff, iEFriction, iEColor, iBStiff,
				iBFriction, iBColor } ModelParamItem;
				
typedef enum {	iThrsOK=1, iThrsCancel, iThrsText } ThrsDlogItem;
				
typedef enum {	iOptDone=1, iOptDefault, iInfoCheck, iGradCheck, 
				iPWindCheck, iLoadCheck, iRungCheck } OptDlogItem;
				
typedef enum {	iPlaceClose=1, iPlaceDone, iPlaceDelOne, iPlaceClear, 
				iPlaceRefA, iPlaceRefB, iPlaceTestA, iPlaceTestB,
				iTextRefA, iTextRefB, iTextTestA, iTextTestB } PlaceDlogItem;

typedef enum {	iExecStop=1, iExecStep, iExecCont, iRefWidth, 
				iTestWidth, iRefKECur, iRefSFCur, iTestKECur, 
				iTestSFCur, iRefKELim, iRefSFLim, iTestKELim, 
				iTestSFLim, iExecStatus } ExecDlogItem;

typedef enum {	iHistClose=1, iHistRect } HistDlogItem;

typedef enum {	sIdle, sPaused, sRunning, sPlaceRefA, 
				sPlaceRefB, sPlaceTestA, sPlaceTestB } ModelStatus;

/* 	---------------------						*/
/* 	Model data structures						*/
/* 	---------------------						*/

typedef	float					Scalar;
typedef struct { Scalar x, y; } Vector;

typedef enum { tNone, tRung, tEdge, tBrace } SpringType;

typedef Point **WPosHandle;

typedef struct
{
	Boolean	exists;
	Boolean	locked;
	Boolean	valid;
	short	elementSize;
	short	numberOfElements;
	Handle	base;
}	Array;

typedef struct
{
	Boolean		showInfoWindow;
	Boolean		showGradientModels;
	Boolean		showParticleWindows;
	Boolean		loadModelsWithImage;
	Boolean		firstRungDoesntMove;
}	Options;

typedef Options *OptionsPtr;

typedef struct
{
	Scalar		timeIncrement;
	Scalar		gravityConstant;
	Scalar		viscousFriction;
	Value		threshold;
	short		gradientScale;
	KernelItem	smoothKernSize;
	KernelItem	gradKernSize;
}	GlobalParams;

typedef GlobalParams *GParamsPtr;

typedef struct
{
	Vector		position;
	Vector		velocity;
	Vector		force;
}	Particle;

typedef struct
{
	Particle	*from;
	Particle	*to;
	SpringType	type;
	Scalar		lengthAtRest;
}	Spring;

typedef struct
{
	short		windowSize;
	Scalar		kineticLimit;
	Scalar		forceLimit;
	Scalar		particleMass;
	RGBColor	particleColor;
	Scalar		rungStiffness;
	Scalar		rungFriction;
	RGBColor	rungColor;
	Scalar		edgeStiffness;
	Scalar		edgeFriction;
	RGBColor	edgeColor;
	Scalar		braceStiffness;
	Scalar		braceFriction;
	RGBColor	braceColor;
	Boolean		sideADone;
	Boolean		sideBDone;
	short		sideAParticles;
	short		sideBParticles;
	short		numberOfSprings;
	Scalar		totalKineticEnergy;
	Scalar		totalForceMagnitude;
	Scalar		averageWidth;
	Vector		sumInternalForces;
	Vector		sumExternalForces;
	Particle	sideAList[MAXRUNGS];
	Particle	sideBList[MAXRUNGS];
	Spring		springList[MAXSPRINGS];
}	Model;

typedef Model *ModelPtr;

/************************************************/
/*												*/
/*	PROGRAM GLOBAL CONSTANTS					*/
/*												*/
/************************************************/

#ifdef __MAIN__

	const SkelInitParams kInitParms = { 10, nil, nil, 1024 };	
	const Str32 	PrefFileName 	= "\pSnakes Prefs";
	const Str32 	PrefTempName 	= "\pSnakes Temp";
	const Rect		kInfoWindRect	= { 50, 50, 150, 550 };
	const Rect		kPictWindRect	= { 60, 80, 120, 180 };
	const Rect		kGradWindRect	= { 100, 100, 160, 200 };
	const Rect		kThrsWindRect	= { 140, 120, 200, 220 };
	const Rect		kProgrDlogRect	= { 40, 40, 120, 320 };
	const Rect		kGlobalDlogRect	= { 40, 40, 270, 260 };
	const Rect		kRefParmDlogRect= { 50, 160, 420, 360 };
	const Rect		kTstParmDlogRect= { 50, 160, 420, 360 };
	const Rect		kThreshDlogRect	= { 140, 200, 220, 360 };
	const Rect		kOptionsDlogRect= { 40, 40, 190, 280 };
	const Rect		kPlaceDlogRect	= { 40, 40, 180, 350 };
	const Rect		kExecuteDlogRect= { 40, 40, 240, 380 };
	const Rect		kHistDlogRect	= { 40, 40, 210, 380 };

	const RGBColor	kBlack   		= {      0,      0,      0 };
	const RGBColor	kWhite   		= { 0xFFFF, 0xFFFF, 0xFFFF };
	const RGBColor	kRed     		= { 0xFFFF,      0,      0 };
	const RGBColor	kOrange  		= { 0xFFFF, 0x8000,      0 };
	const RGBColor	kYellow  		= { 0xFFFF, 0xFFFF,      0 };
	const RGBColor	kGreen   		= {      0, 0xFFFF,      0 };
	const RGBColor	kCyan    		= {      0, 0xFFFF, 0xFFFF };
	const RGBColor	kBlue    		= {      0,      0, 0xFFFF };
	const RGBColor	kMagenta 		= { 0xFFFF,      0, 0xFFFF };
	const RGBColor	kDarkGrey		= { 0x4000, 0x4000, 0x4000 };
	const RGBColor	kGrey			= { 0x8000, 0x8000, 0x8000 };

	const Options	defaultOptions	= { true, false, false, true, true };
	const GlobalParams defaultParams= { 0.1, 1.0, 2.0, 10, 300, i5x5, i5x5 };
	const Model		defaultModel	= { 16, 0.1, 1.0, 1.0, { 0xFFFF, 0xFFFF, 0 },
										0.4, 0.2, { 0, 0xFFFF, 0 }, 
										3.0, 1.5, { 0, 0xFFFF, 0xFFFF },
										0.4, 0.2, { 0, 0, 0xFFFF }, 
										false, false, 0, 0, 0, 1.0, 1.0, 0.0, 
										{ 0.0, 0.0 }, { 0.0, 0.0 } };
#else

	extern const RGBColor		kBlack, kWhite, kRed, kYellow, kGreen;
	extern const RGBColor		kCyan, kBlue, kMagenta, kDarkGrey, kGrey;
	extern const Options		defaultOptions;
	extern const GlobalParams 	defaultParams;
	extern const Model			defaultModel;
	
#endif

/************************************************/
/*												*/
/*	PROGRAM GLOBAL VARIABLES					*/
/*												*/
/************************************************/

#ifdef __MAIN__

	Boolean			gTerminateFlag;
	Rect 			gPictRect;
	short			gPictHeight, gPictWidth;
	long			gHistMax;
	Str255			gTempStr;
	Array			gPictArray, gGradArray, gThrsArray;
	Array			gHistArray, gTempArray;
	Pattern			gSolidPattern;
	ModelStatus		gModelStatus;

	WindowPtr		gInfoWindow, gPictWindow, gGradWindow;
	WindowPtr		gThrsWindow;
	GWorldPtr		gPictWorld, gGradWorld, gThrsWorld;
	DialogPtr		gProgressDialog, gGlobalDialog, gPlaceDialog;
	DialogPtr		gRefParamDialog, gTestParamDialog, gHistDialog;
	DialogPtr		gThresholdDialog, gOptionsDialog, gExecDialog;
	OptionsPtr		gOptions;
	GParamsPtr		gGlobalParams;
	ModelPtr		gRefModel, gTestModel;

	MenuHandle		gSmoothKernelMenu, gGradKernelMenu;
	MenuHandle 		gFileMenu, gImageMenu, gModelMenu;
	PaletteHandle	gCustPalette;
	CursHandle		gIBeamCursor, gCrossCursor, gWatchCursor;
	WPosHandle		gInfoWindowWPos, gPictWindowWPos, gGradWindowWPos;
	WPosHandle		gThrsWindowWPos;
	WPosHandle		gProgressDialogWPos, gGlobalDialogWPos, gPlaceDialogWPos;
	WPosHandle		gRefParamDialogWPos, gTestParamDialogWPos, gHistDialogWPos;
	WPosHandle		gThresholdDialogWPos, gOptionsDialogWPos, gExecDialogWPos;

#else

	extern Boolean			gTerminateFlag;
	extern Rect 			gPictRect;
	extern short			gPictHeight, gPictWidth;
	extern long				gHistMax;
	extern Str255			gTempStr;
	extern Array			gPictArray, gGradArray, gThrsArray;
	extern Array			gHistArray, gTempArray;
	extern Pattern			gSolidPattern;
	extern ModelStatus		gModelStatus;

	extern WindowPtr		gInfoWindow, gPictWindow, gGradWindow;
	extern WindowPtr	 	gThrsWindow;
	extern GWorldPtr		gPictWorld, gGradWorld, gThrsWorld;
	extern DialogPtr		gProgressDialog, gGlobalDialog, gPlaceDialog;
	extern DialogPtr		gRefParamDialog, gTestParamDialog, gHistDialog;
	extern DialogPtr		gThresholdDialog, gOptionsDialog, gExecDialog;
	extern OptionsPtr		gOptions;
	extern GParamsPtr		gGlobalParams;
	extern ModelPtr			gRefModel, gTestModel;

	extern MenuHandle		gSmoothKernelMenu, gGradKernelMenu;
	extern MenuHandle 		gFileMenu, gImageMenu, gModelMenu;
	extern PaletteHandle	gCustPalette;
	extern CursHandle		gIBeamCursor, gCrossCursor, gWatchCursor;
	extern WPosHandle		gInfoWindowWPos, gPictWindowWPos, gGradWindowWPos;
	extern WPosHandle		gThrsWindowWPos;
	extern WPosHandle		gProgressDialogWPos, gGlobalDialogWPos, gPlaceDialogWPos;
	extern WPosHandle		gRefParamDialogWPos, gTestParamDialogWPos, gHistDialogWPos;
	extern WPosHandle		gThresholdDialogWPos, gOptionsDialogWPos, gExecDialogWPos;

#endif

/************************************************/
/*												*/
/*	GLOBAL FUNCTION PROTOTYPES					*/
/*												*/
/************************************************/

/************************************/
/*		pictfiles.c prototypes		*/
/************************************/

void 	CheckFileCompatibility(void);
PicHandle MakePicture(GWorldPtr world);
void 	ShowPictWindow(void);
Boolean	InitPictWindow(void);
void 	OpenPictWindow(void);
void 	ClosePictWindow(void);
void 	KickPictWindow(void);
void 	SavePictWindow(void);
void 	SavePictWindowAs(void);

/************************************/
/*		filter.c prototypes			*/
/************************************/

/*		Various Filter Routines		*/
/*		-----------------------		*/
void 	UndoFilter(void);
void 	DoSmoothingFilter(void);
void	DoNoiseFilter(void);
void	DoHistogram(void);
void 	DoEqualizeFilter(void);

/*		Histogram Dialog Routines	*/
/*		-------------------------	*/
void 	DrawHistDialog(void);
Boolean InitHistDialog(void);
void 	OpenHistDialog(void);
void 	CloseHistDialog(void);

/*		More Filters...				*/
/*		---------------				*/
void	DoFillFilter(void);
void 	ExpandBlobs(void);

/*		Gradient Filter Routines	*/
/*		------------------------	*/
void 	ShowGradWindow(void);
Boolean InitGradWindow(void);
void 	OpenGradWindow(void);
void 	CloseGradWindow(void);

/*		Threshold Filter Routines	*/
/*		-------------------------	*/

void	ShowThrsWindow(void);
Boolean InitThrsWindow(void);
void	OpenThrsWindow(void);
void 	CloseThrsWindow(void);

/*		Threshold Dialog Routines	*/
/*		-------------------------	*/
Boolean InitThresholdDialog(void);
void	OpenThresholdDialog(void);


/************************************/
/*		params.c prototypes			*/
/************************************/

/*		Global Parameter Dialog Routines	*/
/*		--------------------------------	*/
Boolean InitGlobalDialog(void);
void 	OpenGlobalDialog(void);

/*		Model Parameter Dialog Routines		*/
/*		-------------------------------		*/
Boolean InitRefParamDialog(void);
void 	OpenRefParamDialog(void);
Boolean InitTestParamDialog(void);
void 	OpenTestParamDialog(void);


/************************************/
/*		model.c prototypes			*/
/************************************/

/*		Model Placement Routines	*/
/*		------------------------	*/
void 	ClearModel(ModelPtr model);
void 	PictPoint(Point p, WindowPtr wind);
void 	BuildSpringsFromParticles(ModelPtr model);

/*		Model Placement Dialog Routines	*/
/*		-------------------------------	*/
void 	DrawPlaceDialog(void);
void 	SetPlaceDone(void);
void 	PlaceDelOne(void);
Boolean InitPlaceDialog(void);
void	OpenPlaceDialog(void);
void 	ClosePlaceDialog(void);

/*		Execution Dialog Routines	*/
/*		-------------------------	*/
void 	DrawExecDialog(void);
Boolean InitExecDialog(void);
void 	OpenExecDialog(void);
void	CloseExecDialog(void);

/*		Model Drawing Routines		*/
/*		----------------------		*/
void 	DrawModel(ModelPtr model, WindowPtr window);

/*		Model Execution Routines	*/
/*		------------------------	*/
void	UpdateModel(ModelPtr model);
void	RelaxModel(void);
void 	ExecuteOneCycle(void);

/*		Model Load/Save				*/
/*		---------------				*/
void 	LoadModel(void);
void 	SaveModelAs(void);


/************************************/
/*		utility.c prototypes		*/
/************************************/

/*		Progress Bar Routines		*/
/*		---------------------		*/
Boolean	InitProgressDialog(void);
void	InitProgressBar(Str255 string);
void 	DrawProgressBar(short count, short max);
void	KillProgressBar(void);

/*		Options Dialog Routines		*/
/*		-----------------------		*/
Boolean InitOptionsDialog(void);
void	OpenOptionsDialog(void);

/*		Message Communication Routines	*/
/*		------------------------------	*/
void 	DoError(Str255 errorString);
void 	DoWarning(Str255 errorString);
void 	ReportFreeMem(Str255 str);

/*		Image Data Transfer Routines	*/
/*		----------------------------	*/
void 	CopyGWorld2Window(GWorldPtr world, WindowPtr wind, Rect *rect);
void 	CopyGWorld2Array(GWorldPtr world, Array *array, Rect *rect);
void 	CopyArray2GWorld(Array *array, GWorldPtr world, Rect *rect);

/*		Various Dialog Routines			*/
/*		-----------------------			*/
void 	DrawDlogColorBox(DialogPtr dlog, short item, RGBColor rgb);
Boolean PtInDlogColorBox(Point pt, DialogPtr dlog, short item);
void 	PickDlogColor(StringPtr str, DialogPtr dlog, short item, RGBColor *rgb);
void	DrawParticleStatus(DialogPtr dlog, short item, ModelPtr model, Boolean sideB);

/*		Vector Operation Routines		*/
/*		-------------------------		*/
void 	SetVector(Vector *v, Scalar x, Scalar y);
Scalar	Distance(Vector v1, Vector v2);
Scalar	Magnitude(Vector v);
void 	Direction(Vector vin, Vector *vout);
void 	VectorSum(Vector v1, Vector v2, Vector *vsum);
void 	VectorDifference(Vector v1, Vector v2, Vector *vdiff);
void 	VectorByScalar(Vector vin, Scalar s, Vector *vprod);
Scalar 	DotProduct(Vector v1, Vector v2);
Boolean	Constrain(Vector *v, Rect r);

/*		Array Routines					*/
/*		--------------					*/
void 	OpenArray(Array *array, short eSize, Size numElems);
void	CloseArray(Array *array);
Ptr		LockArray(Array *array);
void 	UnlockArray(Array *array);

/*		Preferences & Resource Routines	*/
/*		-------------------------------	*/
void 	LoadDefault(Ptr *dest, Ptr item, Size size);
void 	LoadPreference(Ptr dest, Size size, ResType rType, short rID);
void 	SetWPos(WindowPtr wptr, short rID);
void 	SaveWPos(WindowPtr wptr, WPosHandle *wpos);
void 	SaveResource(Handle h, ResType rType, short rID, StringPtr rName);
void 	SavePtrRsrc(Ptr p, Size size, ResType rType, short rID, StringPtr rName);

/*		Miscellaneous Routines			*/
/*		----------------------			*/
short 	MinShort(short a, short b);
void 	AdjustMenus(Boolean enable);
void 	HNullCheck(Handle handle);
void	ScalarToPString(Scalar num, StringPtr str, char *fmt);
void 	PStringToScalar(StringPtr str, Scalar *num);
void 	SetCustomPalette(void);