geometry_io.h

Go to the documentation of this file.

/**
 *  \file IMP/rmf/geometry_io.h
 *  \brief Handle read/write of kernel::Model data from/to files.
 *
 *  Copyright 2007-2013 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPRMF_GEOMETRY_IO_H
#define IMPRMF_GEOMETRY_IO_H

#include <IMP/rmf/rmf_config.h>
#include <IMP/display/declare_Geometry.h>
#include <RMF/NodeHandle.h>
#include <RMF/FileHandle.h>

IMPRMF_BEGIN_NAMESPACE

/** \name Geometry I/O

    The geometry I/O support currently handles geometry composed of
    - IMP::display::SegmentGeometry
    - IMP::display::CylinderGeometry
    - IMP::display::SphereGeometry

    Other types can be supported when requested. Be aware, many
    more complex geometry types are automatically decomposed into
    the above types and so, more or less, supported.
    @{
 */
/** Add the geometry to the file */
IMPRMFEXPORT void add_geometries(RMF::FileHandle file,
                                 const display::GeometriesTemp &r);

/** Add them to a given parent node.*/
IMPRMFEXPORT void add_geometries(RMF::NodeHandle parent,
                                 const display::GeometriesTemp &r);

/** Add the following geometry, assuming they do not move
    between frames. This can be space saving compared to resaving
    the constant position each frame.*/
IMPRMFEXPORT void add_static_geometries(RMF::FileHandle parent,
                                        const display::GeometriesTemp &r);

#ifndef IMP_DOXYGEN
IMPRMFEXPORT void add_geometry(RMF::FileHandle parent, display::Geometry *r);
#endif

/** Create geometry objects for the geometry nodes found in the file.
 */
IMPRMFEXPORT display::Geometries create_geometries(RMF::FileConstHandle parent);

/** Link the passed geometry objects to corresponding ones in the file.
    They must be in the same order, we don't search around for matches.*/
IMPRMFEXPORT void link_geometries(RMF::FileConstHandle parent,
                                  const display::GeometriesTemp &r);
/** @} */
IMPRMF_END_NAMESPACE

#endif /* IMPRMF_GEOMETRY_IO_H */