libSBNW
|
Classes | |
struct | gf_network |
A reaction network. More... | |
struct | gf_node |
A species in a model. More... | |
struct | gf_reaction |
A reaction in a model. More... | |
struct | gf_curve |
A 2D cubic Bezier curve. More... | |
struct | gf_compartment |
A compartment in a model. More... | |
struct | gf_canvas |
Drawing canvas. More... | |
struct | gf_layoutInfo |
Type which holds layout info. More... | |
struct | gf_point |
A point in 2D space. More... | |
struct | gf_transform |
A 2D affine transform. More... | |
struct | gf_curveCP |
A curve control points. More... | |
struct | __fr_options |
Options passed to the Fruchterman-Reingold algorithm. More... | |
Typedefs | |
typedef struct __fr_options | fr_options |
Options passed to the Fruchterman-Reingold algorithm. More... | |
Enumerations | |
enum | gf_specRole { GF_ROLE_SUBSTRATE, GF_ROLE_PRODUCT, GF_ROLE_SIDESUBSTRATE, GF_ROLE_SIDEPRODUCT, GF_ROLE_MODIFIER, GF_ROLE_ACTIVATOR, GF_ROLE_INHIBITOR } |
Species role in a reaction. More... | |
Functions | |
_GraphfabExport char * | gf_getLastError () |
Gets the last error. More... | |
_GraphfabExport int | gf_haveError () |
Gets whether an error occurred. More... | |
_GraphfabExport void | gf_clearError () |
Clears the last error. | |
_GraphfabExport const char * | gf_renderTikZ (gf_layoutInfo *l) |
Render the model as a TikZ image. More... | |
_GraphfabExport int | gf_renderTikZFile (gf_layoutInfo *l, const char *filename) |
Render the model as a TikZ image. More... | |
_GraphfabExport void | gf_freeLayoutInfo (gf_layoutInfo *l) |
Call to clean up an instance of gf_layoutInfo when it is no longer needed. More... | |
_GraphfabExport void | gf_freeLayoutInfoHierarch (gf_layoutInfo *l) |
Call to clean up an instance of gf_layoutInfo and all contained data structures. More... | |
_GraphfabExport void | gf_freeModelAndLayout (gf_SBMLModel *mod, gf_layoutInfo *l) |
Call to clean up an instance of gf_layoutInfo and gf_SBMLModel when they are no longer needed. More... | |
_GraphfabExport gf_SBMLModel * | gf_SBMLModel_newp () |
Create a new SBML model. More... | |
_GraphfabExport gf_layoutInfo * | gf_layoutInfo_newp (uint64_t level, uint64_t version, uint64_t width, uint64_t height) |
Create a new layout info object. More... | |
_GraphfabExport gf_layoutInfo * | gf_processLayout (gf_SBMLModel *lo) |
Process the layout info from a document. More... | |
_GraphfabExport void | gf_setModelNamespace (gf_layoutInfo *l, unsigned long level, unsigned long version) |
Set the level and version of the SBML. More... | |
_GraphfabExport const char * | gf_getDefaultCompartmentId () |
Get the id of the default SBML compartment. More... | |
_GraphfabExport void | gf_setDefaultCompartmentId (const char *id) |
Set the id of the default SBML compartment. More... | |
_GraphfabExport gf_network * | gf_getNetworkp (gf_layoutInfo *l) |
Get the network associated with the model. More... | |
_GraphfabExport void | gf_clearNetwork (gf_network *n) |
Clear the network - does not deallocate. More... | |
_GraphfabExport void | gf_releaseNetwork (gf_network *n) |
Release the network. More... | |
_GraphfabExport char * | gf_nw_getId (gf_network *n) |
Get the id of the network (i.e. the SBML model) More... | |
_GraphfabExport void | gf_nw_setId (gf_network *n, const char *id) |
Set the id of the network (via the SBML model) More... | |
_GraphfabExport uint64_t | gf_nw_getNumNodes (const gf_network *n) |
Get the number of nodes. More... | |
_GraphfabExport uint64_t | gf_nw_getNumUniqueNodes (const gf_network *n) |
Get the number of unique nodes. More... | |
_GraphfabExport uint64_t | gf_nw_getNumRxns (const gf_network *n) |
Get the number of reactions. More... | |
_GraphfabExport uint64_t | gf_nw_getNumComps (const gf_network *n) |
Get the number of compartments. More... | |
_GraphfabExport gf_node * | gf_nw_getNodep (gf_network *n, uint64_t i) |
Get the node at index i. More... | |
_GraphfabExport gf_node * | gf_nw_getUniqueNodep (gf_network *n, uint64_t i) |
Get the node at index i. More... | |
_GraphfabExport gf_node * | gf_nw_getNodepFromId (gf_network *nw, const char *id) |
Get the node with the given id. More... | |
_GraphfabExport gf_reaction * | gf_nw_getRxnp (gf_network *n, uint64_t i) |
Get the node at index i. More... | |
_GraphfabExport void | gf_nw_removeRxn (gf_network *n, gf_reaction *r) |
Remove the given reaction. More... | |
_GraphfabExport gf_compartment * | gf_nw_getCompartmentp (gf_network *n, uint64_t i) |
Get the compartment at index i. More... | |
_GraphfabExport gf_compartment * | gf_nw_findCompartmentById (gf_network *n, const char *id) |
Find a compartment by id. More... | |
_GraphfabExport void | gf_nw_rebuildCurves (gf_network *n) |
Rebuild all curves in the network. More... | |
_GraphfabExport void | gf_nw_recenterJunctions (gf_network *n) |
Recenter reaction junctions. More... | |
_GraphfabExport gf_compartment * | gf_nw_newCompartmentp (gf_network *nw, const char *id, const char *name) |
Add a new compartment to the network. More... | |
_GraphfabExport gf_node * | gf_nw_newNodep (gf_network *nw, const char *id, const char *name, gf_compartment *compartment) |
Add a new node to the network. More... | |
_GraphfabExport gf_node * | gf_nw_newAliasNodep (gf_network *nw, gf_node *source) |
Create and add an alias node from a given source node. More... | |
_GraphfabExport int | gf_nw_removeNode (gf_network *nw, gf_node *node) |
Remove a node from the network. More... | |
_GraphfabExport int | gf_nw_connectNode (gf_network *nw, gf_node *node, gf_reaction *reaction, gf_specRole role) |
Connect a node to a reaction. More... | |
_GraphfabExport int | gf_nw_connectNodeRoleStr (gf_network *nw, gf_node *n, gf_reaction *r, const char *role_str) |
Connect a node to a reaction. More... | |
_GraphfabExport int | gf_nw_isNodeConnected (gf_network *nw, gf_node *node, gf_reaction *reaction) |
Return whether the given node is connected to the given reaction. More... | |
_GraphfabExport int | gf_nw_isLayoutSpecified (gf_network *nw) |
Did the SBML model include layout? More... | |
_GraphfabExport int | gf_nw_getNumAliasInstances (gf_network *nw, gf_node *n) |
Get the number of instances of the node. More... | |
_GraphfabExport gf_node * | gf_nw_getAliasInstancep (gf_network *nw, gf_node *n, uint64_t i) |
Get the ith instance of an aliased node. More... | |
_GraphfabExport void | gf_node_setCompartment (gf_node *n, gf_compartment *c) |
Add a node to a compartment. More... | |
_GraphfabExport void | gf_releaseNode (const gf_node *n) |
Release the node. More... | |
_GraphfabExport int | gf_node_isLocked (gf_node *n) |
Is the node locked? More... | |
_GraphfabExport void | gf_node_lock (gf_node *n) |
Lock the node. More... | |
_GraphfabExport void | gf_node_unlock (gf_node *n) |
Unlock the node. More... | |
_GraphfabExport int | gf_node_make_alias (gf_node *n, gf_network *m) |
Create aliases of a given node. More... | |
_GraphfabExport int | gf_node_isAliased (gf_node *n) |
Is the node aliased? More... | |
_GraphfabExport gf_point | gf_node_getCentroid (gf_node *n) |
Get the centroid of the node. More... | |
_GraphfabExport void | gf_node_getCentroidXY (gf_node *n, double *x, double *y) |
Get the centroid of the node. More... | |
_GraphfabExport void | gf_node_setCentroid (gf_node *n, gf_point p) |
Set the centroid of the node. More... | |
_GraphfabExport double | gf_node_getWidth (gf_node *n) |
Get the width of the node. More... | |
_GraphfabExport void | gf_node_setWidth (gf_node *n, double width) |
Set the width of the node. More... | |
_GraphfabExport double | gf_node_getHeight (gf_node *n) |
Get the height of the node. More... | |
_GraphfabExport void | gf_node_setHeight (gf_node *n, double height) |
Set the height of the node. More... | |
_GraphfabExport char * | gf_node_getID (gf_node *n) |
Get the id, user frees memory. More... | |
_GraphfabExport void | gf_node_setID (gf_node *n, const char *id) |
Get the id, user frees memory. More... | |
_GraphfabExport const char * | gf_node_getName (gf_node *n) |
Get the name, client must free memory. More... | |
_GraphfabExport void | gf_node_setName (gf_node *n, const char *name) |
Set the name of a node. More... | |
_GraphfabExport int | gf_node_getConnectedReactions (gf_node *n, gf_network *m, unsigned int *num, gf_reaction **rxns) |
Get a list of all reactions connected to the node. More... | |
_GraphfabExport int | gf_node_getAttachedCurves (gf_node *n, gf_network *m, unsigned int *num, gf_curve **curves) |
Get a list of all curves connected to the node. More... | |
_GraphfabExport int | gf_nw_nodeHasCompartment (gf_network *nw, gf_node *x) |
Return true if the node has a compartment assigned. More... | |
_GraphfabExport gf_compartment * | gf_nw_nodeGetCompartment (gf_network *nw, gf_node *x) |
Get the compartment which contains node x. More... | |
_GraphfabExport void | gf_releaseRxn (const gf_reaction *r) |
Release the reaction. More... | |
_GraphfabExport gf_reaction * | gf_nw_newReactionp (gf_network *nw, const char *id, const char *name) |
Add a new reaction to the network. More... | |
_GraphfabExport char * | gf_reaction_getID (gf_reaction *r) |
Get the id, user frees memory. More... | |
_GraphfabExport gf_point | gf_reaction_getCentroid (gf_reaction *r) |
Get the centroid of the reaction. More... | |
_GraphfabExport void | gf_reaction_setCentroid (gf_reaction *r, gf_point p) |
Set the centroid of the reaction. More... | |
_GraphfabExport uint64_t | gf_reaction_getNumSpec (const gf_reaction *r) |
Get the number of species in the reaction. More... | |
_GraphfabExport int | gf_reaction_hasSpec (const gf_reaction *r, const gf_node *n) |
Return true if the reaction has the given species. More... | |
_GraphfabExport gf_specRole | gf_reaction_getSpecRole (const gf_reaction *r, uint64_t i) |
Get the role for spec i. More... | |
_GraphfabExport const char * | gf_roleToStr (gf_specRole role) |
Convert role to string. More... | |
_GraphfabExport gf_specRole | gf_strToRole (const char *str) |
Convert string to role. More... | |
_GraphfabExport uint64_t | gf_reaction_specGeti (const gf_reaction *r, uint64_t i) |
Get the global index of a reactant/product/participant given its local index in a reaction. More... | |
_GraphfabExport uint64_t | gf_reaction_getNumCurves (const gf_reaction *r) |
Get the number of curves in the reaction. More... | |
_GraphfabExport gf_curve * | gf_reaction_getCurvep (const gf_reaction *r, uint64_t i) |
Get the curve i. More... | |
_GraphfabExport void | gf_reaction_recenter (gf_reaction *r) |
Recenter reaction centroid. More... | |
_GraphfabExport void | gf_reaction_recalcCurveCPs (gf_reaction *r) |
Recalculate the curve CPs, don't recenter. More... | |
_GraphfabExport void | gf_releaseCurve (const gf_curve *c) |
Release the curve. More... | |
_GraphfabExport gf_specRole | gf_curve_getRole (gf_curve *c) |
Get the id, user frees memory. More... | |
_GraphfabExport gf_curveCP | gf_getCurveCPs (const gf_curve *c) |
Get the CPs for the curve. More... | |
_GraphfabExport int | gf_curve_hasArrowhead (const gf_curve *c) |
Returns true if the given curve should be drawn with an arrowhead. More... | |
_GraphfabExport int | gf_curve_getArrowheadVerts (const gf_curve *c, unsigned int *n, gf_point **v) |
Get the vertices for the curve's arrowhead. More... | |
_GraphfabExport void | gf_releaseCompartment (const gf_compartment *c) |
Release a compartment object. More... | |
_GraphfabExport char * | gf_compartment_getID (gf_compartment *c) |
Get the id, user frees memory. More... | |
_GraphfabExport gf_point | gf_compartment_getMinCorner (gf_compartment *c) |
Get the "upper left" corner. More... | |
_GraphfabExport void | gf_compartment_setMinCorner (gf_compartment *c, gf_point p) |
Set the "upper left" corner. More... | |
_GraphfabExport gf_point | gf_compartment_getMaxCorner (gf_compartment *c) |
Get the "lower right" corner. More... | |
_GraphfabExport void | gf_compartment_setMaxCorner (gf_compartment *c, gf_point p) |
Set the "lower right" corner. More... | |
_GraphfabExport double | gf_compartment_getWidth (gf_compartment *c) |
Get the width of the compartment. More... | |
_GraphfabExport double | gf_compartment_getHeight (gf_compartment *c) |
Get the height of the compartment. More... | |
_GraphfabExport uint64_t | gf_compartment_getNumElt (gf_compartment *c) |
Get the number of species in the compartment. More... | |
_GraphfabExport int | gf_compartment_addNode (gf_compartment *c, gf_node *n) |
Add a node to the compartment. More... | |
_GraphfabExport int | gf_compartment_removeNode (gf_compartment *c, gf_node *n) |
Remove a node from the compartment. More... | |
_GraphfabExport int | gf_compartment_containsNode (gf_compartment *c, gf_node *n) |
Return whether the compartment contains this node. More... | |
_GraphfabExport int | gf_compartment_containsReaction (gf_compartment *c, gf_reaction *r) |
Return whether the compartment contains this node. More... | |
_GraphfabExport void | gf_fit_to_window (gf_layoutInfo *l, double left, double top, double right, double bottom) |
Fit to the specified window. More... | |
_GraphfabExport gf_transform * | gf_tf_fitToWindow (gf_layoutInfo *l, double left, double top, double right, double bottom) |
Fit to the specified window (do not apply transform) More... | |
_GraphfabExport void | gf_moveNetworkToFirstQuad (gf_layoutInfo *l, double x_disp, double y_disp) |
Move the entire network to the first quadrant. More... | |
_GraphfabExport CPoint | gf_tf_apply_to_point (gf_transform *tf, CPoint p) |
Apply transform to point. More... | |
_GraphfabExport gf_point | gf_tf_getScale (gf_transform *tf) |
Get the scale of the transform. More... | |
_GraphfabExport gf_point | gf_tf_getDisplacement (gf_transform *tf) |
Get the displacement of the transform. More... | |
_GraphfabExport gf_point | gf_tf_getPostDisplacement (gf_transform *tf) |
Get the displacement component of the transform. More... | |
_GraphfabExport void | gf_release_transform (gf_transform *tf) |
Release transform. More... | |
_GraphfabExport gf_canvas * | gf_getCanvasp (gf_layoutInfo *l) |
Get the canvas associated with the model. More... | |
_GraphfabExport void | gf_clearCanvas (gf_canvas *c) |
Get the canvas associated with the model. More... | |
_GraphfabExport void | gf_releaseCanvas (gf_canvas *c) |
Release the canvas. More... | |
_GraphfabExport unsigned int | gf_canvGetWidth (gf_canvas *c) |
Get the width of the canvas. More... | |
_GraphfabExport unsigned int | gf_canvGetHeight (gf_canvas *c) |
Get the height of the canvas. More... | |
_GraphfabExport void | gf_canvSetWidth (gf_canvas *c, unsigned long width) |
Set the width of the canvas. More... | |
_GraphfabExport void | gf_canvSetHeight (gf_canvas *c, unsigned long height) |
Set the height of the canvas. More... | |
_GraphfabExport void | gf_aliasNodebyDegree (gf_layoutInfo *l, const int minDegree) |
Create node aliases by node degree. More... | |
_GraphfabExport void | gf_randomizeLayout (gf_layoutInfo *m) |
Randomize node positions. More... | |
_GraphfabExport void | gf_randomizeLayout2 (gf_network *n, gf_canvas *c) |
Randomize node positions for a given network & canvas. More... | |
_GraphfabExport void | gf_randomizeLayout_fromExtents (gf_network *n, double left, double top, double right, double bottom) |
Randomize node positions for a given network & extents. More... | |
_GraphfabExport int | gf_writeSBMLwithLayout (const char *filename, gf_SBMLModel *m, gf_layoutInfo *l) |
Write an SBML file, including layout. More... | |
_GraphfabExport int | gf_writeSBML (const char *filename, gf_SBMLModel *m) |
Write an SBML file (does not include layout. More... | |
_GraphfabExport const char * | gf_getSBMLwithLayoutStr (gf_SBMLModel *m, gf_layoutInfo *l) |
String version of writeSBMLwithLayout. More... | |
_GraphfabExport const char * | gf_getCurrentLibraryVersion (void) |
Returns the current version of the library. More... | |
_GraphfabExport void | gf_free (void *x) |
Frees the memory block at x. More... | |
_GraphfabExport gf_point | gf_computeCubicBezierPoint (gf_curveCP *c, Real t) |
Compute a point on the parametric curve. More... | |
_GraphfabExport gf_point * | gf_computeCubicBezierLineIntersec (gf_curveCP *c, gf_point *line_start, gf_point *line_end) |
Compute the intersection between a cubic Bezier and a line. More... | |
_GraphfabExport int | gf_arrowheadStyleGetNumVerts (int style) |
Get the number of vertices in the arrowhead polygon. More... | |
_GraphfabExport gf_point | gf_arrowheadStyleGetVert (int style, int n) |
Get the nth vertex of the arrow polygon. More... | |
_GraphfabExport int | gf_arrowheadStyleIsFilled (int style) |
Is the given style filled? More... | |
_GraphfabExport unsigned long | gf_arrowheadNumStyles () |
Get the number of arrowhead styles. More... | |
_GraphfabExport void | gf_arrowheadSetStyle (gf_specRole role, int style) |
Set the arrowhead style for a specific role type. More... | |
_GraphfabExport int | gf_arrowheadGetStyle (gf_specRole role) |
Get the style for the role type. More... | |
_GraphfabExport void | gf_doLayoutAlgorithm (fr_options opt, gf_layoutInfo *l) |
Run the autolayout (Fruchterman-Reingold) algorithm on a given layout structure. More... | |
_GraphfabExport void | gf_doLayoutAlgorithm2 (fr_options opt, gf_network *n, gf_canvas *c) |
Run the autolayout (Fruchterman-Reingold) algorithm on a a network and optional canvas. More... | |
_GraphfabExport void | gf_getLayoutOptDefaults (fr_options *opt) |
Generate default values for the layout options. More... | |
_GraphfabExport void | gf_layout_setStiffness (fr_options *opt, double k) |
Set the stiffness for the FR algorithm. More... | |
_GraphfabExport void | gf_freeSBMLModel (gf_SBMLModel *lo) |
Destructor for gf_SBMLModel. More... | |
_GraphfabExport gf_SBMLModel * | gf_loadSBMLbuf (const char *buf) |
Load SBML from memory buffer. Struct contains a pointer to the document. More... | |
_GraphfabExport gf_SBMLModel * | gf_loadSBMLfile (const char *file) |
Load SBML from memory buffer. Struct contains a pointer to the document. More... | |
_GraphfabExport void | gf_strfree (char *str) |
Free a C string (char*) More... | |
typedef struct __fr_options fr_options |
Options passed to the Fruchterman-Reingold algorithm.
This structure holds the settings used by the Fruchterman-Reingold algorithm.
enum gf_specRole |
Species role in a reaction.
Represents the SBML species role in a reaction. Species can be reactants, products, modifiers, etc.
_GraphfabExport void gf_aliasNodebyDegree | ( | gf_layoutInfo * | l, |
const int | minDegree | ||
) |
Create node aliases by node degree.
[in] | l | The layout info; contains the network that holds the list of nodes and reactions necessary for aliasing |
[in] | minDegree | The minimum node degree; Nodes that are of the minimum degree or higher will be aliased |
_GraphfabExport int gf_arrowheadGetStyle | ( | gf_specRole | role | ) |
Get the style for the role type.
[in] | role | Role type |
_GraphfabExport unsigned long gf_arrowheadNumStyles | ( | ) |
Get the number of arrowhead styles.
_GraphfabExport void gf_arrowheadSetStyle | ( | gf_specRole | role, |
int | style | ||
) |
Set the arrowhead style for a specific role type.
[in] | role | Role type |
[in] | style | Arrowhead style number |
_GraphfabExport int gf_arrowheadStyleGetNumVerts | ( | int | style | ) |
Get the number of vertices in the arrowhead polygon.
[in] | style | Arrowhead style number |
_GraphfabExport gf_point gf_arrowheadStyleGetVert | ( | int | style, |
int | n | ||
) |
Get the nth vertex of the arrow polygon.
[in] | style | Arrowhead style number |
[in] | n | The vertex index |
_GraphfabExport int gf_arrowheadStyleIsFilled | ( | int | style | ) |
Is the given style filled?
[in] | style | Arrowhead style number |
_GraphfabExport unsigned int gf_canvGetHeight | ( | gf_canvas * | c | ) |
Get the height of the canvas.
[in] | c | The canvas |
_GraphfabExport unsigned int gf_canvGetWidth | ( | gf_canvas * | c | ) |
Get the width of the canvas.
[in] | c | The canvas |
_GraphfabExport void gf_canvSetHeight | ( | gf_canvas * | c, |
unsigned long | height | ||
) |
Set the height of the canvas.
[in] | c | The canvas |
[in] | height | The height |
_GraphfabExport void gf_canvSetWidth | ( | gf_canvas * | c, |
unsigned long | width | ||
) |
Set the width of the canvas.
[in] | c | The canvas |
[out] | width | The width |
_GraphfabExport void gf_clearCanvas | ( | gf_canvas * | c | ) |
Get the canvas associated with the model.
[in] | l | The layout info |
_GraphfabExport void gf_clearNetwork | ( | gf_network * | n | ) |
Clear the network - does not deallocate.
[in] | n | The network object |
_GraphfabExport int gf_compartment_addNode | ( | gf_compartment * | c, |
gf_node * | n | ||
) |
Add a node to the compartment.
The node must already exist in the network
[in] | c | The compartment object |
[in] | n | The node to add |
_GraphfabExport int gf_compartment_containsNode | ( | gf_compartment * | c, |
gf_node * | n | ||
) |
Return whether the compartment contains this node.
[in] | c | The compartment object |
[in] | n | The node |
_GraphfabExport int gf_compartment_containsReaction | ( | gf_compartment * | c, |
gf_reaction * | r | ||
) |
Return whether the compartment contains this node.
[in] | c | The compartment object |
[in] | r | The reaction |
_GraphfabExport double gf_compartment_getHeight | ( | gf_compartment * | c | ) |
Get the height of the compartment.
[in] | c | The compartment object |
_GraphfabExport char* gf_compartment_getID | ( | gf_compartment * | c | ) |
Get the id, user frees memory.
[in] | c | The compartment object |
_GraphfabExport gf_point gf_compartment_getMaxCorner | ( | gf_compartment * | c | ) |
Get the "lower right" corner.
[in] | c | The compartment object |
_GraphfabExport gf_point gf_compartment_getMinCorner | ( | gf_compartment * | c | ) |
Get the "upper left" corner.
[in] | c | Compartment |
_GraphfabExport uint64_t gf_compartment_getNumElt | ( | gf_compartment * | c | ) |
Get the number of species in the compartment.
[in] | c | The compartment object |
_GraphfabExport double gf_compartment_getWidth | ( | gf_compartment * | c | ) |
Get the width of the compartment.
[in] | c | The compartment object |
_GraphfabExport int gf_compartment_removeNode | ( | gf_compartment * | c, |
gf_node * | n | ||
) |
Remove a node from the compartment.
[in] | c | The compartment object |
[in] | n | The node to remove |
_GraphfabExport void gf_compartment_setMaxCorner | ( | gf_compartment * | c, |
gf_point | p | ||
) |
Set the "lower right" corner.
[in] | c | The compartment object |
[in] | p | Corner |
_GraphfabExport void gf_compartment_setMinCorner | ( | gf_compartment * | c, |
gf_point | p | ||
) |
Set the "upper left" corner.
[in] | c | The compartment object |
[in] | p | Corner |
_GraphfabExport gf_point* gf_computeCubicBezierLineIntersec | ( | gf_curveCP * | c, |
gf_point * | line_start, | ||
gf_point * | line_end | ||
) |
Compute the intersection between a cubic Bezier and a line.
[in] | c | Cubic Bezier control points |
[in] | line_start | The start of the line |
[in] | line_end | The end of the line |
_GraphfabExport gf_point gf_computeCubicBezierPoint | ( | gf_curveCP * | c, |
Real | t | ||
) |
Compute a point on the parametric curve.
[in] | c | Cubic Bezier control points |
[in] | t | Cubic Bezier parameter |
_GraphfabExport int gf_curve_getArrowheadVerts | ( | const gf_curve * | c, |
unsigned int * | n, | ||
gf_point ** | v | ||
) |
Get the vertices for the curve's arrowhead.
[in] | c | The curve |
[out] | n | Number of arrowhead verts |
[out] | v | The vertices (new arrow, callee owns) |
_GraphfabExport gf_specRole gf_curve_getRole | ( | gf_curve * | c | ) |
Get the id, user frees memory.
[in] | c | The curve Get the role of the species with the given curve |
[in] | c | The curve |
_GraphfabExport int gf_curve_hasArrowhead | ( | const gf_curve * | c | ) |
Returns true if the given curve should be drawn with an arrowhead.
[in] | c | The curve |
_GraphfabExport void gf_doLayoutAlgorithm | ( | fr_options | opt, |
gf_layoutInfo * | l | ||
) |
Run the autolayout (Fruchterman-Reingold) algorithm on a given layout structure.
[in] | opt | The options controlling the layout algorithm |
in/out] | l The layout info |
_GraphfabExport void gf_doLayoutAlgorithm2 | ( | fr_options | opt, |
gf_network * | n, | ||
gf_canvas * | c | ||
) |
Run the autolayout (Fruchterman-Reingold) algorithm on a a network and optional canvas.
Can be used when full layout struct is not available
[in] | opt | The options controlling the layout algorithm |
in/out] | n The network | |
[in] | c | The canvas (may be NULL) |
_GraphfabExport void gf_fit_to_window | ( | gf_layoutInfo * | l, |
double | left, | ||
double | top, | ||
double | right, | ||
double | bottom | ||
) |
Fit to the specified window.
Given a network layout and a window, constructs a 2D affine transform to fit the network within the window. The 2D affine transform is applied directly to the network.
[in] | l | The layout info object |
[in] | left | Left edge of screen (other args similar) |
_GraphfabExport void gf_free | ( | void * | x | ) |
Frees the memory block at x.
_GraphfabExport void gf_freeLayoutInfo | ( | gf_layoutInfo * | l | ) |
Call to clean up an instance of gf_layoutInfo when it is no longer needed.
[in] | l | The layout info; Entire layout is freed |
_GraphfabExport void gf_freeLayoutInfoHierarch | ( | gf_layoutInfo * | l | ) |
Call to clean up an instance of gf_layoutInfo and all contained data structures.
[in] | l | The layout info; Entire layout is freed |
_GraphfabExport void gf_freeModelAndLayout | ( | gf_SBMLModel * | mod, |
gf_layoutInfo * | l | ||
) |
Call to clean up an instance of gf_layoutInfo and gf_SBMLModel when they are no longer needed.
The network object (which can be obtained via gf_getNetworkp is freed as well.
[in] | mod | The SBML model |
[in] | l | The layout info; Entire layout is freed |
_GraphfabExport void gf_freeSBMLModel | ( | gf_SBMLModel * | lo | ) |
Destructor for gf_SBMLModel.
[in] | lo | The SBML model; all memory used by the model is freed |
_GraphfabExport gf_canvas* gf_getCanvasp | ( | gf_layoutInfo * | l | ) |
Get the canvas associated with the model.
[in] | l | The layout info |
_GraphfabExport const char* gf_getCurrentLibraryVersion | ( | void | ) |
Returns the current version of the library.
_GraphfabExport gf_curveCP gf_getCurveCPs | ( | const gf_curve * | c | ) |
Get the CPs for the curve.
[in] | c | The curve |
_GraphfabExport const char* gf_getDefaultCompartmentId | ( | ) |
Get the id of the default SBML compartment.
_GraphfabExport char* gf_getLastError | ( | ) |
Gets the last error.
_GraphfabExport void gf_getLayoutOptDefaults | ( | fr_options * | opt | ) |
Generate default values for the layout options.
[out] | l | The layout info in which to store the options |
_GraphfabExport gf_network* gf_getNetworkp | ( | gf_layoutInfo * | l | ) |
Get the network associated with the model.
[in] | l | The layout info; contains the network |
_GraphfabExport const char* gf_getSBMLwithLayoutStr | ( | gf_SBMLModel * | m, |
gf_layoutInfo * | l | ||
) |
String version of writeSBMLwithLayout.
[in] | m | The SBML model; required since this tool only handles layout |
[in] | l | The layout info; the SBML in string form is written to the layout |
_GraphfabExport int gf_haveError | ( | ) |
Gets whether an error occurred.
_GraphfabExport void gf_layout_setStiffness | ( | fr_options * | opt, |
double | k | ||
) |
Set the stiffness for the FR algorithm.
[out] | opt | The layout info in which to store the stiffness |
[in] | k | The stiffness |
_GraphfabExport gf_layoutInfo* gf_layoutInfo_newp | ( | uint64_t | level, |
uint64_t | version, | ||
uint64_t | width, | ||
uint64_t | height | ||
) |
Create a new layout info object.
_GraphfabExport gf_SBMLModel* gf_loadSBMLbuf | ( | const char * | buf | ) |
Load SBML from memory buffer. Struct contains a pointer to the document.
[in] | buf | The buffer containing the SBML file |
[out] | r | The SBML model; the model that contains the SBML info from the buffer |
_GraphfabExport gf_SBMLModel* gf_loadSBMLfile | ( | const char * | file | ) |
Load SBML from memory buffer. Struct contains a pointer to the document.
[in] | buf | The buffer containing the SBML file |
[out] | r | The SBML model; the model that contains the SBML info from the buffer |
_GraphfabExport void gf_moveNetworkToFirstQuad | ( | gf_layoutInfo * | l, |
double | x_disp, | ||
double | y_disp | ||
) |
Move the entire network to the first quadrant.
Uses the network's bounding box to move all coordinates to the first quadrant. x_disp and y_disp are an additional offset to apply to the bounding box's minimum corner. If they are zero, the corner will be at the origin.
[in] | l | The layout info object |
[in] | x_disp | X displacement to post-apply to the bounding box |
[in] | y_disp | Y displacement to post-apply to the bounding box |
_GraphfabExport int gf_node_getAttachedCurves | ( | gf_node * | n, |
gf_network * | m, | ||
unsigned int * | num, | ||
gf_curve ** | curves | ||
) |
Get a list of all curves connected to the node.
[in] | n | The node object |
[out] | num | The number of curves |
[out] | rxns | The curve array (callee must free with gf_free) |
Get the centroid of the node.
[in] | n | The node object |
_GraphfabExport void gf_node_getCentroidXY | ( | gf_node * | n, |
double * | x, | ||
double * | y | ||
) |
Get the centroid of the node.
[in] | n | The node object |
[out] | x | X coord of centroid |
[out] | y | Y coord of centroid |
_GraphfabExport int gf_node_getConnectedReactions | ( | gf_node * | n, |
gf_network * | m, | ||
unsigned int * | num, | ||
gf_reaction ** | rxns | ||
) |
Get a list of all reactions connected to the node.
[in] | n | The node object |
[out] | num | The number of reactions |
[out] | rxns | The reaction array (callee must free with gf_free) |
_GraphfabExport double gf_node_getHeight | ( | gf_node * | n | ) |
Get the height of the node.
[in] | n | The node object |
_GraphfabExport char* gf_node_getID | ( | gf_node * | n | ) |
Get the id, user frees memory.
[in] | n | The node object |
_GraphfabExport const char* gf_node_getName | ( | gf_node * | n | ) |
Get the name, client must free memory.
[in] | n | The node object |
_GraphfabExport double gf_node_getWidth | ( | gf_node * | n | ) |
Get the width of the node.
[in] | n | The node object |
_GraphfabExport int gf_node_isAliased | ( | gf_node * | n | ) |
Is the node aliased?
[in] | n | The node object |
_GraphfabExport int gf_node_isLocked | ( | gf_node * | n | ) |
Is the node locked?
[in] | n | The node object |
_GraphfabExport void gf_node_lock | ( | gf_node * | n | ) |
Lock the node.
[in] | n | The node object |
_GraphfabExport int gf_node_make_alias | ( | gf_node * | n, |
gf_network * | m | ||
) |
Create aliases of a given node.
Creates alais nodes of a given node. One alias will be created for each reaction the node participates in. The aliases will appear as separate nodes in the network. The function gf_node_isAliased may be called to determine whether a given node is an alias or not.
[in,out] | n | The node to alias. Do not continue to use this pointer after the call - it will be invalid |
[in,out] | m | The network containing n. The nodes and reactions in this network may be modified by the call. The pointer m will remain valid. |
Set the centroid of the node.
[in] | n | The node object |
_GraphfabExport void gf_node_setCompartment | ( | gf_node * | n, |
gf_compartment * | c | ||
) |
Add a node to a compartment.
[in] | c | Compartment |
[in] | n | The node object |
_GraphfabExport void gf_node_setHeight | ( | gf_node * | n, |
double | height | ||
) |
Set the height of the node.
[in] | n | The node object |
_GraphfabExport void gf_node_setID | ( | gf_node * | n, |
const char * | id | ||
) |
Get the id, user frees memory.
[in] | n | The node object |
_GraphfabExport void gf_node_setName | ( | gf_node * | n, |
const char * | name | ||
) |
Set the name of a node.
[in] | n | The node object |
_GraphfabExport void gf_node_setWidth | ( | gf_node * | n, |
double | width | ||
) |
Set the width of the node.
[in] | n | The node object |
_GraphfabExport void gf_node_unlock | ( | gf_node * | n | ) |
Unlock the node.
[in] | n | The node object |
_GraphfabExport int gf_nw_connectNode | ( | gf_network * | nw, |
gf_node * | node, | ||
gf_reaction * | reaction, | ||
gf_specRole | role | ||
) |
Connect a node to a reaction.
[in] | nw | The network object |
[in] | node | The node to connect |
[in] | reaction | The reaction to connect to |
[in] | role | The species role to use |
_GraphfabExport int gf_nw_connectNodeRoleStr | ( | gf_network * | nw, |
gf_node * | n, | ||
gf_reaction * | r, | ||
const char * | role_str | ||
) |
Connect a node to a reaction.
[in] | nw | The network object |
[in] | node | The node to connect |
[in] | reaction | The reaction to connect to |
[in] | role | The species role to use (must be one of SUBSTRATE,PRODUCT,MODIFIER,ACTIVATOR,INHIBITOR) |
_GraphfabExport gf_compartment* gf_nw_findCompartmentById | ( | gf_network * | n, |
const char * | id | ||
) |
Find a compartment by id.
Returns NULL if no such compartment exists
[in] | n | The network object |
[in] | id | The compartment ID |
_GraphfabExport gf_node* gf_nw_getAliasInstancep | ( | gf_network * | nw, |
gf_node * | n, | ||
uint64_t | i | ||
) |
Get the ith instance of an aliased node.
[in] | n | The node object |
[in] | i | The instance index |
_GraphfabExport gf_compartment* gf_nw_getCompartmentp | ( | gf_network * | n, |
uint64_t | i | ||
) |
Get the compartment at index i.
[in] | n | The network object |
[in] | i | Node index |
_GraphfabExport char* gf_nw_getId | ( | gf_network * | n | ) |
Get the id of the network (i.e. the SBML model)
The id of the network is determined by the SBML model object
[in] | n | The network object |
_GraphfabExport gf_node* gf_nw_getNodep | ( | gf_network * | n, |
uint64_t | i | ||
) |
Get the node at index i.
[in] | n | The network object |
[in] | i | Node index |
_GraphfabExport gf_node* gf_nw_getNodepFromId | ( | gf_network * | nw, |
const char * | id | ||
) |
Get the node with the given id.
[in] | nw | The network object |
[in] | id | The node id |
_GraphfabExport int gf_nw_getNumAliasInstances | ( | gf_network * | nw, |
gf_node * | n | ||
) |
Get the number of instances of the node.
[in] | nw | The network object |
[in] | n | The node object |
_GraphfabExport uint64_t gf_nw_getNumComps | ( | const gf_network * | n | ) |
Get the number of compartments.
[in] | n | The network object |
_GraphfabExport uint64_t gf_nw_getNumNodes | ( | const gf_network * | n | ) |
Get the number of nodes.
[in] | n | The network object |
_GraphfabExport uint64_t gf_nw_getNumRxns | ( | const gf_network * | n | ) |
Get the number of reactions.
[in] | n | The network object |
_GraphfabExport uint64_t gf_nw_getNumUniqueNodes | ( | const gf_network * | n | ) |
Get the number of unique nodes.
This method only counts the unique nodes in a network, i.e. if a node is aliased, all instances count as a single node.
[in] | n | The network object |
_GraphfabExport gf_reaction* gf_nw_getRxnp | ( | gf_network * | n, |
uint64_t | i | ||
) |
Get the node at index i.
[in] | n | The network object |
[in] | i | Node index |
_GraphfabExport gf_node* gf_nw_getUniqueNodep | ( | gf_network * | n, |
uint64_t | i | ||
) |
Get the node at index i.
[in] | n | The network object |
[in] | i | Node index |
_GraphfabExport int gf_nw_isLayoutSpecified | ( | gf_network * | nw | ) |
Did the SBML model include layout?
[in] | n | The network object |
_GraphfabExport int gf_nw_isNodeConnected | ( | gf_network * | nw, |
gf_node * | node, | ||
gf_reaction * | reaction | ||
) |
Return whether the given node is connected to the given reaction.
[in] | nw | The network object |
[in] | node | The node to connect |
[in] | reaction | The reaction to connect to |
_GraphfabExport gf_node* gf_nw_newAliasNodep | ( | gf_network * | nw, |
gf_node * | source | ||
) |
Create and add an alias node from a given source node.
[in] | nw | The network object |
[in] | id | The node's requested ID (or null to determine it automatically) |
[in] | name | The node's name |
[in] | source | The original source node |
_GraphfabExport gf_compartment* gf_nw_newCompartmentp | ( | gf_network * | nw, |
const char * | id, | ||
const char * | name | ||
) |
Add a new compartment to the network.
[in] | nw | The network object |
[in] | id | The compartment's requested ID (or null to determine it automatically) |
[in] | name | The compartment's name |
_GraphfabExport gf_node* gf_nw_newNodep | ( | gf_network * | nw, |
const char * | id, | ||
const char * | name, | ||
gf_compartment * | compartment | ||
) |
Add a new node to the network.
[in] | nw | The network object |
[in] | id | The node's requested ID (or null to determine it automatically) |
[in] | name | The node's name |
[in] | compartment | The compartment to place the node in (may be NULL for no compartment or NULL for the "default" compartment in SBML parlance) |
_GraphfabExport gf_reaction* gf_nw_newReactionp | ( | gf_network * | nw, |
const char * | id, | ||
const char * | name | ||
) |
Add a new reaction to the network.
[in] | nw | The network object |
[in] | id | The reaction's requested ID (or null to determine it automatically) |
[in] | name | The reaction's name |
_GraphfabExport gf_compartment* gf_nw_nodeGetCompartment | ( | gf_network * | nw, |
gf_node * | x | ||
) |
Get the compartment which contains node x.
[in] | nw | The network object |
[in] | x | A node object |
_GraphfabExport int gf_nw_nodeHasCompartment | ( | gf_network * | nw, |
gf_node * | x | ||
) |
Return true if the node has a compartment assigned.
[in] | nw | The network object |
[in] | x | A node object |
_GraphfabExport void gf_nw_rebuildCurves | ( | gf_network * | n | ) |
Rebuild all curves in the network.
Rebuild all curves in each reaction, connecting substrates, products, modifiers, etc. Automatically calculate control points.
in/out] | n The network object |
_GraphfabExport void gf_nw_recenterJunctions | ( | gf_network * | n | ) |
Recenter reaction junctions.
[in] | n | The network object |
_GraphfabExport int gf_nw_removeNode | ( | gf_network * | nw, |
gf_node * | node | ||
) |
Remove a node from the network.
[in] | n | The network object |
_GraphfabExport void gf_nw_removeRxn | ( | gf_network * | n, |
gf_reaction * | r | ||
) |
Remove the given reaction.
[in] | n | The network object |
[in] | i | Node index |
_GraphfabExport void gf_nw_setId | ( | gf_network * | n, |
const char * | id | ||
) |
Set the id of the network (via the SBML model)
This will be used as the ID of the model object in the serialized SBML
[in,out] | n | The network object |
[in] | id | The id to use |
_GraphfabExport gf_layoutInfo* gf_processLayout | ( | gf_SBMLModel * | lo | ) |
Process the layout info from a document.
The layout info holds the network (nodes, reactions, etc.), canvas, and SBML content. gf_processLayout should be called after loading a network (via e.g. gf_loadSBMLfile). If the SBML model has layout information, the returned gf_layoutInfo will preserve this information. Otherwise, it will generate it automatically using the Fruchterman-Reingold algorithm.
gf_processLayout should be called only once for a loaded model (subsequent calls will have no effect). To manually re-run the Fruchterman-Reingold algorithm, call gf_doLayoutAlgorithm.
[in] | lo | The SBML model; the layout info is generated from the SBML model |
[out] | l | The layout info; pointer to the layout info generated from SBML model is returned |
_GraphfabExport void gf_randomizeLayout | ( | gf_layoutInfo * | m | ) |
Randomize node positions.
[in] | m | The layout info; contains the network of nodes and reactions, the coordinates of which will be randomized |
_GraphfabExport void gf_randomizeLayout2 | ( | gf_network * | n, |
gf_canvas * | c | ||
) |
Randomize node positions for a given network & canvas.
[in] | n | Network |
[in] | c | Canvas |
_GraphfabExport void gf_randomizeLayout_fromExtents | ( | gf_network * | n, |
double | left, | ||
double | top, | ||
double | right, | ||
double | bottom | ||
) |
Randomize node positions for a given network & extents.
[in] | n | Network |
[in] | left | The minimum X coord of the bounding box |
[in] | top | The minimum Y coord of the bounding box |
[in] | right | The maximum X coord of the bounding box |
[in] | bottom | The maximum Y coord of the bounding box |
_GraphfabExport gf_point gf_reaction_getCentroid | ( | gf_reaction * | r | ) |
Get the centroid of the reaction.
[in] | r | The reaction object |
_GraphfabExport gf_curve* gf_reaction_getCurvep | ( | const gf_reaction * | r, |
uint64_t | i | ||
) |
Get the curve i.
[in] | r | The reaction object |
_GraphfabExport char* gf_reaction_getID | ( | gf_reaction * | r | ) |
Get the id, user frees memory.
[in] | r | The reaction object |
_GraphfabExport uint64_t gf_reaction_getNumCurves | ( | const gf_reaction * | r | ) |
Get the number of curves in the reaction.
[in] | r | The reaction object |
_GraphfabExport uint64_t gf_reaction_getNumSpec | ( | const gf_reaction * | r | ) |
Get the number of species in the reaction.
[in] | r | The reaction object |
_GraphfabExport gf_specRole gf_reaction_getSpecRole | ( | const gf_reaction * | r, |
uint64_t | i | ||
) |
Get the role for spec i.
[in] | r | The reaction object |
_GraphfabExport int gf_reaction_hasSpec | ( | const gf_reaction * | r, |
const gf_node * | n | ||
) |
Return true if the reaction has the given species.
[in] | r | The reaction object |
_GraphfabExport void gf_reaction_recalcCurveCPs | ( | gf_reaction * | r | ) |
Recalculate the curve CPs, don't recenter.
[in] | n | The reaction object |
_GraphfabExport void gf_reaction_recenter | ( | gf_reaction * | r | ) |
Recenter reaction centroid.
[in] | n | The reaction object |
_GraphfabExport void gf_reaction_setCentroid | ( | gf_reaction * | r, |
gf_point | p | ||
) |
Set the centroid of the reaction.
[in] | r | The reaction object |
_GraphfabExport uint64_t gf_reaction_specGeti | ( | const gf_reaction * | r, |
uint64_t | i | ||
) |
Get the global index of a reactant/product/participant given its local index in a reaction.
[in] | r | The reaction object |
_GraphfabExport void gf_release_transform | ( | gf_transform * | tf | ) |
Release transform.
[in] | tf | Transform |
_GraphfabExport void gf_releaseCanvas | ( | gf_canvas * | c | ) |
Release the canvas.
[in] | c | The canvas |
_GraphfabExport void gf_releaseCompartment | ( | const gf_compartment * | c | ) |
Release a compartment object.
[in] | c | The compartment object |
_GraphfabExport void gf_releaseCurve | ( | const gf_curve * | c | ) |
Release the curve.
[in] | c | The curve |
_GraphfabExport void gf_releaseNetwork | ( | gf_network * | n | ) |
Release the network.
[in] | n | The network object |
_GraphfabExport void gf_releaseNode | ( | const gf_node * | n | ) |
Release the node.
[in] | n | The node object |
_GraphfabExport void gf_releaseRxn | ( | const gf_reaction * | r | ) |
Release the reaction.
[in] | r | The reaction object |
_GraphfabExport const char* gf_renderTikZ | ( | gf_layoutInfo * | l | ) |
Render the model as a TikZ image.
[in] | l | The model/layout infor |
_GraphfabExport int gf_renderTikZFile | ( | gf_layoutInfo * | l, |
const char * | filename | ||
) |
Render the model as a TikZ image.
[in] | l | The model/layout infor |
_GraphfabExport const char* gf_roleToStr | ( | gf_specRole | role | ) |
Convert role to string.
[in] | role | Role |
_GraphfabExport gf_SBMLModel* gf_SBMLModel_newp | ( | ) |
Create a new SBML model.
_GraphfabExport void gf_setDefaultCompartmentId | ( | const char * | id | ) |
Set the id of the default SBML compartment.
[in] | id | The id of the default compartment |
_GraphfabExport void gf_setModelNamespace | ( | gf_layoutInfo * | l, |
unsigned long | level, | ||
unsigned long | version | ||
) |
Set the level and version of the SBML.
[out] | l | The SBML model with layout info |
[in] | level | The SBML level |
[in] | version | The SBML version |
_GraphfabExport void gf_strfree | ( | char * | str | ) |
Free a C string (char*)
[in] | str | The string to free |
_GraphfabExport gf_specRole gf_strToRole | ( | const char * | str | ) |
_GraphfabExport CPoint gf_tf_apply_to_point | ( | gf_transform * | tf, |
CPoint | p | ||
) |
Apply transform to point.
[in] | tf | Transform |
[in] | p | Point |
_GraphfabExport gf_transform* gf_tf_fitToWindow | ( | gf_layoutInfo * | l, |
double | left, | ||
double | top, | ||
double | right, | ||
double | bottom | ||
) |
Fit to the specified window (do not apply transform)
Given a network layout and a window, constructs a 2D affine transform to fit the network within the window. The 2D affine transform is returned from this function (to be used by e.g. client-side rendering code) and the layout coordinates of the network are unaffected.
[in] | l | The layout info object |
[in] | left | Left edge of screen (other args similar) |
_GraphfabExport gf_point gf_tf_getDisplacement | ( | gf_transform * | tf | ) |
Get the displacement of the transform.
Gets just the displacement component of a 2D affine transform, ignoring the rotation and scaling.
[in] | tf | Transform |
_GraphfabExport gf_point gf_tf_getPostDisplacement | ( | gf_transform * | tf | ) |
Get the displacement component of the transform.
Like gf_tf_getDisplacement, but applies the inverse of the linear portion of the original transform to the output.
[in] | tf | Transform |
_GraphfabExport gf_point gf_tf_getScale | ( | gf_transform * | tf | ) |
Get the scale of the transform.
[in] | tf | Transform |
_GraphfabExport int gf_writeSBML | ( | const char * | filename, |
gf_SBMLModel * | m | ||
) |
Write an SBML file (does not include layout.
[in] | filename | The output file |
[in] | m | The SBML model; required since this tool only handles layout |
_GraphfabExport int gf_writeSBMLwithLayout | ( | const char * | filename, |
gf_SBMLModel * | m, | ||
gf_layoutInfo * | l | ||
) |
Write an SBML file, including layout.
[in] | filename | The output file |
[in] | m | The SBML model; required since this tool only handles layout |
[in] | l | The layout info; replaces any currently existing SBML layout in the model in the generated file |