Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

vmd.h

Go to the documentation of this file.
00001 /***************************************************************************
00002  *cr
00003  *cr            (C) Copyright 1995-2019 The Board of Trustees of the
00004  *cr                        University of Illinois
00005  *cr                         All Rights Reserved
00006  *cr
00007  ***************************************************************************/
00008 
00009 /***************************************************************************
00010  * RCS INFORMATION:
00011  *
00012  *      $RCSfile: vmd.h,v $
00013  *      $Author: johns $        $Locker:  $             $State: Exp $
00014  *      $Revision: 1.12 $       $Date: 2019/01/17 21:21:03 $
00015  *
00016  ***************************************************************************
00017  * DESCRIPTION:
00018  *
00019  * Main program interface header.
00020  *
00021  ***************************************************************************/
00022 
00023 #ifndef VMD_H_
00024 #define VMD_H_
00025 
00026 // This header file contains all the functions exported by the VMD library
00027 // for various VMD implementations; e.g. standalone executable, Python 
00028 // module, etc.
00029 
00030 #ifdef ANDROID
00031 // prototype for main program JNI shared library entry point 
00032 int VMDmain(int argc, char **argv);
00033 #endif
00034 
00035 #include "VMDApp.h"
00036 
00037 // Perform various one-time startup operations prior to creating a
00038 // VMDApp instance.  Reads the command line arguments, processes environnment
00039 // variables, and prepares a set startup operations that will be carried
00040 // out by VMDreadStartup.  Upon return, *argc will be set to the number of 
00041 // unprocessed arguments that should be passed to VMDinit, including argv[0]
00042 // (the path to the executable) and argv will hold the arguments themselves.
00043 // The mpienabled flag tells VMD whether to initialize MPI or not
00044 extern int VMDinitialize(int *argc, char ***argv, int mpienabled);
00045 
00046 // Return the display type name that was chosen by VMDinitialize()
00047 extern const char *VMDgetDisplayTypeName();
00048 
00049 // Return the display location and display size that were chosen by
00050 // VMDinitialize()
00051 extern void VMDgetDisplayFrame(int *loc, int *size);
00052 
00053 // read various default settings defined in scripts/vmd/.  Should be done
00054 // after a successful VMDinitialize, but before VMDreadStartup().
00055 void VMDreadInit(VMDApp *app);
00056  
00057 // Get the unprocessed command line arguments 
00058 // Read startup files (.vmdrc, -e files), and load molecules specified on
00059 // the command line.  Must be called _after_ calling VMDinitialize()
00060 extern void VMDreadStartup(VMDApp *);
00061 
00062 // Shut down VMD properly, after all VMDApp instances have been deleted
00063 // The mpienabled flag tells VMD whether to shutdown MPI or not
00064 extern void VMDshutdown(int mpienabled);
00065 
00066 // check for Fltk events, if available.
00067 extern void VMDupdateFltk();
00068 
00069 #endif

Generated on Thu Mar 28 02:44:20 2024 for VMD (current) by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002