IMP  2.1.0
The Integrative Modeling Platform
IMP::display::CMMWriter Class Reference

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

#include <IMP/display/CMMWriter.h>

+ Inheritance diagram for IMP::display::CMMWriter:

Public Member Functions

 CMMWriter (base::TextOutput of)
 
 CMMWriter (std::string name)
 
 CMMWriter (const char *name)
 
unsigned int get_current_index () const
 
virtual std::string get_type_name () const
 
virtual ::IMP::base::VersionInfo get_version_info () const
 Get information about the module and version of the object.
 
- 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 ()
 
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.
 
virtual void do_destroy ()
 
virtual void do_open ()
 A hook for implementation classes to use to take actions on file open.
 
- Protected Member Functions inherited from IMP::display::TextWriter
virtual 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 ()
 
- 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_cylinder (CylinderGeometry *, Color, std::string)
 
virtual bool handle_ellipsoid (EllipsoidGeometry *, Color, std::string)
 
void handle_geometry (Geometry *g)
 
virtual bool handle_label (LabelGeometry *, Color, std::string)
 
virtual bool handle_polygon (PolygonGeometry *, Color, std::string)
 
virtual bool handle_segment (SegmentGeometry *, Color, std::string)
 
virtual bool handle_surface_mesh (SurfaceMeshGeometry *, Color, std::string)
 
virtual bool handle_triangle (TriangleGeometry *, Color, std::string)
 
- Protected Member Functions inherited from IMP::base::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
 Object ()
 

Detailed Description

The CMM writer supports points and spheres. Cylinders can be added at some point.

This format creates one file per frame. So if you want to use frames and save them all, make sure there is a "%1%" in the file name string passed to the constructor.

You are probably better off using the IMP::display::ChimeraWriter which writes a python file, readable by Chimera as it supports more types of geometry.

Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use IMP::rmf for interfacing with Chimera.

Definition at line 35 of file CMMWriter.h.

Member Function Documentation

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

Overide this method to take action on destruction.

Reimplemented from IMP::base::Object.

Definition at line 42 of file CMMWriter.h.


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