libFreeWRL.h

/*

  FreeWRL library API (public)

*/

/****************************************************************************
    This file is part of the FreeWRL/FreeX3D Distribution.

    Copyright 2009 CRC Canada. (http://www.crc.gc.ca)

    FreeWRL/FreeX3D is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    FreeWRL/FreeX3D is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with FreeWRL/FreeX3D.  If not, see <http://www.gnu.org/licenses/>.
****************************************************************************/


#ifndef __LIBFREEWRL_API_H__
#define __LIBFREEWRL_API_H__


/* for front ends that do not have these X-11-based defines */
// OLD_IPHONE_AQUA #if defined(AQUA) || defined(_MSC_VER) || defined(_ANDROID)

#if defined(_MSC_VER) || defined(_ANDROID)
#ifndef _MIMIC_X11_SCREEN_BUTTONS
        #define _MIMIC_X11_SCREEN_BUTTONS
                #define KeyPress        2
                #define KeyRelease      3
                #define ButtonPress     4
                #define ButtonRelease   5
                #define MotionNotify    6
                #define MapNotify       19
        #endif
#endif




#ifdef COMPILING_IPHONE_FRONT_END
        /* Ok, ok, ok. I know. Another definition. But, Objective-C gives lots of
           errors if the whole file is included, and also, we only need a couple of
           definitions to keep the front end as separate from the library as possible... */

        void fwl_initializeRenderSceneUpdateScene(void);
        

#else /* COMPILING_IPHONE_FRONT_END */

const char *libFreeWRL_get_version();

/* for front ends to get the versions */
const char *fwl_libFreeWRL_get_version(); /* library version */
const char *fwl_freewrl_get_version();  /* UI version */

typedef struct freewrl_params {
        /* Put here global parameters, parsed in main program
           and needed to initialize libFreeWRL
           example: width, height, fullscreen, multithreading, eai...
        */
        int width;
        int height;
        int xpos;
        int ypos;
        long int winToEmbedInto;
        bool fullscreen;
        bool multithreading;
        bool enableEAI;
        bool verbose;
        //int collision;        /* do collision detection? moved to x3d_viewer struct july 7, 2012*/
        bool frontend_handles_display_thread;
        //for multiple-context applications such as 2+ fw instances on a web page,
        //or a window app with 2+ fw windows - swapbuffers needs to know which one
        void *display;
        void *context;

        // generic place holder for current surface
        // on Linux, Window {aka long unsigned int} but Window definition is not used
        // everywhere this file is, so we store it as a pointer and just cast it.

        void *surface;

} freewrl_params_t;


/* FreeWRL parameters */
/*
 * These have been subject to abuse when then were all fw_params
 * At at Fri Apr 29 09:38:26 BST 2011 I expect lots of compiler messages.
 */
/* extern freewrl_params_t fv_params; */
/* extern freewrl_params_t OSX_params; */
void *fwl_init_instance();
void fwl_initParams( freewrl_params_t *params) ;

bool fwl_initFreeWRL(freewrl_params_t *params);
void closeFreeWRL();
void terminateFreeWRL();

int fwl_parse_geometry_string(const char *geometry, int *out_width, int *out_height, 
                              int *out_xpos, int *out_ypos);

int ConsoleMessage(const char *fmt, ...); /* This does not belong here!! */
//#endif

/* void Anchor_ReplaceWorld(char *name); */
bool Anchor_ReplaceWorld();

#define VIEWER_NONE 0     /* would have conflicted with another NONE definition */
#define VIEWER_EXAMINE 1
#define VIEWER_WALK 2
#define VIEWER_EXFLY 3
#define VIEWER_FLY 4
#define VIEWER_SPHERICAL 5
#define VIEWER_FLY2 6
#define VIEWER_TILT 7
#define VIEWER_TPLANE 8
#define VIEWER_RPLANE 9
#define VIEWER_TURNTABLE 10
#define VIEWER_LOOKAT 11
#define VIEWER_EXPLORE 12
#define VIEWER_YAWZ 13
#define VIEWER_XY 14
#define VIEWER_YAWPITCH 15
#define VIEWER_ROLL 16
#define VIEWER_DIST 17

#define CHORD_YAWZ 0
#define CHORD_YAWPITCH 1
#define CHORD_ROLL 2
#define CHORD_XY 3

void setStereoBufferStyle(int);


#define INT_ID_UNDEFINED -1


#define RUNNINGASPLUGIN (isBrowserPlugin)

extern char *BrowserFullPath;

extern int _fw_pipe, _fw_FD;
extern int _fw_browser_plugin;
extern int isBrowserPlugin;
#include <stdint.h>
extern uintptr_t _fw_instance;
//extern char *keypress_string;

#ifdef HAVE_LIBCURL
extern int with_libcurl;
#endif

#endif /* COMPILING_IPHONE_FRONT_END */

/* ** NEW DJ ** */

void fwl_set_strictParsing(bool flag);
void fwl_set_plugin_print(bool flag);
void fwl_set_occlusion_disable(bool flag);
void fwl_set_print_opengl_errors(bool flag);
void fwl_set_trace_threads(bool flag);
void fwl_set_texture_size(unsigned int texture_size);
void fwl_set_glClearColor (float red , float green , float blue , float alpha);
void fwl_thread_dump(void);
int fwg_get_unread_message_count(void);
char *fwg_get_last_message();
void fwl_set_logfile(char *);
void fwl_set_nameTest(char *);

#if defined(_ANDROID)
int DROIDDEBUG( const char*pFmtStr, ...);
void PRINTF_ALL( const char*pFmtStr, ...);
#endif


/* ** REPLACE DJ ** */
/* Try to replace the compile-time options in ConsoleMessage with run-time options */
// OLD_IPHONE_AQUA #ifdef AQUA
// OLD_IPHONE_AQUA      #define MC_DEF_AQUA 1
// OLD_IPHONE_AQUA #else
// OLD_IPHONE_AQUA      #define MC_DEF_AQUA 0
// OLD_IPHONE_AQUA #endif

// OLD_IPHONE_AQUA #ifdef TARGET_AQUA
// OLD_IPHONE_AQUA      #define MC_TARGET_AQUA 1
// OLD_IPHONE_AQUA #else
// OLD_IPHONE_AQUA      #define MC_TARGET_AQUA 0
// OLD_IPHONE_AQUA #endif

#ifdef OLDCODE 
OLDCODE#ifdef HAVE_MOTIF
OLDCODE #define MC_HAVE_MOTIF 1
OLDCODE#else
OLDCODE #define MC_HAVE_MOTIF 0
OLDCODE#endif
OLDCODE
OLDCODE#ifdef TARGET_MOTIF
OLDCODE #define MC_TARGET_MOTIF 1
OLDCODE#else
OLDCODE #define MC_TARGET_MOTIF 0
OLDCODE#endif
OLDCODE
OLDCODE#ifdef _MSC_VER
OLDCODE #define MC_MSC_HAVE_VER 1
OLDCODE#else
OLDCODE #define MC_MSC_HAVE_VER 0
OLDCODE#endif
#endif // OLDCODE



int fwl_StringConsoleMessage(char* message);

void fwl_init_SnapGif(void);
void fwl_init_PrintShot();
void fwl_set_SnapFile(const char* file);
void fwl_set_SnapTmp(const char* file);
void fwl_init_SnapSeq(); /* Was in main/headers.h */
void fwl_toggleSnapshot();
void fwl_set_LineWidth(float lwidth);
void fwl_set_KeyString(const char *str);
void fwl_set_SeqFile(const char* file);
void fwl_set_MaxImages(int max); 
void fwl_setCurXY(int x, int y);
void fwl_do_keyPress(char kp, int type);
void fwl_doQuit(char *, int);
void fwl_doQuitInstance(void *instance);
void fwl_updateScreenDim(int wi, int he);
void fwl_doQuitAndWait();
void fwl_set_viewer_type(const int type);
void fwl_set_modeRecord();
void fwl_set_modeFixture();
void fwl_set_modePlayback();

#define CHANNEL_EAI 0
//OLDCODE #define CHANNEL_MIDI 1

#define RxTx_STOP 0             /* Shutdown */
#define RxTx_START 1    /* Start */
#define RxTx_REFRESH 2  /* Read any pending input into PRIVATE buffer */
#define RxTx_EMPTY 4    /* Empty the private buffer */
#define RxTx_MOREVERBOSE 8
#define RxTx_SILENT 16
#define RxTx_SINK 32    /* Just throw away any future input */
#define RxTx_PENDING 64
#define RxTx_STOP_IF_DISCONNECT 128
#define RxTx_STATE 32768
#define RxTx_GET_VERBOSITY 65536

/* The first few functions do I/O */
int     fwlio_RxTx_control(int channel, int action);
char *  fwlio_RxTx_getbuffer(int channel) ;
void    fwlio_RxTx_sendbuffer(char *fromFile, int fromLine, int channel, char *str);
char *  fwlio_RxTx_waitfor(int channel, char *str);

void    fwl_init_EaiVerbose();
char *  fwl_EAI_handleBuffer(char *tempEAIdata);
int     fwl_EAI_allDone();
char *  fwl_EAI_handleRest();
//OLDCODE char *        fwl_MIDI_handleBuffer(char *tempEAIdata);

void fwl_set_ScreenDist(const char *optArg);
void fwl_init_StereoDefaults(void); //don't need to call now March 2012
void fwl_set_EyeDist(const char *optArg);
void fwl_init_Shutter(void);
void fwl_init_SideBySide(void);
void fwl_init_UpDown(void);
void fwl_set_AnaglyphParameter(const char *optArg);
void fwl_set_StereoParameter(const char *optArg);

// JAS obsolete void fwl_askForRefreshOK();

/* DISPLAY THREAD */
void fwl_initializeDisplayThread();
bool checkNetworkFile(const char *fn);
#define fwl_checkNetworkFile(a) checkNetworkFile(a)

/* PARSER THREAD */
void fwl_initialize_parser();
void fwl_initializeInputParseThread();
int fwl_isinputThreadParsing();
int fwl_isInputThreadInitialized();

/* TEXTURE THREAD */
void fwl_initializeTextureThread();
int fwl_isTextureinitialized();

/* PARSER THREAD */
int fwl_isTextureParsing();

void fwl_Next_ViewPoint(void);
void fwl_Prev_ViewPoint(void);
void fwl_First_ViewPoint(void);
void fwl_Last_ViewPoint(void);
void fwl_gotoViewpoint (char *findThisOne);

void fwl_startFreeWRL(const char *url);
/* distinguish instances from window event handler using the window handle */
int fwl_setCurrentHandle(void *handle, char*, int);
void fwl_clearCurrentHandle();
void *fwl_getCurrentHandle(char *, int);

void fwl_resource_push_single_request(const char *request);
void fwl_OSX_initializeParameters(const char* initialURL);
void fwl_resource_push_single_request_IE_main_scene(const char *request);

void fwg_frontEndReturningData(char* fileData,int length,int width,int height,bool hasAlpha);

/* from main/ConsoleMessage.c */
void fwg_setConsoleParam_maxLines(int);
void fwg_setConsoleParam_maxLineLength(int);
void fwg_setConsoleParam_replaceTabs(int);

void fwg_setFrontEndOnX3DFileLoadedListener(void (*frontEndOnX3DFileLoadedListener)(char *));


void fwg_frontEndReturningLocalFile(char *localfile, int iret);
void fwl_RenderSceneUpdateScene(void);
void fwl_gotoCurrentViewPoint();
void fwl_setScreenDim(int wi, int he);
void fwl_setScreenDim0(int wi, int he);
void fwl_setDensityFactor(float density_factor);
float fwl_getDensityFactor();
int fwl_hwnd_to_windex(void *hWnd);
void fwl_setScreenDim1(int wi, int he, int windex);
bool fwl_initialize_GL(void);
//void fwl_setLastMouseEvent(int etype);
int fwl_handle_aqua(const int mev, const unsigned int button, int x, int y);
//APPLE int fwl_handle_aqua1(const int mev, const unsigned int button, int x, int y, int windex);
int fwl_handle_mouse(int mev, int button, int x, int y, int windex);
int fwl_handle_touch(int mev, unsigned int ID, int x, int y, int windex);
void fwl_handle_gyro(float rx, float ry, float rz);
void fwl_handle_accelerometer(float ax, float ay, float az);
void fwl_handle_magnetic(float azimuth, float pitch, float roll);


/* JAS - moving OSX front end into 2011 code workings - these may change. */
void fwl_replaceWorldNeeded(char* str);
int fwl_pollPromptForURL(); /* poll from front end / UI in loop */
int fwl_pollPromptForFile();
void fwl_setPromptForURL(int state);
void fwl_setPromptForFile(int state);

char *fwg_frontEndWantsFileName(void);
int fv_display_initialize(void);
void fwl_initializeRenderSceneUpdateScene(void);
void fwl_setButDown(int button, int value);


/* IS - moving from main/headers.h to here for use in front-ends (bin/main.c calls some of these) */
int fwl_get_headlight();
char* fwl_getNavModeStr();
int fwl_getNavMode();
int fwl_getLookatMode();
int     fwl_getCollision();
void fwl_setCollision(int state);
int fwl_getAnaglyphSide(int whichSide);
int fwl_draw(); //use when frontend_handles_display_thread
void fwl_tmpFileLocation(char *tmpFileLocation);
void fwl_fontFileLocation(char *fontFileLocation);
int fwl_set_ui_colorscheme(char *colorschemename);
void fwl_set_ui_colors(char *fourhtmlcolors);
void fwl_get_ui_color(char *use, float *rgb);
char *fwl_get_ui_colorschemename();
void fwl_next_ui_colorscheme();
int fwl_get_ui_color_changed();
int fwl_set_sbh_pin_option(char *optarg);
int fwl_set_sbh_want_option(char *optarg);
void fwl_setShadingStyle(int style);
void fwl_set_sbh_pin(int sb, int mb);
void fwl_get_sbh_pin(int *sb, int *mb);
void fwl_set_target_fps(int target_fps);
int fwl_get_target_fps();
void fwl_set_sbh_wantMenubar(int want);
int fwl_get_sbh_wantMenubar();
void fwl_set_sbh_wantStatusbar(int want);
int fwl_get_sbh_wantStatusbar();

int fwl_commandline(char *cmdline);
int fwl_getShift();
void fwl_setShift(int ishift);
int fwl_getHover();
void fwl_setHover(int hover);
int fwl_getPedal();
void fwl_setPedal(int pedal);
int fwl_getCtrl();
void fwl_set_emulate_multitouch(int ion);
int fwl_get_emulate_multitouch();

// a few function prototypes from around libfreewrl
void fwl_setConsole_writePrimitive(int ibool);
void statusbar_set_window_size(int width, int height);
int statusbar_handle_mouse(int mev, int butnum, int mouseX, int mouseY);
int getCursorStyle();
void *fwl_frontenditem_dequeue();
char* fwl_resitem_getURL(void *res);
char* fwl_resitem_getTempDir(void *res);
void fwl_resitem_setActualFile(void *res, char *fname);
int     fwl_resitem_getStatus(void *res);
int     fwl_resitem_getType(void *res);
int     fwl_resitem_getMediaType(void *res);
void fwl_resitem_enqueuNextMulti(void *res);
void fwl_resitem_setLocalPath(void *res, char* path);
void fwl_resitem_enqueue(void *res);
void fwl_resitem_setDownloadThread(void *res, void *thread);
void *fwl_resitem_getDownloadThread(void *res);
void *fwl_resitem_getGlobal(void *res);

int file2blob(void *res);
#ifdef SSR_SERVER
//SSR (Server-side rendering)
void SSRserver_enqueue_request_and_wait(void *fwctx, void *request);
#endif //SSR_SERVER

#endif /* __LIBFREEWRL_API_H__ */