Class AtomContainerRenderer
- java.lang.Object
-
- org.openscience.cdk.renderer.AbstractRenderer<IAtomContainer>
-
- org.openscience.cdk.renderer.AtomContainerRenderer
-
- All Implemented Interfaces:
IRenderer<IAtomContainer>
public class AtomContainerRenderer extends AbstractRenderer<IAtomContainer> implements IRenderer<IAtomContainer>
A general renderer forIAtomContainer
s. The chem object is converted into a 'diagram' made up ofIRenderingElement
s. It takes anIDrawVisitor
to do the drawing of the generated diagram. Various display properties can be set using theRendererModel
.This class has several usage patterns. For just painting fit-to-screen do:
renderer.paintMolecule(molecule, visitor, drawArea)
for painting at a scale determined by the bond length in the RendererModel:if (moleculeIsNew) { renderer.setup(molecule, drawArea); } Rectangle diagramSize = renderer.paintMolecule(molecule, visitor); // ...update scroll bars here
to paint at full screen size, but not resize with each change:if (moleculeIsNew) { renderer.setScale(molecule); Rectangle diagramBounds = renderer.calculateDiagramBounds(molecule); renderer.setZoomToFit(diagramBounds, drawArea); renderer.paintMolecule(molecule, visitor); } else { Rectangle diagramSize = renderer.paintMolecule(molecule, visitor); // ...update scroll bars here }
finally, if you are scrolling, and have not changed the diagram:renderer.repaint(visitor)
will just repaint the previously generated diagram, at the same scale.There are two sets of methods for painting IChemObjects - those that take a Rectangle that represents the desired draw area, and those that return a Rectangle that represents the actual draw area. The first are intended for drawing molecules fitted to the screen (where 'screen' means any drawing area) while the second type of method are for drawing bonds at the length defined by the
RendererModel
parameter bondLength.There are two numbers used to transform the model so that it fits on screen. The first is
scale
, which is used to map model coordinates to screen coordinates. The second iszoom
which is used to, well, zoom the on screen coordinates. If the diagram is fit-to-screen, then the ratio of the bounds when drawn using bondLength and the bounds of the screen is used as the zoom.So, if the bond length on screen is set to 40, and the average bond length of the model is 2 (unitless, but roughly Ångstrom scale) then the scale will be 20. If the model is 10 units wide, then the diagram drawn at 100% zoom will be 10 * 20 = 200 in width on screen. If the screen is 400 pixels wide, then fitting it to the screen will make the zoom 200%. Since the zoom is just a floating point number, 100% = 1 and 200% = 2.
- Author:
- maclean
- Source code:
- main
- Belongs to CDK module:
- renderbasic
-
-
Field Summary
Fields Modifier and Type Field Description static double
DEFAULT_SCALE
The default scale is used when the model is empty.-
Fields inherited from class org.openscience.cdk.renderer.AbstractRenderer
cachedDiagram, drawCenter, fontManager, generators, modelCenter, rendererModel, transform
-
-
Constructor Summary
Constructors Constructor Description AtomContainerRenderer(List<IGenerator<IAtomContainer>> generators, IFontManager fontManager)
A renderer that generates diagrams using the specified generators and manages fonts with the supplied font manager.AtomContainerRenderer(RendererModel rendererModel, List<IGenerator<IAtomContainer>> generators, IFontManager fontManager)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Rectangle
calculateDiagramBounds(IAtomContainer atomContainer)
Given aIChemObject
, calculates the bounding rectangle in screen space.double
calculateScaleForBondLength(double modelBondLength)
Given a bond length for a model, calculate the scale that will transform this length to the on screen bond length in RendererModel.List<IGenerator<IAtomContainer>>
getGenerators()
Returns aList
ofIGenerator
s for this renderer.Rectangle
paint(IAtomContainer atomContainer, IDrawVisitor drawVisitor)
Paint an IChemObject.void
paint(IAtomContainer atomContainer, IDrawVisitor drawVisitor, Rectangle2D bounds, boolean resetCenter)
Paint a molecule (an IAtomContainer).void
reset()
Reset the draw center and model center, and set the zoom to 100%.void
setScale(IAtomContainer atomContainer)
Set the scale for an IAtomContainer.void
setup(IAtomContainer atomContainer, Rectangle screen)
Setup the transformations necessary to draw this Atom Container.-
Methods inherited from class org.openscience.cdk.renderer.AbstractRenderer
calculateScreenBounds, convertToDiagramBounds, generateDiagram, getBounds, getDrawCenter, getModelCenter, getRenderer2DModel, paint, repaint, setDrawCenter, setModelCenter, setup, setupTransformNatural, setupTransformToFit, setZoom, setZoomToFit, shift, shiftDrawCenter, toModelCoordinates, toScreenCoordinates
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.openscience.cdk.renderer.IRenderer
generateDiagram, getRenderer2DModel, setZoom, shiftDrawCenter, toModelCoordinates, toScreenCoordinates
-
-
-
-
Field Detail
-
DEFAULT_SCALE
public static final double DEFAULT_SCALE
The default scale is used when the model is empty.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
AtomContainerRenderer
public AtomContainerRenderer(List<IGenerator<IAtomContainer>> generators, IFontManager fontManager)
A renderer that generates diagrams using the specified generators and manages fonts with the supplied font manager.- Parameters:
generators
- a list of classes that implement the IGenerator interfacefontManager
- a class that manages mappings between zoom and font sizes
-
AtomContainerRenderer
public AtomContainerRenderer(RendererModel rendererModel, List<IGenerator<IAtomContainer>> generators, IFontManager fontManager)
-
-
Method Detail
-
setup
public void setup(IAtomContainer atomContainer, Rectangle screen)
Setup the transformations necessary to draw this Atom Container.- Specified by:
setup
in interfaceIRenderer<IAtomContainer>
- Parameters:
atomContainer
- the atom container to use in the setupscreen
- the area to draw on
-
reset
public void reset()
Reset the draw center and model center, and set the zoom to 100%.
-
setScale
public void setScale(IAtomContainer atomContainer)
Set the scale for an IAtomContainer. It calculates the average bond length of the model and calculates the multiplication factor to transform this to the bond length that is set in the RendererModel.- Specified by:
setScale
in interfaceIRenderer<IAtomContainer>
- Parameters:
atomContainer
- the atom container that will be drawn
-
paint
public Rectangle paint(IAtomContainer atomContainer, IDrawVisitor drawVisitor)
Paint an IChemObject.- Specified by:
paint
in interfaceIRenderer<IAtomContainer>
- Parameters:
atomContainer
- the chem object to paintdrawVisitor
- the class that visits the generated elements- Returns:
- the rectangular area where was drawn
-
paint
public void paint(IAtomContainer atomContainer, IDrawVisitor drawVisitor, Rectangle2D bounds, boolean resetCenter)
Paint a molecule (an IAtomContainer).- Specified by:
paint
in interfaceIRenderer<IAtomContainer>
- Parameters:
atomContainer
- the molecule to paintdrawVisitor
- the visitor that does the drawingbounds
- the bounds on the screenresetCenter
- if true, set the draw center to be the center of bounds
-
calculateDiagramBounds
public Rectangle calculateDiagramBounds(IAtomContainer atomContainer)
Given aIChemObject
, calculates the bounding rectangle in screen space.- Specified by:
calculateDiagramBounds
in interfaceIRenderer<IAtomContainer>
- Parameters:
atomContainer
- theIChemObject
to draw.- Returns:
- a rectangle in screen space.
-
calculateScaleForBondLength
public double calculateScaleForBondLength(double modelBondLength)
Given a bond length for a model, calculate the scale that will transform this length to the on screen bond length in RendererModel.- Specified by:
calculateScaleForBondLength
in classAbstractRenderer<IAtomContainer>
- Parameters:
modelBondLength
- the average bond length of the model- Returns:
- the scale necessary to transform this to a screen bond
-
getGenerators
public List<IGenerator<IAtomContainer>> getGenerators()
Returns aList
ofIGenerator
s for this renderer.- Specified by:
getGenerators
in interfaceIRenderer<IAtomContainer>
- Returns:
- the list of generators for this renderer.
-
-