Package org.openscience.cdk.renderer
Class SymbolVisibility
java.lang.Object
org.openscience.cdk.renderer.SymbolVisibility
- Direct Known Subclasses:
SelectionVisibility
Predicate that defines whether an atom symbol is displayed in a structure diagram.
SymbolVisibility visibility = SymbolVisibility.iupacRecommendations();
- Author:
- John May
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic SymbolVisibility
all()
All atom symbols are visible.static SymbolVisibility
Displays a symbol based on the preferred representation from the IUPAC guidelines (GR-2.1.2) [Jonathan Brecher. Pure Appl. Chem. 2008. 80].static SymbolVisibility
Displays a symbol based on the acceptable representation from the IUPAC guidelines (GR-2.1.2) [Jonathan Brecher. Pure Appl. Chem. 2008. 80].abstract boolean
visible
(IAtom atom, List<IBond> neighbors, RendererModel model) Determine if an atom with the specified bonds is visible.
-
Constructor Details
-
SymbolVisibility
public SymbolVisibility()
-
-
Method Details
-
visible
Determine if an atom with the specified bonds is visible.- Parameters:
atom
- an atomneighbors
- neighboring bonds- Returns:
- whether the atom symbol is visible
-
all
All atom symbols are visible.- Returns:
- visibility that displays all symbols
-
iupacRecommendations
Displays a symbol based on the preferred representation from the IUPAC guidelines (GR-2.1.2) [Jonathan Brecher. Pure Appl. Chem. 2008. 80]. Carbons are unlabeled unless they have abnormal valence, parallel bonds, or are terminal (i.e. methyl, methylene, etc).- Returns:
- symbol visibility instance
-
iupacRecommendationsWithoutTerminalCarbon
Displays a symbol based on the acceptable representation from the IUPAC guidelines (GR-2.1.2) [Jonathan Brecher. Pure Appl. Chem. 2008. 80]. Carbons are unlabeled unless they have abnormal valence, parallel bonds. The recommendations note that it is acceptable to leave methyl groups unlabelled.- Returns:
- symbol visibility instance
-