NCBI C++ ToolKit
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
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)
 
StyleSettingsoperator= (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

Enumerator
eOff 
eTrace 
ePartial 
eComplete 

Definition at line 73 of file style_manager.hpp.

◆ 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

Enumerator
eWire 
eTubes 
eBallAndStick 
eSpaceFill 
eWireWorm 
eTubeWorm 
eWithArrows 
eWithoutArrows 

Definition at line 81 of file style_manager.hpp.

◆ eLabelType

Enumerator
eOneLetter 
eThreeLetter 

Definition at line 135 of file style_manager.hpp.

◆ eNumberType

Enumerator
eNoNumbers 
eSequentialNumbering 
ePDBNumbering 

Definition at line 140 of file style_manager.hpp.

◆ 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

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

◆ 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)

◆ 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)

Member Data Documentation

◆ backgroundColor

Vector StyleSettings::backgroundColor

◆ ballRadius

double StyleSettings::ballRadius

◆ connections

GeneralStyle StyleSettings::connections

◆ helixObjects

GeneralStyle StyleSettings::helixObjects

◆ helixRadius

double StyleSettings::helixRadius

◆ heterogens

GeneralStyle StyleSettings::heterogens

◆ hydrogensOn

bool StyleSettings::hydrogensOn

◆ ionLabelsOn

bool StyleSettings::ionLabelsOn

◆ nucleotideBackbone

BackboneStyle StyleSettings::nucleotideBackbone

◆ nucleotideLabels

LabelStyle StyleSettings::nucleotideLabels

◆ nucleotideSidechains

GeneralStyle StyleSettings::nucleotideSidechains

◆ proteinBackbone

BackboneStyle StyleSettings::proteinBackbone

◆ proteinLabels

LabelStyle StyleSettings::proteinLabels

◆ proteinSidechains

GeneralStyle StyleSettings::proteinSidechains

◆ solvents

GeneralStyle StyleSettings::solvents

◆ spaceFillProportion

double StyleSettings::spaceFillProportion

◆ stickRadius

double StyleSettings::stickRadius

◆ strandObjects

GeneralStyle StyleSettings::strandObjects

◆ strandThickness

double StyleSettings::strandThickness

◆ strandWidth

double StyleSettings::strandWidth

◆ tubeRadius

double StyleSettings::tubeRadius

◆ tubeWormRadius

double StyleSettings::tubeWormRadius

◆ virtualDisulfideColor

Vector StyleSettings::virtualDisulfideColor

◆ virtualDisulfidesOn

bool StyleSettings::virtualDisulfidesOn

The documentation for this class was generated from the following files:
Modified on Sat Jul 20 11:11:08 2024 by modify_doxy.py rev. 669887