ChimeraWriter.h

Go to the documentation of this file.

/**
 *  \file IMP/display/ChimeraWriter.h
 *  \brief A writer for Chimera Python files.
 *
 *  Copyright 2007-2015 IMP Inventors. All rights reserved.
 */

#ifndef IMPDISPLAY_CHIMERA_WRITER_H
#define IMPDISPLAY_CHIMERA_WRITER_H

#include <IMP/display/display_config.h>
#include <IMP/display/Writer.h>
#include <IMP/display/writer_macros.h>

IMPDISPLAY_DEPRECATED_HEADER(2.1, "Use IMP.rmf")

IMPDISPLAY_BEGIN_NAMESPACE
//! Write geometry to a Python file for Chimera to read
/** The writer writes a Python file which can handle markers, edges
    and surfaces.  Since these are native chimera objects, they are
    handled a bit better than VRML ones.

    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.

    \deprecated_at{2.1} Use IMP::rmf instead when interfacing with Chimera.
 */
class IMPDISPLAYEXPORT ChimeraWriter : public TextWriter {
  void cleanup(std::string name, bool need_ms, bool need_surf = false);
  bool handle_sphere(SphereGeometry *g, Color color, std::string name);
  bool handle_cylinder(CylinderGeometry *g, Color color, std::string name);
  bool handle_point(PointGeometry *g, Color color, std::string name);
  bool handle_segment(SegmentGeometry *g, Color color, std::string name);
  bool handle_polygon(PolygonGeometry *g, Color color, std::string name);
  bool handle_triangle(TriangleGeometry *g, Color color, std::string name);
  bool handle_ellipsoid(EllipsoidGeometry *g, Color color, std::string name);

 public:
  IMPDISPLAY_DEPRECATED_OBJECT_DECL(2.1)
  IMP_TEXT_WRITER(ChimeraWriter);

  //! Add some arbitrary Python code to the chimera file
  /** You should import the bits of Chimera that you need.
      At the moment, you should not name a variable surf_sets
      or marker_sets.
   */
  void add_python_code(std::string code);
};

IMPDISPLAY_END_NAMESPACE

#endif /* IMPDISPLAY_CHIMERA_WRITER_H */