org.openscience.cdk.renderer.generators

Interface IGenerator<T extends IChemObject>

All Known Implementing Classes:

AtomContainerBoundsGenerator, AtomMassGenerator, AtomNumberGenerator, BasicAtomGenerator, BasicBondGenerator, BasicGenerator, BasicSceneGenerator, BoundsGenerator, ExtendedAtomGenerator, HighlightGenerator, LonePairGenerator, MappingGenerator, ProductsBoxGenerator, RadicalGenerator, ReactantsBoxGenerator, ReactionArrowGenerator, ReactionBoxGenerator, ReactionPlusGenerator, ReactionSceneGenerator, RingGenerator, StandardGenerator

public interface IGenerator<T extends IChemObject>

An IGenerator converts chemical entities into parts of the chemical drawing expressed as IRenderingElements. Note that some generators have explicit empty constructors (like: "public MyGenerator() {}") which can be useful in some situations where reflection is required. It is not, however, necessary for most normal drawing situations.

Source code:

master

Belongs to CDK module:

render

Method Summary

Methods

Modifier and Type	Method and Description
IRenderingElement	generate(T object, 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.

Method Detail

getParameters

List<IGeneratorParameter<?>> getParameters()

Returns the list of IGeneratorParameter for this particular generator.

Returns:

a List of IGeneratorParameters

generate

IRenderingElement generate(T object,
                         RendererModel model)

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

Parameters:

object - the chemical entity to be depicted

model - the rendering parameters

Returns:

a drawable chemical depiction component