Detailed Description

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:: As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use IMP::rmf instead when interfacing with Chimera.

Definition at line 29 of file ChimeraWriter.h.

Public Member Functions
	ChimeraWriter (TextOutput of)

	ChimeraWriter (std::string name)

	ChimeraWriter (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
void	add_python_code (std::string code)
	Add some arbitrary Python code to the chimera file. More...

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
virtual void	do_set_frame ()
	in case you want to take action on a new frame More...

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)

void	handle_geometry (Geometry *g)

virtual bool	handle_label (LabelGeometry *, Color, std::string)

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

void IMP::display::ChimeraWriter::add_python_code ( std::string code )

protected

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.

virtual void IMP::display::ChimeraWriter::do_close ( )

protectedvirtual

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

Implements IMP::display::Writer.

virtual void IMP::display::ChimeraWriter::do_destroy ( )

protectedvirtual

Override this method to take action on destruction.

Reimplemented from IMP::Object.

Definition at line 41 of file ChimeraWriter.h.

virtual void IMP::display::ChimeraWriter::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::ChimeraWriter::get_version_info ( ) const

virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 41 of file ChimeraWriter.h.

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

ChimeraWriter.h

Detailed Description

Public Member Functions

Protected Member Functions

Member Function Documentation