Render

Detailed Description

The libSBML “render” extension implements support for the SBML Level 3 Graphical Rendering ("render") package. It can be used in SBML Level 3 Version 1 and Version 2 documents.

Introduction

The graphical depiction of a reaction network diagram should be described as graphical representations of species and reactions, and not as arbitrary drawing or graph. While it may seem unnecessary to invent a new language when an existing one like SVG could in principle be used to describe the layout of a reaction network, there are good reasons to have a language tailored specifically for the layout of SBML models. For example, most programs that will use this SBML extension are primarily programs dealing with biochemical models. Internally, they will have data structures for species and reactions, so it will also be natural for them to depict the reaction network in terms of species and reactions (and not in terms of, e.g., polygons or splines).

The Graphical Rendering ("render") package for SBML Level 3 is a companion to the Graphical Layout ("layout") package. Together, they provide a complete format for describing the layout of a diagram and the visual rendition of the entities within it.

Authors

The primary authors of the SBML Level 3 Render specification are Frank T. Bergmann, Sarah M. Keating, Ralph Gauges, Sven Sahle and Katja Wengler.

The specification for this SBML package

This API documentation for libSBML does not provide a complete explanation of the SBML Level 3 “render” package. If you are developing software that uses “render”, you are strongly urged to read the actual specification for the package. A link to the specification document current is provided below, along with a link to the page of known issues (if any).

Specification for SBML Level 3 Render, current at the time of this libSBML release (5.18.0). Note: an Internet connection is required to access these documents.

Specification (in PDF format)	Known issues
Render package, Version 1 Release 1	Errata page

Data Structures
class	ColorDefinition_t
	render Definition of an identifier for an RGBA color value. More...
class	DefaultValues_t
	render Encoding of default values. More...
class	Ellipse_t
	render Graphical representation of an ellipse. More...
class	GlobalRenderInformation_t
	render Render information stored in a ListOfLayouts_t. More...
class	GlobalStyle_t
	render A style that can be associated with a layout. More...
class	GradientBase_t
	render Abstract base class for linear and radial gradients. More...
class	GradientStop_t
	render A color at a certain location in a color gradient. More...
class	GraphicalPrimitive1D_t
	render Base class for graphical primitives implementing 1D attributes. More...
class	GraphicalPrimitive2D_t
	render Base class for graphical primitives implementing 2D attributes. More...
class	Image_t
	render Representation of images. More...
class	LinearGradient_t
	render Representation of a linear gradient. More...
class	LineEnding_t
	render Decoration element for the start and/or end of curves. More...
class	ListOfColorDefinitions_t
	render A list of ColorDefinition_t objects. More...
class	ListOfCurveElements_t
	render A list of curve elements. More...
class	ListOfDrawables_t
	render A list of Transformation2D_t objects. More...
class	ListOfGlobalRenderInformation_t
	render A list of GlobalRenderInformation_t objects. More...
class	ListOfGlobalStyles_t
	render A list of GlobalStyle_t objects. More...
class	ListOfGradientDefinitions_t
	render A list of GradientBase_t objects. More...
class	ListOfGradientStops_t
	render A list of one or more GradientStop_t objects. More...
class	ListOfLineEndings_t
	render A list of LineEnding_t objects. More...
class	ListOfLocalRenderInformation_t
	render A list of LocalRenderInformation_t objects. More...
class	ListOfLocalStyles_t
	render A list of LocalStyle_t objects. More...
class	LocalRenderInformation_t
	render Rendering information stored in Layouts. More...
class	LocalStyle_t
	render Style information object used in LocalRenderInformation_t. More...
class	Polygon_t
	render Representation of a Polygon_t More...
class	RadialGradient_t
	render Representation of a radial gradient. More...
class	Rectangle_t
	render Representation of a rectangle. More...
class	RelAbsVector_t
	render Vectors with an absolute value and a relative value. More...
class	RenderCubicBezier_t
	render Representation of cubic Bezier curves. More...
class	RenderCurve_t
	render Representation of curves. More...
class	RenderExtension_t
	render Base extension class for the package. More...
class	RenderGraphicalObjectPlugin_t
	render The Render extension of the layout GraphicalObject_t class. More...
class	RenderGroup_t
	render A group of graphical primitives creating a composite. More...
class	RenderInformationBase_t
	render Abstract base class for local and global rendering information. More...
class	RenderLayoutPlugin_t
	render LibSBML implementation for the extension to the Layout_t class by the Render extension. More...
class	RenderListOfLayoutsPlugin_t
	render A list of layout objects used by the "render" extension. More...
class	RenderPkgNamespaces_t
	render SBMLNamespaces_t extension for the package. More...
class	RenderPoint_t
	render A point with both absolute and relative values More...
class	RenderSBMLDocumentPlugin_t
	render Extension of SBMLDocument_t. More...
class	RenderValidator_t
	render Entry point for “render” package validation. More...
class	Style_t
	render Abstract base class for local and global styles. More...
class	Text_t
	render Representation of text elements. More...
class	Transformation2D_t
	render Implementation of a 2D transformation matrix. More...
class	Transformation_t
	render Implementation of a 3D transformation matrix. More...

---

Data Structure Documentation

class RenderExtension_t

class RenderGraphicalObjectPlugin_t

class RenderLayoutPlugin_t

class RenderListOfLayoutsPlugin_t

class RenderPkgNamespaces_t

class RenderSBMLDocumentPlugin_t

class RenderValidator_t