PymolWriter.h

Go to the documentation of this file.

/**
 *  \file IMP/display/PymolWriter.h
 *  \brief Write a CGO file with the geometry.
 *
 *  Copyright 2007-2021 IMP Inventors. All rights reserved.
 */

#ifndef IMPDISPLAY_PYMOL_WRITER_H
#define IMPDISPLAY_PYMOL_WRITER_H

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

#include <IMP/PairContainer.h>
#include <IMP/SingletonContainer.h>
#include <IMP/display/Writer.h>

IMPDISPLAY_BEGIN_NAMESPACE

//! 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.
 */
class IMPDISPLAYEXPORT PymolWriter : public TextWriter {
  std::string lastname_;
  int last_frame_;
  enum Type {
    NONE = 0,
    LINES,
    TRIANGLES,
    OTHER
  };
  Type open_type_;
  friend class CGOAnimationWriter;
  void setup(std::string name, Type type, bool opendata = true);
  void cleanup(std::string name, bool close = true);
  bool handle_sphere(SphereGeometry *g, Color color,
                     std::string name) IMP_OVERRIDE;
  bool handle_cylinder(CylinderGeometry *g, Color color,
                       std::string name) IMP_OVERRIDE;
  bool handle_point(PointGeometry *g, Color color,
                    std::string name) IMP_OVERRIDE;
  bool handle_segment(SegmentGeometry *g, Color color,
                      std::string name) IMP_OVERRIDE;
  bool handle_polygon(PolygonGeometry *g, Color color,
                      std::string name) IMP_OVERRIDE;
  bool handle_triangle(TriangleGeometry *g, Color color,
                       std::string name) IMP_OVERRIDE;
  bool handle_label(LabelGeometry *g, Color color,
                    std::string name) IMP_OVERRIDE;
  bool handle_surface(SurfaceMeshGeometry *g, Color color, std::string name);

  void do_set_frame() IMP_OVERRIDE;

 public:
  IMP_TEXT_WRITER(PymolWriter);
};

IMPDISPLAY_END_NAMESPACE

#endif /* IMPDISPLAY_PYMOL_WRITER_H */