IMP  2.0.1
The Integrative Modeling Platform
IMP::display::PymolWriter Class Reference

Write a CGO file with the geometry. More...

#include <IMP/display/PymolWriter.h>

+ Inheritance diagram for IMP::display::PymolWriter:

Public Member Functions

 PymolWriter (base::TextOutput of)
 
 PymolWriter (const char *name)
 
 PymolWriter (std::string name)
 
- Public Member Functions inherited from IMP::display::TextWriter
 TextWriter (base::TextOutput fn)
 Create a writer opening the file with the passed sink. More...
 
 TextWriter (std::string name)
 Create a write for a file or files with the passed name or pattern. More...
 
virtual ~TextWriter ()
 Write the data and close the file.
 
std::string get_current_file_name () const
 get the name of the current file being writter
 
- Public Member Functions inherited from IMP::display::Writer
 Writer (std::string name)
 Create a writer opening the file with the passed name.
 
virtual ~Writer ()
 Write the data and close the file.
 
void set_frame (unsigned int i)
 
int get_frame () const
 
void add_geometry (Geometry *g)
 
void add_geometry (const Geometries &g)
 
- Public Member Functions inherited from IMP::base::Object
virtual void clear_caches ()
 
virtual IMP::base::VersionInfo get_version_info () const =0
 Get information about the module and version of the object.
 
void set_check_level (CheckLevel l)
 
void set_log_level (LogLevel l)
 Set the logging level used in this object. More...
 
void set_was_used (bool tf) const
 
void show (std::ostream &out=std::cout) const
 
const std::string & get_name () const
 
void set_name (std::string name)
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::display::TextWriter
void do_set_frame ()
 in case you want to take action on a new frame
 
std::ostream & get_stream ()
 Get the stream for inhereting classes to write to.
 
void open ()
 

Detailed Description

The cgo file format is a simple format for displaying geometry in Pymol. The cgo writer supports points, spheres, cyliners, and segments. The file name should end in ".pym".

The geometry is assembled into objects in pymol based on the passed names. For example, all geometry named "box" becomes one pymol object. If many files are loaded into python defining the same objects, they become sequential frames in a movie. The frame numbers are determined sequentially from the file load order (so they can form a subset of the generated files).

This writer will write many frames to the same file.

Definition at line 34 of file PymolWriter.h.


The documentation for this class was generated from the following file: