org.openscience.cdk.renderer.generators

Class BasicSceneGenerator

java.lang.Object

org.openscience.cdk.renderer.generators.BasicSceneGenerator

All Implemented Interfaces:

IGenerator<IAtomContainer>

public class BasicSceneGenerator
extends Object
implements IGenerator<IAtomContainer>

This generator does not create any elements, but acts as a holding place for various generator parameters used by most drawings, such as the zoom, background color, margin, etc.

Source code:

master

Belongs to CDK module:

renderbasic

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BasicSceneGenerator.ArrowHeadWidth The width of the head of arrows.
static class	BasicSceneGenerator.BackgroundColor The background color of the drawn image.
static class	BasicSceneGenerator.BondLength The length on the screen of a typical bond.
static class	BasicSceneGenerator.FitToScreen If true, the scale is set such that the diagram fills the whole screen.
static class	BasicSceneGenerator.FontName Font to use for text.
static class	BasicSceneGenerator.ForegroundColor The foreground color, with which objects are drawn.
static class	BasicSceneGenerator.Margin Area on each of the four margins to keep empty.
static class	BasicSceneGenerator.Scale The scale is the factor to multiply model coordinates by to convert the coordinates to screen space coordinate, such that the entire structure fits the visible screen dimension.
static class	BasicSceneGenerator.ShowMoleculeTitle Determines if the molecule's title is depicted.
static class	BasicSceneGenerator.ShowReactionTitle Determines if the reaction's title is depicted.
static class	BasicSceneGenerator.ShowTooltip Determines if tooltips are to be shown.
static class	BasicSceneGenerator.UseAntiAliasing If set to true, uses anti-aliasing for drawing.
static class	BasicSceneGenerator.UsedFontStyle The font style to use for text.
static class	BasicSceneGenerator.ZoomFactor The zoom factor which is a user oriented parameter allowing the user to zoom in on parts of the molecule.

Constructor Summary

Constructors

Constructor and Description
BasicSceneGenerator() An empty constructor necessary for reflection.

Method Summary

Methods

Modifier and Type	Method and Description
IRenderingElement	generate(IAtomContainer ac, RendererModel model) Converts a IChemObject from the chemical data model into something that can be drawn in the chemical drawing.
List<IGeneratorParameter<?>>	getParameters() Returns the list of IGeneratorParameter for this particular generator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicSceneGenerator

public BasicSceneGenerator()

An empty constructor necessary for reflection.

Method Detail

generate

public IRenderingElement generate(IAtomContainer ac,
                         RendererModel model)

Converts a IChemObject from the chemical data model into something that can be drawn in the chemical drawing.

Specified by:

generate in interface IGenerator<IAtomContainer>

Parameters:

ac - the chemical entity to be depicted

model - the rendering parameters

Returns:

a drawable chemical depiction component

getParameters

public List<IGeneratorParameter<?>> getParameters()

Returns the list of IGeneratorParameter for this particular generator.

Specified by:

getParameters in interface IGenerator<IAtomContainer>

Returns:

a List of IGeneratorParameters