Chemical Data Processing Library C++ API - Version 1.2.0
Variables
CDPL::Vis::BondProperty Namespace Reference

Provides keys for built-in Chem::Bond properties. More...

Variables

CDPL_VIS_API const Base::LookupKey COLOR
 Specifies the color of the bond. More...
 
CDPL_VIS_API const Base::LookupKey LINE_WIDTH
 Specifies the width of bond lines. More...
 
CDPL_VIS_API const Base::LookupKey LINE_SPACING
 Specifies the distance between the lines of double and triple bonds. More...
 
CDPL_VIS_API const Base::LookupKey STEREO_BOND_WEDGE_WIDTH
 Specifies the width of wedge-shaped stereo bonds. More...
 
CDPL_VIS_API const Base::LookupKey STEREO_BOND_HASH_SPACING
 Specifies the distance between the hashes of down stereo bonds. More...
 
CDPL_VIS_API const Base::LookupKey REACTION_CENTER_LINE_LENGTH
 Specifies the length of the lines in reaction center marks. More...
 
CDPL_VIS_API const Base::LookupKey REACTION_CENTER_LINE_SPACING
 Specifies the distance between the lines in reaction center marks. More...
 
CDPL_VIS_API const Base::LookupKey DOUBLE_BOND_TRIM_LENGTH
 Specifies the amount by which the non-central lines of asymmetric double bonds have to be trimmed at each line end. More...
 
CDPL_VIS_API const Base::LookupKey TRIPLE_BOND_TRIM_LENGTH
 Specifies the amount by which the non-central lines of triple bonds have to be trimmed at each line end. More...
 
CDPL_VIS_API const Base::LookupKey LABEL_FONT
 Specifies the font for bond labels. More...
 
CDPL_VIS_API const Base::LookupKey LABEL_SIZE
 Specifies the size of bond labels. More...
 
CDPL_VIS_API const Base::LookupKey LABEL_MARGIN
 Specifies the margin of free space around bond labels. More...
 
CDPL_VIS_API const Base::LookupKey CONFIGURATION_LABEL_FONT
 Specifies the font used for bond configuration descriptor text labels. More...
 
CDPL_VIS_API const Base::LookupKey CONFIGURATION_LABEL_SIZE
 Specifies the size of bond configuration descriptor text labels. More...
 
CDPL_VIS_API const Base::LookupKey CONFIGURATION_LABEL_COLOR
 Specifies the color used for bond configuration descriptor text labels. More...
 
CDPL_VIS_API const Base::LookupKey CUSTOM_LABEL_FONT
 Specifies the font used for custom text labels. More...
 
CDPL_VIS_API const Base::LookupKey CUSTOM_LABEL_SIZE
 Specifies the size of custom text labels. More...
 
CDPL_VIS_API const Base::LookupKey CUSTOM_LABEL_COLOR
 Specifies the color used for custom text labels. More...
 
CDPL_VIS_API const Base::LookupKey CUSTOM_LABEL
 Specifies the custom label text. Value Type: std::string. More...
 
CDPL_VIS_API const Base::LookupKey HIGHLIGHTED_FLAG
 Specifies whether or not the bond is highlighted. Value Type: bool. More...
 
CDPL_VIS_API const Base::LookupKey HIGHLIGHT_AREA_BRUSH
 Specifies the brush to use for filling atom highlighting areas. Value Type: Vis::Brush. More...
 
CDPL_VIS_API const Base::LookupKey HIGHLIGHT_AREA_OUTLINE_PEN
 Specifies the pen to use for drawing atom highlighting area outlines. Value Type: Vis::Pen. More...
 

Detailed Description

Provides keys for built-in Chem::Bond properties.

Variable Documentation

◆ COLOR

CDPL_VIS_API const Base::LookupKey CDPL::Vis::BondProperty::COLOR
extern

Specifies the color of the bond.

The color specified by this property takes precedence over the colors specified by Vis::ControlParameter::BOND_COLOR and Vis::MolecularGraphProperty::BOND_COLOR.

Value Type: Vis::Color

◆ LINE_WIDTH

CDPL_VIS_API const Base::LookupKey CDPL::Vis::BondProperty::LINE_WIDTH
extern

Specifies the width of bond lines.

The width can either be specified as an absolute value or as a scaling factor for the bond length. If input-scaling is enabled, the line width will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the line width grows/shrinks with the size of the chemical structure during viewport size adjustment. The line width specified by this property takes precedence over the widths specified by Vis::ControlParameter::BOND_LINE_WIDTH and Vis::MolecularGraphProperty::BOND_LINE_WIDTH.

Value Type: Vis::SizeSpecification

◆ LINE_SPACING

CDPL_VIS_API const Base::LookupKey CDPL::Vis::BondProperty::LINE_SPACING
extern

Specifies the distance between the lines of double and triple bonds.

The distance can either be specified as an absolute value or as a scaling factor for the bond length. If input-scaling is enabled, the line distance will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the distance grows/shrinks with the size of the chemical structure during viewport size adjustment. The line spacing specified by this property takes precedence over the distances specified by Vis::ControlParameter::BOND_LINE_SPACING and Vis::MolecularGraphProperty::BOND_LINE_SPACING.

Value Type: Vis::SizeSpecification

◆ STEREO_BOND_WEDGE_WIDTH

CDPL_VIS_API const Base::LookupKey CDPL::Vis::BondProperty::STEREO_BOND_WEDGE_WIDTH
extern

Specifies the width of wedge-shaped stereo bonds.

The width can either be specified as an absolute value or as a scaling factor for the bond length. If input-scaling is enabled, the wedge width will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the wedge width grows/shrinks with the size of the chemical structure during viewport size adjustment. The wedge width specified by this property takes precedence over the width specified by Vis::ControlParameter::STEREO_BOND_WEDGE_WIDTH or Vis::MolecularGraphProperty::STEREO_BOND_WEDGE_WIDTH.

Value Type: Vis::SizeSpecification

◆ STEREO_BOND_HASH_SPACING

CDPL_VIS_API const Base::LookupKey CDPL::Vis::BondProperty::STEREO_BOND_HASH_SPACING
extern

Specifies the distance between the hashes of down stereo bonds.

The distance can either be specified as an absolute value or as a scaling factor for the bond length. If input-scaling is enabled, the hash distance will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the hash distance grows/shrinks with the size of the chemical structure during viewport size adjustment. The hash spacing specified by this property takes precedence over the distances specified by Vis::ControlParameter::STEREO_BOND_HASH_SPACING and Vis::MolecularGraphProperty::STEREO_BOND_HASH_SPACING.

Value Type: Vis::SizeSpecification

◆ REACTION_CENTER_LINE_LENGTH

CDPL_VIS_API const Base::LookupKey CDPL::Vis::BondProperty::REACTION_CENTER_LINE_LENGTH
extern

Specifies the length of the lines in reaction center marks.

The length can either be specified as an absolute value or as a scaling factor for the bond length. If input-scaling is enabled, the line length will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the length grows/shrinks with the size of the chemical structure during viewport size adjustment. The line length specified by this property takes precedence over the length specified by Vis::ControlParameter::REACTION_CENTER_LINE_LENGTH or Vis::MolecularGraphProperty::REACTION_CENTER_LINE_LENGTH.

Value Type: Vis::SizeSpecification

See also
Vis::ControlParameter::SHOW_BOND_REACTION_INFOS

◆ REACTION_CENTER_LINE_SPACING

CDPL_VIS_API const Base::LookupKey CDPL::Vis::BondProperty::REACTION_CENTER_LINE_SPACING
extern

Specifies the distance between the lines in reaction center marks.

The distance can either be specified as an absolute value or as a scaling factor for the bond length. If input-scaling is enabled, the line distance will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the distance grows/shrinks with the size of the chemical structure during viewport size adjustment. The line spacing specified by this property takes precedence over the spacing specified by Vis::ControlParameter::REACTION_CENTER_LINE_SPACING or Vis::MolecularGraphProperty::REACTION_CENTER_LINE_SPACING.

Value Type: Vis::SizeSpecification

See also
Vis::ControlParameter::SHOW_BOND_REACTION_INFOS

◆ DOUBLE_BOND_TRIM_LENGTH

CDPL_VIS_API const Base::LookupKey CDPL::Vis::BondProperty::DOUBLE_BOND_TRIM_LENGTH
extern

Specifies the amount by which the non-central lines of asymmetric double bonds have to be trimmed at each line end.

The trim length can either be specified as an absolute value or as a scaling factor for the bond length. If input-scaling is enabled, the trim length will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the length grows/shrinks with the size of the chemical structure during viewport size adjustment. The trim length specified by this property takes precedence over the lengths specified by Vis::ControlParameter::DOUBLE_BOND_TRIM_LENGTH and Vis::MolecularGraphProperty::DOUBLE_BOND_TRIM_LENGTH.

Value Type: Vis::SizeSpecification

◆ TRIPLE_BOND_TRIM_LENGTH

CDPL_VIS_API const Base::LookupKey CDPL::Vis::BondProperty::TRIPLE_BOND_TRIM_LENGTH
extern

Specifies the amount by which the non-central lines of triple bonds have to be trimmed at each line end.

The trim length can either be specified as an absolute value or as a scaling factor for the bond length. If input-scaling is enabled, the trim length will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the length grows/shrinks with the size of the chemical structure during viewport size adjustment. The trim length specified by this property takes precedence over the lengths specified by Vis::ControlParameter::TRIPLE_BOND_TRIM_LENGTH and Vis::MolecularGraphProperty::TRIPLE_BOND_TRIM_LENGTH.

Value Type: Vis::SizeSpecification

◆ LABEL_FONT

CDPL_VIS_API const Base::LookupKey CDPL::Vis::BondProperty::LABEL_FONT
extern

Specifies the font for bond labels.

The font specified by this property takes precedence over the fonts specified by Vis::ControlParameter::BOND_LABEL_FONT and Vis::MolecularGraphProperty::BOND_LABEL_FONT.

Value Type: Vis::Font

◆ LABEL_SIZE

CDPL_VIS_API const Base::LookupKey CDPL::Vis::BondProperty::LABEL_SIZE
extern

Specifies the size of bond labels.

The font size has to be specified as an absolute value. If input-scaling is enabled, the font size will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the font size will follow the size change of the chemical structure during viewport size adjustment. The font size specified by this property takes precedence over the sizes specified by Vis::ControlParameter::BOND_LABEL_SIZE and Vis::MolecularGraphProperty::BOND_LABEL_SIZE.

Value Type: Vis::SizeSpecification

◆ LABEL_MARGIN

CDPL_VIS_API const Base::LookupKey CDPL::Vis::BondProperty::LABEL_MARGIN
extern

Specifies the margin of free space around bond labels.

The margin can either be specified as an absolute value or as a scaling factor for the primary label size given by Vis::ControlParameter::BOND_LABEL_SIZE, Vis::MolecularGraphProperty::BOND_LABEL_SIZE or Vis::BondProperty::LABEL_SIZE. If input-scaling is enabled, the width of the margin will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the margin will follow the size change of the chemical structure during viewport size adjustment. The margin specified by this property takes precedence over the margins specified by Vis::ControlParameter::BOND_LABEL_MARGIN and Vis::MolecularGraphProperty::BOND_LABEL_MARGIN.

Value Type: Vis::SizeSpecification

◆ CONFIGURATION_LABEL_FONT

CDPL_VIS_API const Base::LookupKey CDPL::Vis::BondProperty::CONFIGURATION_LABEL_FONT
extern

Specifies the font used for bond configuration descriptor text labels.

The font specified by this property takes precedence over the fonts specified by Vis::ControlParameter::BOND_CONFIGURATION_LABEL_FONT and Vis::MolecularGraphProperty::BOND_CONFIGURATION_LABEL_FONT.

Value Type: Vis::Font

Since
1.1

◆ CONFIGURATION_LABEL_SIZE

CDPL_VIS_API const Base::LookupKey CDPL::Vis::BondProperty::CONFIGURATION_LABEL_SIZE
extern

Specifies the size of bond configuration descriptor text labels.

The size can either be specified as an absolute value or as a scaling factor for the primary label size given by Vis::ControlParameter::BOND_LABEL_SIZE, Vis::MolecularGraphProperty::BOND_LABEL_SIZE or Vis::BondProperty::LABEL_SIZE. If input-scaling is enabled, the size of the font will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the font size will follow the size change of the chemical structure during viewport size adjustment. The specified size takes precedence over the size specified by the parameter Vis::ControlParameter::BOND_CONFIGURATION_LABEL_SIZE and Vis::MolecularGraphProperty::BOND_CONFIGURATION_LABEL_SIZE.

Value Type: Vis::SizeSpecification

Since
1.1

◆ CONFIGURATION_LABEL_COLOR

CDPL_VIS_API const Base::LookupKey CDPL::Vis::BondProperty::CONFIGURATION_LABEL_COLOR
extern

Specifies the color used for bond configuration descriptor text labels.

The color specified by this property takes precedence over the colors specified by Vis::ControlParameter::BOND_CONFIGURATION_LABEL_COLOR and Vis::MolecularGraphProperty::BOND_CONFIGURATION_LABEL_COLOR.

Value Type: Vis::Color

Since
1.2

◆ CUSTOM_LABEL_FONT

CDPL_VIS_API const Base::LookupKey CDPL::Vis::BondProperty::CUSTOM_LABEL_FONT
extern

Specifies the font used for custom text labels.

The font specified by this property takes precedence over the fonts specified by Vis::ControlParameter::BOND_CUSTOM_LABEL_FONT and Vis::MolecularGraphProperty::BOND_CUSTOM_LABEL_FONT.

Value Type: Vis::Font

Since
1.2

◆ CUSTOM_LABEL_SIZE

CDPL_VIS_API const Base::LookupKey CDPL::Vis::BondProperty::CUSTOM_LABEL_SIZE
extern

Specifies the size of custom text labels.

The size can either be specified as an absolute value or as a scaling factor for the primary label size given by Vis::ControlParameter::BOND_LABEL_SIZE, Vis::MolecularGraphProperty::BOND_LABEL_SIZE or Vis::BondProperty::LABEL_SIZE. If input-scaling is enabled, the size of the font will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the font size will follow the size change of the chemical structure during viewport size adjustment. The specified size takes precedence over the size specified by the parameter Vis::ControlParameter::BOND_CUSTOM_LABEL_SIZE and Vis::MolecularGraphProperty::BOND_CUSTOM_LABEL_SIZE.

Value Type: Vis::SizeSpecification

Since
1.2

◆ CUSTOM_LABEL_COLOR

CDPL_VIS_API const Base::LookupKey CDPL::Vis::BondProperty::CUSTOM_LABEL_COLOR
extern

Specifies the color used for custom text labels.

The color specified by this property takes precedence over the colors specified by Vis::ControlParameter::BOND_CUSTOM_LABEL_COLOR and Vis::MolecularGraphProperty::BOND_CUSTOM_LABEL_COLOR.

Value Type: Vis::Color

Since
1.2

◆ CUSTOM_LABEL

CDPL_VIS_API const Base::LookupKey CDPL::Vis::BondProperty::CUSTOM_LABEL
extern

Specifies the custom label text. Value Type: std::string.

Since
1.2

◆ HIGHLIGHTED_FLAG

CDPL_VIS_API const Base::LookupKey CDPL::Vis::BondProperty::HIGHLIGHTED_FLAG
extern

Specifies whether or not the bond is highlighted. Value Type: bool.

Since
1.2

◆ HIGHLIGHT_AREA_BRUSH

CDPL_VIS_API const Base::LookupKey CDPL::Vis::BondProperty::HIGHLIGHT_AREA_BRUSH
extern

Specifies the brush to use for filling atom highlighting areas. Value Type: Vis::Brush.

Since
1.2

◆ HIGHLIGHT_AREA_OUTLINE_PEN

CDPL_VIS_API const Base::LookupKey CDPL::Vis::BondProperty::HIGHLIGHT_AREA_OUTLINE_PEN
extern

Specifies the pen to use for drawing atom highlighting area outlines. Value Type: Vis::Pen.

Since
1.2