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

py_label.C File Reference

#include "py_commands.h"
#include "VMDApp.h"
#include "GeometryList.h"
#include "Molecule.h"
#include "MoleculeList.h"
#include "config.h"

Go to the source code of this file.

Functions

PyObject * geom2dict (GeometryMol *g)
int dict2geom (PyObject *dict, GeometryMol *g)
PyObject * py_listall (PyObject *self, PyObject *args, PyObject *kwargs)
PyObject * py_label_add (PyObject *self, PyObject *args, PyObject *kwargs)
PyObject * py_label_visible (PyObject *self, PyObject *args, PyObject *kwargs)
PyObject * py_label_delete (PyObject *self, PyObject *args, PyObject *kwargs)
PyObject * getvalues (GeometryMol *g)
PyObject * py_label_getvalues (PyObject *self, PyObject *args, PyObject *kwargs)
PyObject * py_label_textsize (PyObject *self, PyObject *args, PyObject *kwargs)
PyObject * py_label_textthickness (PyObject *self, PyObject *args, PyObject *kwargs)
PyObject * initlabel (void)

Variables

const char listall_doc []
const char label_add_doc []
const char label_visible_doc []
const char label_del_doc []
const char label_values_doc []
const char label_size_doc []
const char label_thick_doc []
PyMethodDef LabelMethods []
const char label_moddoc []


Function Documentation

int dict2geom PyObject *    dict,
GeometryMol   g
[static]
 

Definition at line 63 of file py_label.C.

References as_int, GeometryMol::com_index, GeometryMol::items, and GeometryMol::obj_index.

Referenced by py_label_delete, py_label_getvalues, and py_label_visible.

PyObject* geom2dict GeometryMol   g [static]
 

Definition at line 29 of file py_label.C.

References as_pyint, GeometryMol::calculate, GeometryMol::com_index, Displayable::displayed, GeometryMol::items, n, NULL, GeometryMol::obj_index, and GeometryMol::ok.

Referenced by py_label_add, and py_listall.

PyObject* getvalues GeometryMol   g [static]
 

Definition at line 359 of file py_label.C.

References GeometryMol::calculate_all, GeometryMol::has_value, n, NULL, and ResizeArray::num.

Referenced by py_label_getvalues.

PyObject* initlabel void   
 

Definition at line 551 of file py_label.C.

References label_moddoc, and LabelMethods.

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

Definition at line 158 of file py_label.C.

References as_int, geom2dict, GeometryList::geom_list, GeometryList::geom_list_index, VMDApp::geometryList, get_vmdapp, VMDApp::label_add, MoleculeList::mol_from_id, VMDApp::moleculeList, BaseMolecule::nAtoms, and NULL.

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

Definition at line 315 of file py_label.C.

References dict2geom, GeometryList::geom_list, GeometryList::geom_list_index, VMDApp::geometryList, get_vmdapp, VMDApp::label_delete, NULL, and ResizeArray::num.

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

Definition at line 404 of file py_label.C.

References dict2geom, GeometryList::geom_list, GeometryList::geom_list_index, VMDApp::geometryList, get_vmdapp, getvalues, NULL, ResizeArray::num, and result.

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

Definition at line 450 of file py_label.C.

References get_vmdapp, VMDApp::label_get_text_size, VMDApp::label_set_text_size, and NULL.

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

Definition at line 491 of file py_label.C.

References get_vmdapp, VMDApp::label_get_text_thickness, VMDApp::label_set_text_thickness, and NULL.

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

Definition at line 268 of file py_label.C.

References dict2geom, GeometryList::geom_list, GeometryList::geom_list_index, VMDApp::geometryList, get_vmdapp, VMDApp::label_show, NULL, and ResizeArray::num.

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

Definition at line 108 of file py_label.C.

References geom2dict, GeometryList::geom_list, GeometryList::geom_list_index, VMDApp::geometryList, get_vmdapp, NULL, and ResizeArray::num.


Variable Documentation

const char label_add_doc[] [static]
 

Initial value:

"Add a label of the given type. If label already exists, no action is \n"
"performed. The number of elements in the molids and atomids tuple is \n"
"determined by\nArgs:\n"
"    category (str): Label category to add. Must be one of the following:\n"
"        'Atoms', 'Bonds', 'Angles', 'Dihedrals', 'Springs'\n"
"    molids (list or tuple): Molids to label. Length as required to describe\n"
"        label category-- 1 for atoms, 2 bonds, etc.\n"
"    atomids (list or tuple): Atom IDs to label. Must be same length as molids\n"
"Returns:\n"
"    (dict) Dictionary describing the label, can be used as input to other\n"
"        label module functions"

Definition at line 146 of file py_label.C.

const char label_del_doc[] [static]
 

Initial value:

"Delete a label\n\nArgs:\n"
"    label (dict): Label to delete. Dictionary format generated by label.add\n"

Definition at line 312 of file py_label.C.

const char label_moddoc[] [static]
 

Initial value:

"Methods to control the visibility and style of molecule labels"

Definition at line 537 of file py_label.C.

Referenced by initlabel.

const char label_size_doc[] [static]
 

Initial value:

"Sets text size for all labels.\n\n"
"Args:\n"
"    size (float): Text size, optional. Must be greater than zero.\n"
"        If None, just returns size\n"
"Returns:\n"
"    (float) Text size"

Definition at line 443 of file py_label.C.

const char label_thick_doc[] [static]
 

Initial value:

"Sets text thickness for all labels.\n\n"
"Args:\n"
"    thickness (float): Thickness, optional. Must be greater than zero.\n"
"        If None, just returns thickness.\n"
"Returns:\n"
"    (float) Text thickness"

Definition at line 484 of file py_label.C.

const char label_values_doc[] [static]
 

Initial value:

"Get label values for every frame in the molecule. 'value' refers to the "
"quantity the label measures-- for example, bond labels give distance.\n\n"
"Args:\n"
"    category (str): Label category to list, in ['atoms','bonds','dihedrals']\n"
"    label (dict): Label to query, from output of label.add\n"
"Returns:\n"
"    (list of float) Label values for each frame in label, or None if\n"
"        label has no values, like atom labels."

Definition at line 395 of file py_label.C.

const char label_visible_doc[] [static]
 

Initial value:

"Sets a label to be visible\n\n"
"Args:\n"
"    category (str): Label category, in ['atoms','bonds','dihedrals']\n"
"    label (dict): Label to show, from output of label.add or similar\n"
"    visible (bool): True to show, False to hide the label"

Definition at line 262 of file py_label.C.

PyMethodDef LabelMethods[] [static]
 

Initial value:

 {
  {"listall", (PyCFunction)py_listall, METH_VARARGS | METH_KEYWORDS, listall_doc },
  {"add", (PyCFunction)py_label_add, METH_VARARGS | METH_KEYWORDS, label_add_doc },
  {"set_visible", (PyCFunction)py_label_visible, METH_VARARGS | METH_KEYWORDS, label_visible_doc},
  {"delete", (PyCFunction)py_label_delete, METH_VARARGS | METH_KEYWORDS, label_del_doc },
  {"get_values", (PyCFunction)py_label_getvalues, METH_VARARGS | METH_KEYWORDS, label_values_doc},
  {"text_size", (PyCFunction)py_label_textsize, METH_VARARGS | METH_KEYWORDS, label_size_doc},
  {"text_thickness", (PyCFunction)py_label_textthickness, METH_VARARGS | METH_KEYWORDS, label_thick_doc},
  {NULL, NULL}
}

Definition at line 525 of file py_label.C.

Referenced by initlabel.

const char listall_doc[] [static]
 

Initial value:

"Get labels in the given label category.\n\n"
"Args:\n"
"    category (str): Label category to list, in ['atoms','bonds','dihedrals']\n"
"Returns:\n"
"    (dict): All labels, with keys 'molid', 'atomid', 'value', and 'on'.\n"
"        Molid and atomid will be tuples, value will be a float or None, and\n"
"        on will be True or False."

Definition at line 100 of file py_label.C.


Generated on Fri Nov 8 02:46:08 2024 for VMD (current) by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002