T_PyMOL_viewer< Dummy > Class Template Reference

Viewer writing in PyMOL file format. More...

#include <PyMOL_viewer.hpp>

Constructors / Destructors
	T_PyMOL_viewer (std::ostream &out=std::cout)
	Constructor initializing the output stream (default is standard output). More...

Parameters
boost::tuple< double, double, double >	get_color_rgb (const std::string &color) const
	Returns the index associated to a given color. More...
bool	is_transparent (void) const
	Checks that the next object will be viewn using transparent material. More...
void	set_transparent (bool is_transparent)
	Sets the transparent tag. More...
bool	is_visible (void) const
	Checks that the next object will be visible. More...
void	set_visible (bool is_visible)
	Sets the visible tag. More...
bool	is_cloning (void) const
	Checks that the next object will copy the last molecule if any. More...
void	set_cloning (bool is_cloning)
	Sets the cloning tag. More...
unsigned	get_vertex_resolution (void) const
	Returns the number of facets around a sphere representing a vertex. More...
void	set_vertex_resolution (unsigned resolution)
	Sets the number of facets around a sphere representing a vertex. More...
unsigned	get_circle_resolution (void) const
	Returns the number of segments around a circular arc. More...
void	set_circle_resolution (unsigned resolution)
	Sets the number of segments around a circular arc. More...
double	get_vertex_radius (void) const
	Returns the radius of a sphere representing a vertex. More...
void	set_vertex_radius (double radius)
	Sets the radius of a sphere representing a vertex. More...
double	get_edge_radius (void) const
	Returns the radius of a cylinder representing an edge. More...
void	set_edge_radius (double radius)
	Sets the radius of a cylinder representing an edge. More...
double	get_infinite_factor (void) const
	Returns the multiplicative factor used for representing infinite objects (e.g a line). More...
void	set_infinite_factor (double factor)
	Sets the multiplicative factor used for representing infinite objects (e.g a line). More...

Viewings
void	add_new_representation (void)
	Creates a new representation of the current molecule in PyMOL. More...
void	delete_first_representation (void)
	Deletes the first representation of the current molecule in PyMOL. More...
void	set_representation (const std::string &rep)
	Sets the mode of the current representation of the current molecule in PyMOL. More...
void	set_color (const std::string &color)
	Sets the color of the current representation of the current molecule in PyMOL. More...
void	set_color (std::size_t color_id)
	Sets the color of the current representation of the current molecule in PyMOL. More...
const boost::tuple< double, double, double > &	get_default_color (void) const
	Gets the color of the current representation of the current molecule in PyMOL. More...
void	set_graphics_color (const std::string &color)
	Sets the color of geometric object for the current molecule in PyMOL. More...
void	set_graphics_transparent (bool is_transparent)
	Sets the type of material to use (opaque or transparent) for the current molecule in PyMOL. More...
void	set_top_molecule (const std::string &mol_name)
	Sets the molecule with the input name as the current molecule in PyMOL. More...
void	finalize_molecule (void)
	Finalizes the molecule: here, it prints the molecule. More...

Detailed Description

template<class Dummy = void>
class SBL::IO::T_PyMOL_viewer< Dummy >

Viewer writing in PyMOL file format.

Constructed with an output stream, it uses the output stream operator for writing in a file the corresponding objects in PyMOL format. For each object passed to the operator, the Molecular_view method or struct should be defined.

Constructor & Destructor Documentation

T_PyMOL_viewer()

T_PyMOL_viewer ( std::ostream &  out = std::cout )

inline

Constructor initializing the output stream (default is standard output).

Member Function Documentation

add_new_representation()

void add_new_representation ( void  )

inline

Creates a new representation of the current molecule in PyMOL.

delete_first_representation()

void delete_first_representation ( void  )

inline

Deletes the first representation of the current molecule in PyMOL.

finalize_molecule()

void finalize_molecule ( void  )

inline

Finalizes the molecule: here, it prints the molecule.

get_circle_resolution()

unsigned get_circle_resolution ( void  ) const

inline

Returns the number of segments around a circular arc.

get_color_rgb()

boost::tuple< double, double, double > get_color_rgb ( const std::string &  color ) const

inline

Returns the index associated to a given color.

If the string does not represent a known color, it returns 0 (blue).

get_default_color()

const boost::tuple< double, double, double > & get_default_color ( void  ) const

inline

Gets the color of the current representation of the current molecule in PyMOL.

get_edge_radius()

double get_edge_radius ( void  ) const

inline

Returns the radius of a cylinder representing an edge.

get_infinite_factor()

double get_infinite_factor ( void  ) const

inline

Returns the multiplicative factor used for representing infinite objects (e.g a line).

get_vertex_radius()

double get_vertex_radius ( void  ) const

inline

Returns the radius of a sphere representing a vertex.

get_vertex_resolution()

unsigned get_vertex_resolution ( void  ) const

inline

Returns the number of facets around a sphere representing a vertex.

is_cloning()

bool is_cloning ( void  ) const

inline

Checks that the next object will copy the last molecule if any.

is_transparent()

bool is_transparent ( void  ) const

inline

Checks that the next object will be viewn using transparent material.

is_visible()

bool is_visible ( void  ) const

inline

Checks that the next object will be visible.

set_circle_resolution()

void set_circle_resolution ( unsigned  resolution )

inline

Sets the number of segments around a circular arc.

set_cloning()

void set_cloning ( bool  is_cloning )

inline

Sets the cloning tag.

set_color() [1/2]

void set_color ( const std::string &  color )

inline

Sets the color of the current representation of the current molecule in PyMOL.

set_color() [2/2]

void set_color ( std::size_t  color_id )

inline

Sets the color of the current representation of the current molecule in PyMOL.

set_edge_radius()

void set_edge_radius ( double  radius )

inline

Sets the radius of a cylinder representing an edge.

set_graphics_color()

void set_graphics_color ( const std::string &  color )

inline

Sets the color of geometric object for the current molecule in PyMOL.

set_graphics_transparent()

void set_graphics_transparent ( bool  is_transparent )

inline

Sets the type of material to use (opaque or transparent) for the current molecule in PyMOL.

set_infinite_factor()

void set_infinite_factor ( double  factor )

inline

Sets the multiplicative factor used for representing infinite objects (e.g a line).

set_representation()

void set_representation ( const std::string &  rep )

inline

Sets the mode of the current representation of the current molecule in PyMOL.

set_top_molecule()

void set_top_molecule ( const std::string &  mol_name )

inline

Sets the molecule with the input name as the current molecule in PyMOL.

set_transparent()

void set_transparent ( bool  is_transparent )

inline

Sets the transparent tag.

set_vertex_radius()

void set_vertex_radius ( double  radius )

inline

Sets the radius of a sphere representing a vertex.

set_vertex_resolution()

void set_vertex_resolution ( unsigned  resolution )

inline

Sets the number of facets around a sphere representing a vertex.

set_visible()

void set_visible ( bool  is_visible )

inline

Sets the visible tag.