org.openscience.cdk.renderer.generators

Class MappingGenerator

java.lang.Object

org.openscience.cdk.renderer.generators.MappingGenerator

All Implemented Interfaces:

IGenerator<IReaction>

public class MappingGenerator
extends Object
implements IGenerator<IReaction>

IGenerator that will show how atoms map between the reactant and product side.

Source code:

master

Belongs to CDK module:

renderextra

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MappingGenerator.AtomAtomMappingLineColor The width on screen of an atom-atom mapping line.
static class	MappingGenerator.MappingLineWidth The width on screen of an atom-atom mapping line.
static class	MappingGenerator.ShowAtomAtomMapping Boolean by which atom-atom mapping depiction can be temporarily disabled.

Constructor Summary

Constructors

Constructor and Description
MappingGenerator()

Method Summary

Modifier and Type	Method and Description
IRenderingElement	generate(IReaction reaction, 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

MappingGenerator

public MappingGenerator()

Method Detail

generate

public IRenderingElement generate(IReaction reaction,
                                  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<IReaction>

Parameters:

reaction - 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<IReaction>

Returns:

a List of IGeneratorParameters