IMP logo
IMP Reference Guide  develop.c9d213c767,2020/05/27
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:

Detailed Description

Write a CGO file with the geometry.

The CGO file format is a simple format for displaying geometry in Pymol. The CGO writer supports points, spheres, cylinders, 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.

Public Member Functions

 PymolWriter (TextOutput of)
 
 PymolWriter (std::string name)
 
 PymolWriter (const char *name)
 
virtual std::string get_type_name () const
 
virtual ::IMP::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
- Public Member Functions inherited from IMP::display::TextWriter
 TextWriter (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. More...
 
std::string get_current_file_name () const
 get the name of the current file being written More...
 
- Public Member Functions inherited from IMP::display::Writer
 Writer (std::string name)
 Create a writer opening the file with the passed name. More...
 
virtual ~Writer ()
 Write the data and close the file. More...
 
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::Object
virtual void clear_caches ()
 
CheckLevel get_check_level () const
 
LogLevel get_log_level () const
 
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)
 

Protected Member Functions

virtual void do_close ()
 A hook for implementation classes to use to take actions on file close. More...
 
virtual void do_destroy ()
 
virtual void do_open ()
 A hook for implementation classes to use to take actions on file open. More...
 
- Protected Member Functions inherited from IMP::display::TextWriter
std::ostream & get_stream ()
 Get the stream for inheriting classes to write to. More...
 
void open ()
 
- Protected Member Functions inherited from IMP::display::GeometryProcessor
virtual bool handle_anything (Geometry *, Color, std::string)
 
virtual bool handle_bounding_box (BoundingBoxGeometry *, Color, std::string)
 
virtual bool handle_ellipsoid (EllipsoidGeometry *, Color, std::string)
 
void handle_geometry (Geometry *g)
 
virtual bool handle_surface_mesh (SurfaceMeshGeometry *, Color, std::string)
 
- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
 

Member Function Documentation

virtual void IMP::display::PymolWriter::do_close ( )
protectedvirtual

A hook for implementation classes to use to take actions on file close.

Implements IMP::display::Writer.

virtual void IMP::display::PymolWriter::do_destroy ( )
protectedvirtual

Override this method to take action on destruction.

Reimplemented from IMP::Object.

Definition at line 59 of file PymolWriter.h.

virtual void IMP::display::PymolWriter::do_open ( )
protectedvirtual

A hook for implementation classes to use to take actions on file open.

Implements IMP::display::Writer.

virtual ::IMP::VersionInfo IMP::display::PymolWriter::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 59 of file PymolWriter.h.


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