Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Private Attributes | List of all members
core::conformation::ResidueKinWriter Class Reference

#include <ResidueKinWriter.hh>

Inheritance diagram for core::conformation::ResidueKinWriter:
Inheritance graph
[legend]

Public Types

typedef core::Size Size
 

Public Member Functions

 ResidueKinWriter ()
 
 ~ResidueKinWriter () override
 
void write_kin_header (std::ostream &ostr, core::conformation::Residue const &rsd, core::Size atom_to_center_on=0, core::Size which_kin=1) const
 write the header for the kinemage to center on this residue More...
 
void write_rsd_coords (std::ostream &ostr, core::conformation::Residue const &rsd, bool is_instance=false) const
 Write out the coordinates for a particular residue; the kinemage tag is assumed to have been writen already. More...
 
void master (std::string const &setting)
 
void dominant (bool setting)
 
void animate (bool setting)
 
void group (bool setting)
 
void write_virtual_atoms (bool setting)
 
void write_hydrogens (bool setting)
 Calling this function with the setting "true", turns on polar, apolar, and backbone hydrogen writing. Calling this function with the setting "false", turns off polar, apolar, and backbone hydrogen writing. More...
 
void write_apolar_hydrogens (bool setting)
 
void write_polar_hydrogens (bool setting)
 
void write_backbone_hydrogens (bool setting)
 

Private Attributes

std::string master_
 
bool dominant_
 
bool animate_
 
bool group_
 
bool write_apolar_hydrogens_
 
bool write_polar_hydrogens_
 
bool write_backbone_hydrogens_
 
bool write_virtual_atoms_
 

Member Typedef Documentation

Constructor & Destructor Documentation

core::conformation::ResidueKinWriter::ResidueKinWriter ( )
core::conformation::ResidueKinWriter::~ResidueKinWriter ( )
overridedefault

Member Function Documentation

void core::conformation::ResidueKinWriter::animate ( bool  setting)
void core::conformation::ResidueKinWriter::dominant ( bool  setting)

References dominant_.

void core::conformation::ResidueKinWriter::group ( bool  setting)

References group_.

void core::conformation::ResidueKinWriter::master ( std::string const &  setting)

References master_.

void core::conformation::ResidueKinWriter::write_apolar_hydrogens ( bool  setting)

References write_apolar_hydrogens_.

Referenced by write_hydrogens().

void core::conformation::ResidueKinWriter::write_backbone_hydrogens ( bool  setting)

References write_backbone_hydrogens_.

Referenced by write_hydrogens().

void core::conformation::ResidueKinWriter::write_hydrogens ( bool  setting)

Calling this function with the setting "true", turns on polar, apolar, and backbone hydrogen writing. Calling this function with the setting "false", turns off polar, apolar, and backbone hydrogen writing.

References write_apolar_hydrogens(), write_backbone_hydrogens(), and write_polar_hydrogens().

void core::conformation::ResidueKinWriter::write_kin_header ( std::ostream &  ostr,
core::conformation::Residue const &  rsd,
core::Size  atom_to_center_on = 0,
core::Size  which_kin = 1 
) const

write the header for the kinemage to center on this residue

References core::conformation::Residue::nbr_atom(), core::conformation::write_kinemage_header(), and core::conformation::Residue::xyz().

void core::conformation::ResidueKinWriter::write_polar_hydrogens ( bool  setting)

References write_polar_hydrogens_.

Referenced by write_hydrogens().

void core::conformation::ResidueKinWriter::write_rsd_coords ( std::ostream &  ostr,
core::conformation::Residue const &  rsd,
bool  is_instance = false 
) const

Write out the coordinates for a particular residue; the kinemage tag is assumed to have been writen already.

If you're drawing multiple instances of a single rotamer, use the "instance" flag to point to the coordinates already written out in this file. This creates a smaller output file.

References animate_, core::conformation::Residue::atom_is_backbone(), core::conformation::Residue::atom_is_hydrogen(), core::conformation::Residue::atom_type(), dominant_, core::chemical::AtomType::element(), group_, master_, core::conformation::Residue::name(), core::conformation::Residue::natoms(), core::conformation::Residue::nbrs(), core::conformation::print_node(), core::conformation::Residue::seqpos(), write_apolar_hydrogens_, write_backbone_hydrogens_, write_polar_hydrogens_, and write_virtual_atoms_.

void core::conformation::ResidueKinWriter::write_virtual_atoms ( bool  setting)

References write_virtual_atoms_.

Member Data Documentation

bool core::conformation::ResidueKinWriter::animate_
private

Referenced by animate(), and write_rsd_coords().

bool core::conformation::ResidueKinWriter::dominant_
private

Referenced by dominant(), and write_rsd_coords().

bool core::conformation::ResidueKinWriter::group_
private

Referenced by group(), and write_rsd_coords().

std::string core::conformation::ResidueKinWriter::master_
private

Referenced by master(), and write_rsd_coords().

bool core::conformation::ResidueKinWriter::write_apolar_hydrogens_
private
bool core::conformation::ResidueKinWriter::write_backbone_hydrogens_
private
bool core::conformation::ResidueKinWriter::write_polar_hydrogens_
private
bool core::conformation::ResidueKinWriter::write_virtual_atoms_
private

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