StyleSettings Class Reference

Search Toolkit Book for StyleSettings

#include "style_manager.hpp"
(Private to src/app/cn3d.)

Collaboration diagram for StyleSettings:

Classes
struct	BackboneStyle
struct	GeneralStyle
struct	LabelStyle

Public Types
enum	eBackboneType { eOff = 1 , eTrace = 2 , ePartial = 3 , eComplete = 4 }
enum	eDrawingStyle {   eWire = 1 , eTubes = 2 , eBallAndStick = 3 , eSpaceFill = 4 ,   eWireWorm = 5 , eTubeWorm = 6 , eWithArrows = 7 , eWithoutArrows = 8 }
enum	eColorScheme {   eElement = 1 , eObject = 2 , eMolecule = 3 , eDomain = 4 ,   eResidue = 20 , eSecondaryStructure = 5 , eTemperature = 13 , eHydrophobicity = 14 ,   eCharge = 15 , eRainbow = 16 , eUserSelect = 6 , eAligned = 7 ,   eIdentity = 8 , eVariety = 9 , eWeightedVariety = 10 , eInformationContent = 11 ,   eFit = 12 , eBlockFit = 17 , eBlockZFit = 18 , eBlockRowFit = 19 }
enum	eLabelType { eOneLetter = 1 , eThreeLetter = 2 }
enum	eNumberType { eNoNumbers = 0 , eSequentialNumbering = 1 , ePDBNumbering = 2 }
enum	ePredefinedRenderingStyle {   eWormShortcut , eTubeShortcut , eWireframeShortcut , eBallAndStickShortcut ,   eSpacefillShortcut , eToggleSidechainsShortcut }
enum	ePredefinedColorScheme {   eSecondaryStructureShortcut , eAlignedShortcut , eIdentityShortcut , eVarietyShortcut ,   eWeightedVarietyShortcut , eInformationContentShortcut , eFitShortcut , eBlockFitShortcut ,   eBlockZFitShortcut , eBlockRowFitShortcut , eObjectShortcut , eDomainShortcut ,   eMoleculeShortcut , eResidueShortcut , eRainbowShortcut , eHydrophobicityShortcut ,   eChargeShortcut , eTemperatureShortcut , eElementShortcut }

Public Member Functions
void	SetRenderingStyle (ePredefinedRenderingStyle style)
void	SetColorScheme (ePredefinedColorScheme scheme)
void	SetDefaultLabeling (void)
	StyleSettings (void)
	StyleSettings (const StyleSettings &orig)
StyleSettings &	operator= (const StyleSettings &v)
bool	SaveSettingsToASN (ncbi::objects::CCn3d_style_settings *styleASN) const
bool	LoadSettingsFromASN (const ncbi::objects::CCn3d_style_settings &styleASN)

Public Attributes
BackboneStyle	proteinBackbone
BackboneStyle	nucleotideBackbone
GeneralStyle	proteinSidechains
GeneralStyle	nucleotideSidechains
GeneralStyle	heterogens
GeneralStyle	solvents
GeneralStyle	connections
GeneralStyle	helixObjects
GeneralStyle	strandObjects
LabelStyle	proteinLabels
LabelStyle	nucleotideLabels
bool	virtualDisulfidesOn
bool	hydrogensOn
bool	ionLabelsOn
Vector	virtualDisulfideColor
Vector	backgroundColor
double	spaceFillProportion
double	ballRadius
double	stickRadius
double	tubeRadius
double	tubeWormRadius
double	helixRadius
double	strandWidth
double	strandThickness

Detailed Description

Definition at line 69 of file style_manager.hpp.

Member Enumeration Documentation

eBackboneType

enum StyleSettings::eBackboneType

Enumerator
eOff
eTrace
ePartial
eComplete

Definition at line 73 of file style_manager.hpp.

eColorScheme

enum StyleSettings::eColorScheme

Enumerator
eElement
eObject
eMolecule
eDomain
eResidue
eSecondaryStructure
eTemperature
eHydrophobicity
eCharge
eRainbow
eUserSelect
eAligned
eIdentity
eVariety
eWeightedVariety
eInformationContent
eFit
eBlockFit
eBlockZFit
eBlockRowFit

Definition at line 96 of file style_manager.hpp.

eDrawingStyle

enum StyleSettings::eDrawingStyle

Enumerator
eWire
eTubes
eBallAndStick
eSpaceFill
eWireWorm
eTubeWorm
eWithArrows
eWithoutArrows

Definition at line 81 of file style_manager.hpp.

eLabelType

enum StyleSettings::eLabelType

Enumerator
eOneLetter
eThreeLetter

Definition at line 135 of file style_manager.hpp.

eNumberType

enum StyleSettings::eNumberType

Enumerator
eNoNumbers
eSequentialNumbering
ePDBNumbering

Definition at line 140 of file style_manager.hpp.

ePredefinedColorScheme

enum StyleSettings::ePredefinedColorScheme

Enumerator
eSecondaryStructureShortcut
eAlignedShortcut
eIdentityShortcut
eVarietyShortcut
eWeightedVarietyShortcut
eInformationContentShortcut
eFitShortcut
eBlockFitShortcut
eBlockZFitShortcut
eBlockRowFitShortcut
eObjectShortcut
eDomainShortcut
eMoleculeShortcut
eResidueShortcut
eRainbowShortcut
eHydrophobicityShortcut
eChargeShortcut
eTemperatureShortcut
eElementShortcut

Definition at line 185 of file style_manager.hpp.

ePredefinedRenderingStyle

enum StyleSettings::ePredefinedRenderingStyle

Enumerator
eWormShortcut
eTubeShortcut
eWireframeShortcut
eBallAndStickShortcut
eSpacefillShortcut
eToggleSidechainsShortcut

Definition at line 174 of file style_manager.hpp.

Constructor & Destructor Documentation

StyleSettings() [1/2]

StyleSettings::StyleSettings ( void  )

inline

Definition at line 212 of file style_manager.hpp.

References eSecondaryStructureShortcut, eWormShortcut, SetColorScheme(), SetDefaultLabeling(), and SetRenderingStyle().

StyleSettings() [2/2]

StyleSettings::StyleSettings ( const StyleSettings &  orig )

inline

Definition at line 218 of file style_manager.hpp.

References orig.

Member Function Documentation

LoadSettingsFromASN()

bool StyleSettings::LoadSettingsFromASN

(

const ncbi::objects::CCn3d_style_settings &

styleASN

)

Definition at line 216 of file style_manager.cpp.

References ASNColor2Vector(), backgroundColor, connections, CCn3d_style_settings_Base::GetBackground_color(), CCn3d_style_settings_Base::GetConnections(), CCn3d_style_settings_Base::GetHelix_objects(), CCn3d_style_settings_Base::GetHelix_radius(), CCn3d_style_settings_Base::GetHeterogens(), CCn3d_style_settings_Base::GetHydrogens_on(), CCn3d_style_settings_Base::GetIon_labels(), CCn3d_style_settings_Base::GetNucleotide_backbone(), CCn3d_style_settings_Base::GetNucleotide_labels(), CCn3d_style_settings_Base::GetNucleotide_sidechains(), CCn3d_style_settings_Base::GetProtein_backbone(), CCn3d_style_settings_Base::GetProtein_labels(), CCn3d_style_settings_Base::GetProtein_sidechains(), CCn3d_style_settings_Base::GetScale_factor(), CCn3d_style_settings_Base::GetSolvents(), CCn3d_style_settings_Base::GetSpace_fill_proportion(), CCn3d_style_settings_Base::GetStick_radius(), CCn3d_style_settings_Base::GetStrand_objects(), CCn3d_style_settings_Base::GetStrand_thickness(), CCn3d_style_settings_Base::GetStrand_width(), CCn3d_style_settings_Base::GetTube_radius(), CCn3d_style_settings_Base::GetTube_worm_radius(), CCn3d_style_settings_Base::GetVirtual_disulfide_color(), CCn3d_style_settings_Base::GetVirtual_disulfides_on(), helixObjects, helixRadius, heterogens, hydrogensOn, ionLabelsOn, CCn3d_style_settings_Base::IsSetIon_labels(), CCn3d_style_settings_Base::IsSetNucleotide_labels(), CCn3d_style_settings_Base::IsSetProtein_labels(), LoadBackboneStyleFromASN(), LoadGeneralStyleFromASN(), LoadLabelStyleFromASN(), nucleotideBackbone, nucleotideLabels, nucleotideSidechains, proteinBackbone, proteinLabels, proteinSidechains, SetDefaultLabelStyle(), solvents, spaceFillProportion, stickRadius, strandObjects, strandThickness, strandWidth, tubeRadius, tubeWormRadius, virtualDisulfideColor, and virtualDisulfidesOn.

Referenced by StyleManager::LoadFromASNStyleDictionary(), and StyleManager::SetGlobalStyle().

operator=()

StyleSettings & StyleSettings::operator=

(

const StyleSettings &

v

)

Definition at line 257 of file style_manager.cpp.

References orig.

SaveSettingsToASN()

bool StyleSettings::SaveSettingsToASN

(

ncbi::objects::CCn3d_style_settings *

styleASN

)

const

Definition at line 128 of file style_manager.cpp.

References backgroundColor, ballRadius, connections, helixObjects, helixRadius, heterogens, hydrogensOn, ionLabelsOn, nucleotideBackbone, nucleotideLabels, nucleotideSidechains, proteinBackbone, proteinLabels, proteinSidechains, SaveBackboneStyleToASN(), SaveGeneralStyleToASN(), SaveLabelStyleToASN(), CCn3d_style_settings_Base::SetBackground_color(), CCn3d_style_settings_Base::SetBall_radius(), CCn3d_style_settings_Base::SetConnections(), CCn3d_style_settings_Base::SetHelix_objects(), CCn3d_style_settings_Base::SetHelix_radius(), CCn3d_style_settings_Base::SetHeterogens(), CCn3d_style_settings_Base::SetHydrogens_on(), CCn3d_style_settings_Base::SetIon_labels(), CCn3d_style_settings_Base::SetNucleotide_backbone(), CCn3d_style_settings_Base::SetNucleotide_labels(), CCn3d_style_settings_Base::SetNucleotide_sidechains(), CCn3d_style_settings_Base::SetProtein_backbone(), CCn3d_style_settings_Base::SetProtein_labels(), CCn3d_style_settings_Base::SetProtein_sidechains(), CCn3d_style_settings_Base::SetScale_factor(), CCn3d_style_settings_Base::SetSolvents(), CCn3d_style_settings_Base::SetSpace_fill_proportion(), CCn3d_style_settings_Base::SetStick_radius(), CCn3d_style_settings_Base::SetStrand_objects(), CCn3d_style_settings_Base::SetStrand_thickness(), CCn3d_style_settings_Base::SetStrand_width(), CCn3d_style_settings_Base::SetTube_radius(), CCn3d_style_settings_Base::SetTube_worm_radius(), CCn3d_style_settings_Base::SetVirtual_disulfide_color(), CCn3d_style_settings_Base::SetVirtual_disulfides_on(), solvents, spaceFillProportion, stickRadius, strandObjects, strandThickness, strandWidth, tubeRadius, tubeWormRadius, Vector2ASNColor(), virtualDisulfideColor, and virtualDisulfidesOn.

Referenced by StyleManager::CreateASNStyleDictionary(), and StructureWindow::OnEditFavorite().

SetColorScheme()

void StyleSettings::SetColorScheme

(

ePredefinedColorScheme

scheme

)

Definition at line 355 of file style_manager.cpp.

References backgroundColor, StyleSettings::BackboneStyle::colorScheme, StyleSettings::GeneralStyle::colorScheme, connections, eAligned, eAlignedShortcut, eBlockFit, eBlockFitShortcut, eBlockRowFit, eBlockRowFitShortcut, eBlockZFit, eBlockZFitShortcut, eCharge, eChargeShortcut, eDomain, eDomainShortcut, eElement, eElementShortcut, eFit, eFitShortcut, eHydrophobicity, eHydrophobicityShortcut, eIdentity, eIdentityShortcut, eInformationContent, eInformationContentShortcut, eMolecule, eMoleculeShortcut, eObject, eObjectShortcut, eRainbow, eRainbowShortcut, eResidue, eResidueShortcut, eSecondaryStructure, eSecondaryStructureShortcut, eTemperature, eTemperatureShortcut, eUserSelect, eVariety, eVarietyShortcut, eWeightedVariety, eWeightedVarietyShortcut, helixObjects, heterogens, nucleotideBackbone, nucleotideSidechains, proteinBackbone, proteinSidechains, Vector< T >::Set(), solvents, strandObjects, StyleSettings::BackboneStyle::userColor, StyleSettings::GeneralStyle::userColor, and virtualDisulfideColor.

Referenced by StyleManager::SetGlobalColorScheme(), and StyleSettings().

SetDefaultLabeling()

void StyleSettings::SetDefaultLabeling

(

void

)

Definition at line 478 of file style_manager.cpp.

References ionLabelsOn, nucleotideLabels, proteinLabels, and SetDefaultLabelStyle().

Referenced by StyleSettings().

SetRenderingStyle()

void StyleSettings::SetRenderingStyle

(

ePredefinedRenderingStyle

style

)

Definition at line 263 of file style_manager.cpp.

References ballRadius, connections, eBallAndStick, eBallAndStickShortcut, eComplete, eSpaceFill, eSpacefillShortcut, eToggleSidechainsShortcut, eTrace, eTubes, eTubeShortcut, eTubeWorm, eWire, eWireframeShortcut, eWithArrows, eWormShortcut, helixObjects, helixRadius, heterogens, hydrogensOn, StyleSettings::GeneralStyle::isOn, nucleotideBackbone, nucleotideSidechains, proteinBackbone, proteinSidechains, solvents, spaceFillProportion, stickRadius, strandObjects, strandThickness, strandWidth, StyleSettings::BackboneStyle::style, StyleSettings::GeneralStyle::style, tubeRadius, tubeWormRadius, StyleSettings::BackboneStyle::type, and virtualDisulfidesOn.

Referenced by StyleManager::SetGlobalRenderingStyle(), and StyleSettings().

Member Data Documentation

backgroundColor

Vector StyleSettings::backgroundColor

Definition at line 168 of file style_manager.hpp.

Referenced by Residue::Draw(), Molecule::DrawAllWithTerminiLabels(), StyleManager::GetBackgroundColor(), StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), SetColorScheme(), and StyleDialog::SetControls().

ballRadius

double StyleSettings::ballRadius

Definition at line 170 of file style_manager.hpp.

Referenced by StyleManager::GetAtomStyle(), StyleDialog::GetValues(), SaveSettingsToASN(), StyleDialog::SetControls(), and SetRenderingStyle().

connections

GeneralStyle StyleSettings::connections

Definition at line 161 of file style_manager.hpp.

Referenced by StyleManager::GetBondStyle(), StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), SetColorScheme(), StyleDialog::SetControls(), and SetRenderingStyle().

helixObjects

GeneralStyle StyleSettings::helixObjects

Definition at line 162 of file style_manager.hpp.

Referenced by StyleManager::GetHelixStyle(), StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), SetColorScheme(), StyleDialog::SetControls(), and SetRenderingStyle().

helixRadius

double StyleSettings::helixRadius

Definition at line 171 of file style_manager.hpp.

Referenced by StyleManager::GetHelixStyle(), StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), StyleDialog::SetControls(), and SetRenderingStyle().

heterogens

GeneralStyle StyleSettings::heterogens

Definition at line 159 of file style_manager.hpp.

Referenced by StyleManager::GetAtomStyle(), StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), SetColorScheme(), StyleDialog::SetControls(), and SetRenderingStyle().

hydrogensOn

bool StyleSettings::hydrogensOn

Definition at line 166 of file style_manager.hpp.

Referenced by StyleManager::GetAtomStyle(), StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), StyleDialog::SetControls(), and SetRenderingStyle().

ionLabelsOn

bool StyleSettings::ionLabelsOn

Definition at line 166 of file style_manager.hpp.

Referenced by StyleManager::GetAtomStyle(), StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), StyleDialog::SetControls(), and SetDefaultLabeling().

nucleotideBackbone

BackboneStyle StyleSettings::nucleotideBackbone

Definition at line 155 of file style_manager.hpp.

Referenced by StyleManager::CheckStyleSettings(), StyleManager::GetAtomStyle(), StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), SetColorScheme(), StyleDialog::SetControls(), and SetRenderingStyle().

nucleotideLabels

LabelStyle StyleSettings::nucleotideLabels

Definition at line 164 of file style_manager.hpp.

Referenced by Residue::Draw(), Molecule::DrawAllWithTerminiLabels(), StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), StyleDialog::SetControls(), and SetDefaultLabeling().

nucleotideSidechains

GeneralStyle StyleSettings::nucleotideSidechains

Definition at line 158 of file style_manager.hpp.

Referenced by StyleManager::GetAtomStyle(), StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), SetColorScheme(), StyleDialog::SetControls(), and SetRenderingStyle().

proteinBackbone

BackboneStyle StyleSettings::proteinBackbone

Definition at line 155 of file style_manager.hpp.

Referenced by StyleManager::CheckStyleSettings(), StyleManager::GetAtomStyle(), BlockMultipleAlignment::GetCharacterTraitsAt(), StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), SetColorScheme(), StyleDialog::SetControls(), and SetRenderingStyle().

proteinLabels

LabelStyle StyleSettings::proteinLabels

Definition at line 164 of file style_manager.hpp.

Referenced by Residue::Draw(), Molecule::DrawAllWithTerminiLabels(), StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), StyleDialog::SetControls(), and SetDefaultLabeling().

proteinSidechains

GeneralStyle StyleSettings::proteinSidechains

Definition at line 158 of file style_manager.hpp.

Referenced by StyleManager::GetAtomStyle(), StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), SetColorScheme(), StyleDialog::SetControls(), and SetRenderingStyle().

solvents

GeneralStyle StyleSettings::solvents

Definition at line 160 of file style_manager.hpp.

Referenced by StyleManager::GetAtomStyle(), StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), SetColorScheme(), StyleDialog::SetControls(), and SetRenderingStyle().

spaceFillProportion

double StyleSettings::spaceFillProportion

Definition at line 170 of file style_manager.hpp.

Referenced by StyleManager::GetAtomStyle(), StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), StyleDialog::SetControls(), and SetRenderingStyle().

stickRadius

double StyleSettings::stickRadius

Definition at line 170 of file style_manager.hpp.

Referenced by StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), SetBondStyleFromResidueStyle(), StyleDialog::SetControls(), and SetRenderingStyle().

strandObjects

GeneralStyle StyleSettings::strandObjects

Definition at line 162 of file style_manager.hpp.

Referenced by StyleManager::GetStrandStyle(), StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), SetColorScheme(), StyleDialog::SetControls(), and SetRenderingStyle().

strandThickness

double StyleSettings::strandThickness

Definition at line 171 of file style_manager.hpp.

Referenced by StyleManager::GetStrandStyle(), StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), StyleDialog::SetControls(), and SetRenderingStyle().

strandWidth

double StyleSettings::strandWidth

Definition at line 171 of file style_manager.hpp.

Referenced by StyleManager::GetStrandStyle(), StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), StyleDialog::SetControls(), and SetRenderingStyle().

tubeRadius

double StyleSettings::tubeRadius

Definition at line 170 of file style_manager.hpp.

Referenced by StyleManager::GetAtomStyle(), StyleManager::GetBondStyle(), StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), SetBondStyleFromResidueStyle(), StyleDialog::SetControls(), and SetRenderingStyle().

tubeWormRadius

double StyleSettings::tubeWormRadius

Definition at line 170 of file style_manager.hpp.

Referenced by StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), SetBondStyleFromResidueStyle(), StyleDialog::SetControls(), and SetRenderingStyle().

virtualDisulfideColor

Vector StyleSettings::virtualDisulfideColor

Definition at line 168 of file style_manager.hpp.

Referenced by StyleManager::GetBondStyle(), StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), SetColorScheme(), and StyleDialog::SetControls().

virtualDisulfidesOn

bool StyleSettings::virtualDisulfidesOn

Definition at line 166 of file style_manager.hpp.

Referenced by StyleManager::GetBondStyle(), StyleDialog::GetValues(), LoadSettingsFromASN(), SaveSettingsToASN(), StyleDialog::SetControls(), and SetRenderingStyle().

---

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

• src/app/cn3d/style_manager.hpp
• src/app/cn3d/style_manager.cpp