Package org.sbml.jsbml.ext.render.director

Interface LayoutAlgorithm

All Known Implementing Classes:

SimpleLayoutAlgorithm

public interface LayoutAlgorithm

Interface for defining an algorithm to create bounding boxes, dimensions and points missing in the layout.

Since:

1.4

Author:

Mirjam Gutekunst

Method Summary

Modifier and Type	Method	Description
void	addLayoutedEdge(SpeciesReferenceGlyph srg, ReactionGlyph rg)	Add a layouted edge to the input of the algorithm.
void	addLayoutedGlyph(GraphicalObject glyph)	Add a fully layouted glyph (i.e. glyph with boundingbox, dimensions and position) to the input of the algorithm.
void	addUnlayoutedEdge(SpeciesReferenceGlyph srg, ReactionGlyph rg)	Add an unlayouted edge to the input of the algorithm.
void	addUnlayoutedGlyph(GraphicalObject glyph)	Add a glyph with missing layout information (i.e. no dimensions or no position specified) to the input of the algorithm.
double	calculateReactionGlyphRotationAngle(ReactionGlyph reactionGlyph)	method to calculate the rotation angle of the lines from the reaction box, in degrees
java.util.Set<GraphicalObject>	completeGlyphs()	Return the input set of unlayouted glyphs with completed layout information.
Dimensions	createCompartmentGlyphDimension(CompartmentGlyph previousCompartmentGlyph)	method to create a Dimensions for a CompartmentGlyph if it was missing in the layout model
Point	createCompartmentGlyphPosition(CompartmentGlyph previousCompartmentGlyph)	Deprecated.
Curve	createCurve(ReactionGlyph reactionGlyph, SpeciesReferenceGlyph speciesReferenceGlyph)	method to create the Curve of a SpeciesReferenceGlyph, starting or ending at the given ReactionGlyph
BoundingBox	createGlyphBoundingBox(GraphicalObject glyph, SpeciesReferenceGlyph specRefGlyph)	method to create a BoundingBox for every kind of GraphicalObject.
Dimensions	createLayoutDimension()	method to create a Dimensions for the layout if it was missing in the layout model
Dimensions	createReactionGlyphDimension(ReactionGlyph reactionGlyph)	method to create a Dimensions for a ReactionGlyph if it was missing in the layout model
Dimensions	createSpeciesGlyphDimension()	method to create a Dimensions for a SpeciesGlyph if it was missing in the layout model
Dimensions	createSpeciesReferenceGlyphDimension(ReactionGlyph reactionGlyph, SpeciesReferenceGlyph speciesReferenceGlyph)	method to create a Dimensions for a SpeciesReferenceGlyph if it was missing in the layout model
Dimensions	createTextGlyphDimension(TextGlyph textGlyph)	method to create a Dimensions for a TextGlyph if it was missing in the layout model
Layout	getLayout()
boolean	isSetLayout()
void	setLayout(Layout layout)

Method Detail

createLayoutDimension

Dimensions createLayoutDimension()

method to create a Dimensions for the layout if it was missing in the layout model

Returns:

a Dimensions

createCompartmentGlyphDimension

Dimensions createCompartmentGlyphDimension(CompartmentGlyph previousCompartmentGlyph)

method to create a Dimensions for a CompartmentGlyph if it was missing in the layout model

Parameters:

previousCompartmentGlyph - the last CompartmentGlyph that had been drawn before the CompartmentGlyph that is missing a Dimensions

Returns:

a Dimensions

createCompartmentGlyphPosition

@Deprecated
Point createCompartmentGlyphPosition(CompartmentGlyph previousCompartmentGlyph)

Deprecated.

method to create a Position for a CompartmentGlyph if it was missing in the layout model

Parameters:

previousCompartmentGlyph - the last CompartmentGlyph that had been drawn before the CompartmentGlyph that is missing a Position

Returns:

a Position

createSpeciesGlyphDimension

Dimensions createSpeciesGlyphDimension()

method to create a Dimensions for a SpeciesGlyph if it was missing in the layout model

Returns:

a Dimensions

createCurve

Curve createCurve(ReactionGlyph reactionGlyph,
                  SpeciesReferenceGlyph speciesReferenceGlyph)

method to create the Curve of a SpeciesReferenceGlyph, starting or ending at the given ReactionGlyph

Parameters:

reactionGlyph - at which the Curve starts or ends

speciesReferenceGlyph - for which the Curve is missing

Returns:

a Curve

createTextGlyphDimension

Dimensions createTextGlyphDimension(TextGlyph textGlyph)

method to create a Dimensions for a TextGlyph if it was missing in the layout model

Parameters:

textGlyph - for which the Dimensions is missing

Returns:

a Dimensions

createReactionGlyphDimension

Dimensions createReactionGlyphDimension(ReactionGlyph reactionGlyph)

method to create a Dimensions for a ReactionGlyph if it was missing in the layout model

Parameters:

reactionGlyph - for which the Dimensions is missing

Returns:

a Dimensions

createSpeciesReferenceGlyphDimension

Dimensions createSpeciesReferenceGlyphDimension(ReactionGlyph reactionGlyph,
                                                SpeciesReferenceGlyph speciesReferenceGlyph)

method to create a Dimensions for a SpeciesReferenceGlyph if it was missing in the layout model

Parameters:

reactionGlyph - from which the SpeciesReferenceGlyph is drawn

speciesReferenceGlyph - for which the Dimensions is missing

Returns:

a Dimensions

createGlyphBoundingBox

BoundingBox createGlyphBoundingBox(GraphicalObject glyph,
                                   SpeciesReferenceGlyph specRefGlyph)

method to create a BoundingBox for every kind of GraphicalObject.

Parameters:

glyph -

specRefGlyph -

Returns:

setLayout

void setLayout(Layout layout)

Parameters:

layout - the Layout to be set for this LayoutAlgorithm

getLayout

Layout getLayout()

Returns:

the Layout set for this LayoutAlgorithm;

isSetLayout

boolean isSetLayout()

Returns:

true if a Layout is set for this LayoutAlgorithm, else false

calculateReactionGlyphRotationAngle

double calculateReactionGlyphRotationAngle(ReactionGlyph reactionGlyph)

method to calculate the rotation angle of the lines from the reaction box, in degrees

Parameters:

reactionGlyph - for which the rotation angle shall be calculated

Returns:

the rotation angle in degrees

addLayoutedGlyph

void addLayoutedGlyph(GraphicalObject glyph)

Add a fully layouted glyph (i.e. glyph with boundingbox, dimensions and position) to the input of the algorithm.

addUnlayoutedGlyph

void addUnlayoutedGlyph(GraphicalObject glyph)

Add a glyph with missing layout information (i.e. no dimensions or no position specified) to the input of the algorithm.

addLayoutedEdge

void addLayoutedEdge(SpeciesReferenceGlyph srg,
                     ReactionGlyph rg)

Add a layouted edge to the input of the algorithm.

Parameters:

srg - species node of the edge

rg - process node of the edge

addUnlayoutedEdge

void addUnlayoutedEdge(SpeciesReferenceGlyph srg,
                       ReactionGlyph rg)

Add an unlayouted edge to the input of the algorithm.

Parameters:

srg - species node of the edge

rg - process node of the edge

completeGlyphs

java.util.Set<GraphicalObject> completeGlyphs()

Return the input set of unlayouted glyphs with completed layout information.