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

py_display.C File Reference

#include "py_commands.h"
#include "VMDApp.h"
#include "DisplayDevice.h"

Go to the source code of this file.

Functions

PyObject * py_update (PyObject *self, PyObject *args)
PyObject * py_update_ui (PyObject *self, PyObject *args)
PyObject * py_update_on (PyObject *self, PyObject *args)
PyObject * py_update_off (PyObject *self, PyObject *args)
PyObject * py_set (PyObject *self, PyObject *args, PyObject *kwargs)
PyObject * py_get (PyObject *self, PyObject *args, PyObject *kwargs)
PyObject * py_stereomodes (PyObject *self, PyObject *args)
PyObject * initdisplay ()

Variables

const char update_doc []
const char update_ui_doc []
const char update_on_doc []
const char update_off_doc []
const char set_doc []
char get_doc []
const char stereomodes_doc []
PyMethodDef DisplayMethods []
const char disp_moddoc []


Function Documentation

PyObject* initdisplay  
 

Definition at line 402 of file py_display.C.

References disp_moddoc, and DisplayMethods.

PyObject* py_get PyObject *    self,
PyObject *    args,
PyObject *    kwargs
[static]
 

Definition at line 236 of file py_display.C.

References DisplayDevice::aa_enabled, DisplayDevice::ao_enabled, as_pystring, DisplayDevice::cueing_enabled, DisplayDevice::culling_enabled, VMDApp::display, VMDApp::display_get_size, DisplayDevice::distance_to_screen, DisplayDevice::dof_enabled, DisplayDevice::eye_dist, DisplayDevice::eyesep, DisplayDevice::far_clip, DisplayDevice::get_ao_ambient, DisplayDevice::get_ao_direct, DisplayDevice::get_dof_fnumber, DisplayDevice::get_dof_focal_dist, DisplayDevice::get_projection, get_vmdapp, DisplayDevice::near_clip, NULL, result, DisplayDevice::screen_height, DisplayDevice::shadows_enabled, DisplayDevice::stereo_mode, and DisplayDevice::stereo_name.

PyObject* py_set PyObject *    self,
PyObject *    args,
PyObject *    kwargs
[static]
 

Definition at line 103 of file py_display.C.

References as_int, VMDApp::display, VMDApp::display_set_aa, VMDApp::display_set_ao, VMDApp::display_set_ao_ambient, VMDApp::display_set_ao_direct, VMDApp::display_set_culling, VMDApp::display_set_depthcue, VMDApp::display_set_dof, VMDApp::display_set_dof_fnumber, VMDApp::display_set_dof_focal_dist, VMDApp::display_set_eyesep, VMDApp::display_set_farclip, VMDApp::display_set_focallen, VMDApp::display_set_nearclip, VMDApp::display_set_projection, VMDApp::display_set_screen_distance, VMDApp::display_set_screen_height, VMDApp::display_set_shadows, VMDApp::display_set_size, VMDApp::display_set_stereo, DisplayDevice::far_clip, get_vmdapp, is_pystring, DisplayDevice::near_clip, NULL, and size.

PyObject* py_stereomodes PyObject *    self,
PyObject *    args
[static]
 

Definition at line 345 of file py_display.C.

References as_pystring, VMDApp::display, get_vmdapp, NULL, num, DisplayDevice::num_stereo_modes, and DisplayDevice::stereo_name.

PyObject* py_update PyObject *    self,
PyObject *    args
[static]
 

Definition at line 27 of file py_display.C.

References VMDApp::display_update, get_vmdapp, and NULL.

PyObject* py_update_off PyObject *    self,
PyObject *    args
[static]
 

Definition at line 69 of file py_display.C.

References VMDApp::display_update_on, get_vmdapp, and NULL.

PyObject* py_update_on PyObject *    self,
PyObject *    args
[static]
 

Definition at line 55 of file py_display.C.

References VMDApp::display_update_on, get_vmdapp, and NULL.

PyObject* py_update_ui PyObject *    self,
PyObject *    args
[static]
 

Definition at line 41 of file py_display.C.

References VMDApp::display_update_ui, get_vmdapp, and NULL.


Variable Documentation

const char disp_moddoc[] [static]
 

Initial value:

"Contains methods to set various parameters in the graphical display, as "
"well as controlling how the UI and render window are updated"

Definition at line 386 of file py_display.C.

Referenced by initdisplay.

PyMethodDef DisplayMethods[] [static]
 

Initial value:

 {
  {"update", (PyCFunction)py_update, METH_NOARGS, update_doc},
  {"update_ui", (PyCFunction)py_update_ui, METH_NOARGS, update_ui_doc},
  {"update_on", (PyCFunction)py_update_on, METH_NOARGS, update_on_doc},
  {"update_off", (PyCFunction)py_update_off, METH_NOARGS, update_off_doc},
  {"set", (PyCFunction)py_set, METH_VARARGS | METH_KEYWORDS, set_doc},
  {"get", (PyCFunction)py_get, METH_VARARGS | METH_KEYWORDS, get_doc},
  {"stereomodes", (PyCFunction)py_stereomodes, METH_NOARGS, stereomodes_doc},
  {NULL, NULL}
}

Definition at line 374 of file py_display.C.

Referenced by initdisplay.

char get_doc[] [static]
 

Initial value:

"Query display properties\n\n"
"Args:\n"
"    query (str): Property to query. See keywords for `display.set()` for a\n"
"        comprehensive list of properties.\n"
"Returns:\n"
"    (either float, bool, list of 2 ints, or str): Value of queried parameter\n"
"        with datatype depending on the parameter type. See `display.set()`\n"
"        for a list of all parameters and types."

Definition at line 227 of file py_display.C.

const char set_doc[] [static]
 

Initial value:

"Sets display properties. One or more properties may be set at a time.\n\n"
"Args:\n"
"    eyesep (float): Eye separation\n"
"    focallength (float): Focal length\n"
"    height (float): Screen height relative to the camera\n"
"    distance (float): Screen distance relative to the camera\n"
"    nearclip (float): Near clipping plane distance\n"
"    farclip (float): Far clipping plane distance\n"
"    antialias (bool): If antialiasing is on\n"
"    depthcueue (bool): If depth cueuing is used\n"
"    culling (bool): If backface culling is used. Can reduce performance\n"
"    stereo (bool): If stereo mode is on\n"
"    projection (str): Projection mode, in [Perspective, Orthographic]\n"
"    size (list of 2 ints): Display window size, in px\n"
"    ambientocclusion (bool): If ambient occlusion is used\n"
"    aoambient (float): Amount of ambient light\n"
"    aodirect (float): Amount of direct light\n"
"    shadows (bool): If shadows should be rendered\n"
"    dof (bool): If depth of field effects should be rendered\n"
"    dof_fnumber (float): F-number for depth of field effects\n"
"    dof_focaldist (float): Focal distance for depth of field effects"

Definition at line 81 of file py_display.C.

const char stereomodes_doc[] [static]
 

Initial value:

"Get available stereo modes\n\n"
"Returns:\n"
"    (list of str): Available modes"

Definition at line 341 of file py_display.C.

const char update_doc[] [static]
 

Initial value:

"Force a render window update, without updating FLTK menus"

Definition at line 25 of file py_display.C.

const char update_off_doc[] [static]
 

Initial value:

"Stop updating the display. Updates will only occur when `update()` is called"

Definition at line 67 of file py_display.C.

const char update_on_doc[] [static]
 

Initial value:

"Tell VMD to regularly update display and GUI menus"

Definition at line 53 of file py_display.C.

const char update_ui_doc[] [static]
 

Initial value:

"Update the render window and all user interfaces"

Definition at line 39 of file py_display.C.


Generated on Wed Apr 17 02:47:12 2024 for VMD (current) by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002