OpenFrames
Macros | Functions
OF_Interface.h File Reference
#include <OpenFrames/Export.h>

Go to the source code of this file.

Macros

#define OF_FCN(name)   name
 
#define OF_CHARARG(name)   const char *name
 
#define OF_STRING(name)   name
 
#define BASIC_CALLBACK_SIG   unsigned int *winID, unsigned int *row, unsigned int *col
 
#define KEYPRESS_SIG   BASIC_CALLBACK_SIG, int *key
 
#define MOUSEMOTION_SIG   BASIC_CALLBACK_SIG, float *x, float *y
 
#define BUTTON_SIG   MOUSEMOTION_SIG, unsigned int *button
 

Functions

OF_EXPORT void OF_FCN() of_initialize ()
 
OF_EXPORT void OF_FCN() of_cleanup ()
 
OF_EXPORT void OF_FCN() of_getreturnedvalue (int *val)
 
OF_EXPORT void OF_FCN() ofwin_activate (unsigned int *id)
 
OF_EXPORT void OF_FCN() ofwin_getid (unsigned int *retid)
 
OF_EXPORT void OF_FCN() ofwin_createproxy (int *x, int *y, unsigned int *width, unsigned int *height, unsigned int *nrow, unsigned int *ncol, bool *embedded, unsigned int *id)
 
OF_EXPORT void OF_FCN() ofwin_setwindowname (OF_CHARARG(winname))
 
OF_EXPORT void OF_FCN() ofwin_setgridsize (int *nrow, int *ncol)
 
OF_EXPORT void OF_FCN() ofwin_setkeypresscallback (void(*fcn)(KEYPRESS_SIG))
 
OF_EXPORT void OF_FCN() ofwin_setmousemotioncallback (void(*fcn)(MOUSEMOTION_SIG))
 
OF_EXPORT void OF_FCN() ofwin_setbuttonpresscallback (void(*fcn)(BUTTON_SIG))
 
OF_EXPORT void OF_FCN() ofwin_setbuttonreleasecallback (void(*fcn)(BUTTON_SIG))
 
OF_EXPORT void OF_FCN() ofwin_start ()
 
OF_EXPORT void OF_FCN() ofwin_stop ()
 
OF_EXPORT void OF_FCN() ofwin_signalstop ()
 
OF_EXPORT void OF_FCN() ofwin_waitforstop ()
 
OF_EXPORT void OF_FCN() ofwin_pauseanimation (bool *pause)
 
OF_EXPORT void OF_FCN() ofwin_isrunning (unsigned int *state)
 
OF_EXPORT void OF_FCN() ofwin_settime (double *time)
 
OF_EXPORT void OF_FCN() ofwin_gettime (double *time)
 
OF_EXPORT void OF_FCN() ofwin_pausetime (bool *pause)
 
OF_EXPORT void OF_FCN() ofwin_istimepaused (bool *isPaused)
 
OF_EXPORT void OF_FCN() ofwin_settimescale (double *tscale)
 
OF_EXPORT void OF_FCN() ofwin_gettimescale (double *tscale)
 
OF_EXPORT void OF_FCN() ofwin_setlightambient (unsigned int *row, unsigned int *col, float *r, float *g, float *b)
 
OF_EXPORT void OF_FCN() ofwin_setlightdiffuse (unsigned int *row, unsigned int *col, float *r, float *g, float *b)
 
OF_EXPORT void OF_FCN() ofwin_setlightspecular (unsigned int *row, unsigned int *col, float *r, float *g, float *b)
 
OF_EXPORT void OF_FCN() ofwin_setlightposition (unsigned int *row, unsigned int *col, float *x, float *y, float *z, float *w)
 
OF_EXPORT void OF_FCN() ofwin_setscene (unsigned int *row, unsigned int *col)
 
OF_EXPORT void OF_FCN() ofwin_setstereo (unsigned int *row, unsigned int *col, bool *enable, float *eyeseparation, float *width, float *height, float *distance)
 
OF_EXPORT void OF_FCN() ofwin_setbackgroundcolor (unsigned int *row, unsigned int *col, float *r, float *g, float *b)
 
OF_EXPORT void OF_FCN() ofwin_setbackgroundtexture (unsigned int *row, unsigned int *col, OF_CHARARG(fname))
 
OF_EXPORT void OF_FCN() ofwin_setbackgroundstardata (unsigned int *row, unsigned int *col, float *minMag, float *maxMag, OF_CHARARG(fname))
 
OF_EXPORT void OF_FCN() ofwin_enablehudtext (unsigned int *row, unsigned int *col, bool *enable)
 
OF_EXPORT void OF_FCN() ofwin_sethudtextfont (unsigned int *row, unsigned int *col, OF_CHARARG(fname))
 
OF_EXPORT void OF_FCN() ofwin_sethudtextparameters (unsigned int *row, unsigned int *col, float *r, float *g, float *b, float *charSize)
 
OF_EXPORT void OF_FCN() ofwin_sethudtextposition (unsigned int *row, unsigned int *col, float *x, float *y, unsigned int *alignment)
 
OF_EXPORT void OF_FCN() ofwin_sethudtext (unsigned int *row, unsigned int *col, OF_CHARARG(text))
 
OF_EXPORT void OF_FCN() ofwin_setswapbuffersfunction (void(*fcn)(unsigned int *winID))
 
OF_EXPORT void OF_FCN() ofwin_setmakecurrentfunction (void(*fcn)(unsigned int *winID, bool *success))
 
OF_EXPORT void OF_FCN() ofwin_setupdatecontextfunction (void(*fcn)(unsigned int *winID, bool *success))
 
OF_EXPORT void OF_FCN() ofwin_resizewindow (int *x, int *y, unsigned int *width, unsigned int *height)
 
OF_EXPORT void OF_FCN() ofwin_keypress (unsigned int *key)
 
OF_EXPORT void OF_FCN() ofwin_keyrelease (unsigned int *key)
 
OF_EXPORT void OF_FCN() ofwin_buttonpress (float *x, float *y, unsigned int *button)
 
OF_EXPORT void OF_FCN() ofwin_buttonrelease (float *x, float *y, unsigned int *button)
 
OF_EXPORT void OF_FCN() ofwin_mousemotion (float *x, float *y)
 
OF_EXPORT void OF_FCN() ofwin_setdesiredframerate (double *fps)
 
OF_EXPORT void OF_FCN() ofwin_addview (unsigned int *row, unsigned int *col)
 
OF_EXPORT void OF_FCN() ofwin_removeview (unsigned int *row, unsigned int *col)
 
OF_EXPORT void OF_FCN() ofwin_removeallviews (unsigned int *row, unsigned int *col)
 
OF_EXPORT void OF_FCN() ofwin_selectview (unsigned int *row, unsigned int *col)
 
OF_EXPORT void OF_FCN() ofwin_capturewindow ()
 
OF_EXPORT void OF_FCN() ofwin_setwindowcapturefile (OF_CHARARG(fname), OF_CHARARG(fext))
 
OF_EXPORT void OF_FCN() ofwin_setwindowcapturekey (int *key)
 
OF_EXPORT void OF_FCN() offm_activate (int *id)
 
OF_EXPORT void OF_FCN() offm_create (int *id)
 
OF_EXPORT void OF_FCN() offm_setframe ()
 
OF_EXPORT void OF_FCN() offm_lock ()
 
OF_EXPORT void OF_FCN() offm_unlock ()
 
OF_EXPORT void OF_FCN() offrame_activate (OF_CHARARG(name))
 
OF_EXPORT void OF_FCN() offrame_create (OF_CHARARG(name))
 
OF_EXPORT void OF_FCN() offrame_setcolor (float *r, float *g, float *b, float *a)
 
OF_EXPORT void OF_FCN() offrame_addchild (OF_CHARARG(name))
 Add a child frame to the current frame. More...
 
OF_EXPORT void OF_FCN() offrame_removechild (OF_CHARARG(name))
 
OF_EXPORT void OF_FCN() offrame_removeallchildren ()
 
OF_EXPORT void OF_FCN() offrame_getnumchildren (int *numchildren)
 
OF_EXPORT void OF_FCN() offrame_setposition (double *x, double *y, double *z)
 
OF_EXPORT void OF_FCN() offrame_getposition (double *x, double *y, double *z)
 
OF_EXPORT void OF_FCN() offrame_setattitude (double *rx, double *ry, double *rz, double *angle)
 
OF_EXPORT void OF_FCN() offrame_getattitude (double *rx, double *ry, double *rz, double *angle)
 
OF_EXPORT void OF_FCN() offrame_showaxes (unsigned int *axes)
 
OF_EXPORT void OF_FCN() offrame_shownamelabel (bool *namelabel)
 
OF_EXPORT void OF_FCN() offrame_showaxeslabels (unsigned int *labels)
 
OF_EXPORT void OF_FCN() offrame_setnamelabel (OF_CHARARG(name))
 
OF_EXPORT void OF_FCN() offrame_setaxeslabels (OF_CHARARG(xlabel), OF_CHARARG(ylabel), OF_CHARARG(zlabel))
 
OF_EXPORT void OF_FCN() offrame_movexaxis (double pos[], double *length, double *headRatio, double *bodyRadius, double *headRadius)
 
OF_EXPORT void OF_FCN() offrame_moveyaxis (double pos[], double *length, double *headRatio, double *bodyRadius, double *headRadius)
 
OF_EXPORT void OF_FCN() offrame_movezaxis (double pos[], double *length, double *headRatio, double *bodyRadius, double *headRadius)
 
OF_EXPORT void OF_FCN() offrame_setlightsourceenabled (bool *enabled)
 
OF_EXPORT void OF_FCN() offrame_getlightsourceenabled (bool *enabled)
 
OF_EXPORT void OF_FCN() offrame_setlightambient (float *r, float *g, float *b)
 
OF_EXPORT void OF_FCN() offrame_setlightdiffuse (float *r, float *g, float *b)
 
OF_EXPORT void OF_FCN() offrame_setlightspecular (float *r, float *g, float *b)
 
OF_EXPORT void OF_FCN() offrame_followtrajectory (OF_CHARARG(name))
 
OF_EXPORT void OF_FCN() offrame_followtype (int *data, int *mode)
 
OF_EXPORT void OF_FCN() offrame_followposition (int src[], unsigned int element[], unsigned int opt[], double scale[])
 
OF_EXPORT void OF_FCN() offrame_managetime (bool *affectChildren, bool *reset, bool *changePauseState, bool *pauseState, bool *changeOffsetTime, double *offsetTime, bool *changeTimeScale, double *timeScale)
 
OF_EXPORT void OF_FCN() offrame_printframestring ()
 
OF_EXPORT void OF_FCN() ofsphere_create (OF_CHARARG(name))
 
OF_EXPORT void OF_FCN() ofsphere_setradius (double *radius)
 
OF_EXPORT void OF_FCN() ofsphere_settexturemap (OF_CHARARG(fname))
 
OF_EXPORT void OF_FCN() ofsphere_setnighttexturemap (OF_CHARARG(fname))
 
OF_EXPORT void OF_FCN() ofsphere_setautolod (bool *lod)
 
OF_EXPORT void OF_FCN() ofsphere_setsphereposition (double *x, double *y, double *z)
 
OF_EXPORT void OF_FCN() ofsphere_setsphereattitude (double *rx, double *ry, double *rz, double *angle)
 
OF_EXPORT void OF_FCN() ofsphere_setspherescale (double *sx, double *sy, double *sz)
 
OF_EXPORT void OF_FCN() ofsphere_setmaterialambient (float *r, float *g, float *b)
 
OF_EXPORT void OF_FCN() ofsphere_setmaterialdiffuse (float *r, float *g, float *b)
 
OF_EXPORT void OF_FCN() ofsphere_setmaterialspecular (float *r, float *g, float *b)
 
OF_EXPORT void OF_FCN() ofsphere_setmaterialemission (float *r, float *g, float *b)
 
OF_EXPORT void OF_FCN() ofsphere_setmaterialshininess (float *shininess)
 
OF_EXPORT void OF_FCN() ofmodel_create (OF_CHARARG(name))
 
OF_EXPORT void OF_FCN() ofmodel_setmodel (OF_CHARARG(fname))
 
OF_EXPORT void OF_FCN() ofmodel_setmodelposition (double *x, double *y, double *z)
 
OF_EXPORT void OF_FCN() ofmodel_getmodelposition (double *x, double *y, double *z)
 
OF_EXPORT void OF_FCN() ofmodel_setmodelscale (double *sx, double *sy, double *sz)
 
OF_EXPORT void OF_FCN() ofmodel_getmodelscale (double *sx, double *sy, double *sz)
 
OF_EXPORT void OF_FCN() ofmodel_setmodelpivot (double *px, double *py, double *pz)
 
OF_EXPORT void OF_FCN() ofmodel_getmodelpivot (double *px, double *py, double *pz)
 
OF_EXPORT void OF_FCN() ofmodel_getmodelsize (double *size)
 
OF_EXPORT void OF_FCN() ofdrawtraj_create (OF_CHARARG(name))
 
OF_EXPORT void OF_FCN() ofdrawtraj_addartist (OF_CHARARG(name))
 
OF_EXPORT void OF_FCN() ofdrawtraj_removeartist (OF_CHARARG(name))
 
OF_EXPORT void OF_FCN() ofdrawtraj_removeallartists ()
 
OF_EXPORT void OF_FCN() ofcoordaxes_create (OF_CHARARG(name))
 
OF_EXPORT void OF_FCN() ofcoordaxes_setaxislength (double *len)
 
OF_EXPORT void OF_FCN() ofcoordaxes_setdrawaxes (unsigned int *axes)
 
OF_EXPORT void OF_FCN() ofcoordaxes_settickspacing (double *major, double *minor)
 
OF_EXPORT void OF_FCN() ofcoordaxes_setticksize (unsigned int *major, unsigned int *minor)
 
OF_EXPORT void OF_FCN() ofcoordaxes_settickimage (OF_CHARARG(fname))
 
OF_EXPORT void OF_FCN() ofcoordaxes_settickshader (OF_CHARARG(fname))
 
OF_EXPORT void OF_FCN() oflatlongrid_create (OF_CHARARG(name))
 
OF_EXPORT void OF_FCN() oflatlongrid_setparameters (double *radius, double *latSpace, double *lonSpace)
 
OF_EXPORT void OF_FCN() ofradialplane_create (OF_CHARARG(name))
 
OF_EXPORT void OF_FCN() ofradialplane_setparameters (double *radius, double *radSpace, double *lonSpace)
 
OF_EXPORT void OF_FCN() ofradialplane_setplanecolor (float *r, float *g, float *b, float *a)
 
OF_EXPORT void OF_FCN() ofradialplane_setlinecolor (float *r, float *g, float *b, float *a)
 
OF_EXPORT void OF_FCN() oftraj_activate (OF_CHARARG(name))
 
OF_EXPORT void OF_FCN() oftraj_create (OF_CHARARG(name), unsigned int *dof, unsigned int *numopt)
 
OF_EXPORT void OF_FCN() oftraj_setnumoptionals (unsigned int *nopt)
 
OF_EXPORT void OF_FCN() oftraj_setdof (unsigned int *dof)
 
OF_EXPORT void OF_FCN() oftraj_addtime (const double *t)
 
OF_EXPORT void OF_FCN() oftraj_addposition (const double *x, const double *y, const double *z)
 
OF_EXPORT void OF_FCN() oftraj_addpositionvec (const double pos[])
 
OF_EXPORT void OF_FCN() oftraj_addattitude (const double *x, const double *y, const double *z, const double *w)
 
OF_EXPORT void OF_FCN() oftraj_addattitudevec (const double att[])
 
OF_EXPORT void OF_FCN() oftraj_setoptional (unsigned int *index, const double *x, const double *y, const double *z)
 
OF_EXPORT void OF_FCN() oftraj_setoptionalvec (unsigned int *index, const double opt[])
 
OF_EXPORT void OF_FCN() oftraj_clear ()
 
OF_EXPORT void OF_FCN() oftraj_informartists ()
 
OF_EXPORT void OF_FCN() oftraj_autoinformartists (bool *autoinform)
 
OF_EXPORT void OF_FCN() oftrajartist_activate (OF_CHARARG(name))
 
OF_EXPORT void OF_FCN() oftrajartist_settrajectory ()
 
OF_EXPORT void OF_FCN() ofcurveartist_create (OF_CHARARG(name))
 
OF_EXPORT void OF_FCN() ofcurveartist_setxdata (int *src, unsigned int *element, unsigned int *opt, double *scale)
 
OF_EXPORT void OF_FCN() ofcurveartist_setydata (int *src, unsigned int *element, unsigned int *opt, double *scale)
 
OF_EXPORT void OF_FCN() ofcurveartist_setzdata (int *src, unsigned int *element, unsigned int *opt, double *scale)
 
OF_EXPORT void OF_FCN() ofcurveartist_setcolor (float *r, float *g, float *b)
 
OF_EXPORT void OF_FCN() ofcurveartist_setwidth (float *width)
 
OF_EXPORT void OF_FCN() ofcurveartist_setpattern (int *factor, unsigned short *pattern)
 
OF_EXPORT void OF_FCN() ofsegmentartist_create (OF_CHARARG(name))
 
OF_EXPORT void OF_FCN() ofsegmentartist_setstartxdata (int *src, unsigned int *element, unsigned int *opt, double *scale)
 
OF_EXPORT void OF_FCN() ofsegmentartist_setstartydata (int *src, unsigned int *element, unsigned int *opt, double *scale)
 
OF_EXPORT void OF_FCN() ofsegmentartist_setstartzdata (int *src, unsigned int *element, unsigned int *opt, double *scale)
 
OF_EXPORT void OF_FCN() ofsegmentartist_setendxdata (int *src, unsigned int *element, unsigned int *opt, double *scale)
 
OF_EXPORT void OF_FCN() ofsegmentartist_setendydata (int *src, unsigned int *element, unsigned int *opt, double *scale)
 
OF_EXPORT void OF_FCN() ofsegmentartist_setendzdata (int *src, unsigned int *element, unsigned int *opt, double *scale)
 
OF_EXPORT void OF_FCN() ofsegmentartist_setstride (unsigned int *stride)
 
OF_EXPORT void OF_FCN() ofsegmentartist_setcolor (float *r, float *g, float *b)
 
OF_EXPORT void OF_FCN() ofsegmentartist_setwidth (float *width)
 
OF_EXPORT void OF_FCN() ofsegmentartist_setpattern (int *factor, unsigned short *pattern)
 
OF_EXPORT void OF_FCN() ofmarkerartist_create (OF_CHARARG(name))
 
OF_EXPORT void OF_FCN() ofmarkerartist_setxdata (int *src, unsigned int *element, unsigned int *opt, double *scale)
 
OF_EXPORT void OF_FCN() ofmarkerartist_setydata (int *src, unsigned int *element, unsigned int *opt, double *scale)
 
OF_EXPORT void OF_FCN() ofmarkerartist_setzdata (int *src, unsigned int *element, unsigned int *opt, double *scale)
 
OF_EXPORT void OF_FCN() ofmarkerartist_setmarkers (unsigned int *markers)
 
OF_EXPORT void OF_FCN() ofmarkerartist_setmarkercolor (unsigned int *markers, float *r, float *g, float *b)
 
OF_EXPORT void OF_FCN() ofmarkerartist_setmarkerimage (OF_CHARARG(fname))
 
OF_EXPORT void OF_FCN() ofmarkerartist_setmarkershader (OF_CHARARG(fname))
 
OF_EXPORT void OF_FCN() ofmarkerartist_setintermediatetype (unsigned int *type)
 
OF_EXPORT void OF_FCN() ofmarkerartist_setintermediatespacing (double *spacing)
 
OF_EXPORT void OF_FCN() ofmarkerartist_setintermediatedirection (unsigned int *direction)
 
OF_EXPORT void OF_FCN() ofmarkerartist_setmarkersize (unsigned int *size)
 
OF_EXPORT void OF_FCN() ofmarkerartist_setautoattenuate (bool *autoattenuate)
 
OF_EXPORT void OF_FCN() ofview_activate (OF_CHARARG(name))
 
OF_EXPORT void OF_FCN() ofview_create (OF_CHARARG(name))
 
OF_EXPORT void OF_FCN() ofview_setorthographic (double *left, double *right, double *bottom, double *top)
 
OF_EXPORT void OF_FCN() ofview_setperspective (double *fov, double *ratio)
 
OF_EXPORT void OF_FCN() ofview_setviewframe (OF_CHARARG(root), OF_CHARARG(frame))
 
OF_EXPORT void OF_FCN() ofview_setviewbetweenframes (OF_CHARARG(root), OF_CHARARG(srcframe), OF_CHARARG(dstframe), unsigned int *frameType, unsigned int *rotationType)
 
OF_EXPORT void OF_FCN() ofview_setdefaultviewdistance (double *distance)
 
OF_EXPORT void OF_FCN() ofview_gettrackball (double eye[], double center[], double up[])
 
OF_EXPORT void OF_FCN() ofview_settrackball (double eye[], double center[], double up[])
 
OF_EXPORT void OF_FCN() ofview_isvalid (bool *valid)
 
OF_EXPORT void OF_FCN() ofview_reset ()
 

Detailed Description

All functions have a prefix indicating what they operate on:

In addition, some functions produce integer results. These values can be obtained by calling of_getreturnedvalue().

Macro Definition Documentation

◆ BASIC_CALLBACK_SIG

#define BASIC_CALLBACK_SIG   unsigned int *winID, unsigned int *row, unsigned int *col

Shortcut for a basic callback signature

◆ BUTTON_SIG

#define BUTTON_SIG   MOUSEMOTION_SIG, unsigned int *button

Shortcut for a button press callback signature

◆ KEYPRESS_SIG

#define KEYPRESS_SIG   BASIC_CALLBACK_SIG, int *key

Shortcut for a keypress callback signature

◆ MOUSEMOTION_SIG

#define MOUSEMOTION_SIG   BASIC_CALLBACK_SIG, float *x, float *y

Shortcut for a mouse motion callback signature

◆ OF_CHARARG

#define OF_CHARARG (   name)    const char *name

Macro to handle Fortran hidden character length arguments

◆ OF_FCN

#define OF_FCN (   name)    name

Function names stay as they are on all other interfaces This includes Intel Fortran and C compilers

◆ OF_STRING

#define OF_STRING (   name)    name

Macro to handle Fortran hidden string length arguments

Function Documentation

◆ offrame_addchild()

OF_EXPORT void OF_FCN() offrame_addchild ( OF_CHARARG(name)  )

Add a child frame to the current frame.

This applies to the current active ReferenceFrame. The currently active frame will remain active.

Parameters
nameName of the frame to add as a child to the active frame.