ANY-maze Help > The ANY-maze reference > ANY-maze plug-ins > The PlugIn.h header file

The PlugIn.h header file

The PlugIn.h header file defines the link between ANY-maze and a plug-in. Although this file is a C/C++ header, it is very short and doubtless authors will find it easy to convert to other languages if required.

The listing

/*---------------------------------------------------------------------------------

Name : PlugIn.h

Description : Header file for the ANY-maze Plug-in API which defines

how ANY-maze plug-ins interface to ANY-maze.

History

-------

7/2/2008 CPL Created file

-----------------------------------------------------------------------------------*/

//Messages

#define AME_ENUMERATE 1

#define AME_GETNAME 2

#define AME_GETHELPTITLE 3

#define AME_GETHELPINTRO 4

#define AME_GETHELPDETAILS 5

#define AME_GETRESULTTYPE 6

#define AME_EDITSETTINGS 7

#define AME_TESTSTART 8

#define AME_POSN 9

#define AME_TESTEND 10

#define AME_TESTABORT 11

//Return codes

#define AME_OK 0

#define AME_NOTIMPLEMENTED 1

#define AME_ERROR 2

#define AME_CANCELLED 3

//Result types

#define RT_NONE -1

#define RT_ONOFF 0

#define RT_VALUE 1

#define RT_CUMULATIVE 2

//Structure used to pass test data for a AME_TESTSTART message

typedef struct {

DWORD AnimalNum;

char AnimalID[80];

DWORD TrialNum;

RECT ApparatusRect;

double Scaling;

LPVOID Settings;

DWORD SettingsSize;

LPVOID Context;

}AME_TESTDATA, *LPAME_TESTDATA;

//Structure used to pass position data for a AME_POSN message

typedef struct {

LPVOID Context;

DWORD Time_xy;

int x;

int y;

DWORD Time_HeadTail;

int hx;

int hy;

int tx;

int ty;

int cx;

int cy;

bool Hidden;

RECT AnimalArea;

int ResultType;

int ResultValue;

}AME_POSNDATA, *LPAME_POSNDATA;

ANY-maze help topic T1003