Detailed Description

render A group of graphical primitives creating a composite.

The RenderGroup_t concept from the SBML Level 3 Render package is used to to create composite representations from simple primitives. The RenderGroup_t class is derived from GraphicalPrimitive2D_t and inherits all its methods and attributes. In addition to those, the class defines attributes to specify text render properties, curve decorations, an id, and a list of child elements which can be any graphical primitive or other group.

The attributes of a group are inherited by all children of the group unless they specify the attribute themselves.

See also: Text_t; RenderCurve_t

Public Member Functions
int	RenderGroup_addElement (RenderGroup_t rg, const Transformation2D_t td)
	Adds a copy of the given Transformation2D_t to this RenderGroup_t. More...

RenderGroup_t *	RenderGroup_clone (const RenderGroup_t *rg)
	Creates and returns a deep copy of this RenderGroup_t object. More...

RenderGroup_t *	RenderGroup_create (unsigned int level, unsigned int version, unsigned int pkgVersion)
	Creates a new RenderGroup_t using the given SBML Level, Version and “render” package version. More...

RenderCurve_t *	RenderGroup_createCurve (RenderGroup_t *rg)
	Creates a new RenderCurve_t object, adds it to this RenderGroup_t object and returns the RenderCurve_t object created. More...

Ellipse_t *	RenderGroup_createEllipse (RenderGroup_t *rg)
	Creates a new Ellipse_t object, adds it to this RenderGroup_t object and returns the Ellipse_t object created. More...

RelAbsVector_t *	RenderGroup_createFontSize (RenderGroup_t *rg)
	Creates a new RelAbsVector_t object, adds it to this RenderGroup_t object and returns the RelAbsVector_t object created. More...

RenderGroup_t *	RenderGroup_createGroup (RenderGroup_t *rg)
	Creates a new RenderGroup_t object, adds it to this RenderGroup_t object and returns the RenderGroup_t object created. More...

Image_t *	RenderGroup_createImage (RenderGroup_t *rg)
	Creates a new Image_t object, adds it to this RenderGroup_t object and returns the Image_t object created. More...

LineEnding_t *	RenderGroup_createLineEnding (RenderGroup_t *rg)
	Creates a new LineEnding_t object, adds it to this RenderGroup_t object and returns the LineEnding_t object created. More...

Polygon_t *	RenderGroup_createPolygon (RenderGroup_t *rg)
	Creates a new Polygon_t object, adds it to this RenderGroup_t object and returns the Polygon_t object created. More...

Rectangle_t *	RenderGroup_createRectangle (RenderGroup_t *rg)
	Creates a new Rectangle_t object, adds it to this RenderGroup_t object and returns the Rectangle_t object created. More...

Text_t *	RenderGroup_createText (RenderGroup_t *rg)
	Creates a new Text_t object, adds it to this RenderGroup_t object and returns the Text_t object created. More...

void	RenderGroup_free (RenderGroup_t *rg)
	Frees this RenderGroup_t object. More...

Transformation2D_t *	RenderGroup_getElement (RenderGroup_t *rg, unsigned int n)
	Get a Transformation2D_t from the RenderGroup_t. More...

char *	RenderGroup_getEndHead (const RenderGroup_t *rg)
	Returns the value of the "endHead" attribute of this RenderGroup_t. More...

char *	RenderGroup_getFontFamily (const RenderGroup_t *rg)
	Returns the value of the "font-family" attribute of this RenderGroup_t. More...

const RelAbsVector_t *	RenderGroup_getFontSize (const RenderGroup_t *rg)
	Returns the value of the "font-size" element of this RenderGroup_t. More...

FontStyle_t	RenderGroup_getFontStyle (const RenderGroup_t *rg)
	Returns the value of the "font-style" attribute of this RenderGroup_t. More...

char *	RenderGroup_getFontStyleAsString (const RenderGroup_t *rg)
	Returns the value of the "font-style" attribute of this RenderGroup_t. More...

FontWeight_t	RenderGroup_getFontWeight (const RenderGroup_t *rg)
	Returns the value of the "font-weight" attribute of this RenderGroup_t. More...

char *	RenderGroup_getFontWeightAsString (const RenderGroup_t *rg)
	Returns the value of the "font-weight" attribute of this RenderGroup_t. More...

ListOf_t *	RenderGroup_getListOfElements (RenderGroup_t *rg)
	Returns a ListOf_t * containing Transformation2D_t objects from this RenderGroup_t. More...

unsigned int	RenderGroup_getNumElements (RenderGroup_t *rg)
	Get the number of Transformation2D_t objects in this RenderGroup_t. More...

char *	RenderGroup_getStartHead (const RenderGroup_t *rg)
	Returns the value of the "startHead" attribute of this RenderGroup_t. More...

HTextAnchor_t	RenderGroup_getTextAnchor (const RenderGroup_t *rg)
	Returns the value of the "text-anchor" attribute of this RenderGroup_t. More...

char *	RenderGroup_getTextAnchorAsString (const RenderGroup_t *rg)
	Returns the value of the "text-anchor" attribute of this RenderGroup_t. More...

VTextAnchor_t	RenderGroup_getVTextAnchor (const RenderGroup_t *rg)
	Returns the value of the "vtext-anchor" attribute of this RenderGroup_t. More...

char *	RenderGroup_getVTextAnchorAsString (const RenderGroup_t *rg)
	Returns the value of the "vtext-anchor" attribute of this RenderGroup_t. More...

int	RenderGroup_hasRequiredAttributes (const RenderGroup_t *rg)
	Predicate returning `1` (true) if all the required attributes for this RenderGroup_t object have been set. More...

int	RenderGroup_hasRequiredElements (const RenderGroup_t *rg)
	Predicate returning `1` (true) if all the required elements for this RenderGroup_t object have been set. More...

int	RenderGroup_isSetEndHead (const RenderGroup_t *rg)
	Predicate returning `1` (true) if this RenderGroup_t's "endHead" attribute is set. More...

int	RenderGroup_isSetFontFamily (const RenderGroup_t *rg)
	Predicate returning `1` (true) if this RenderGroup_t's "font-family" attribute is set. More...

int	RenderGroup_isSetFontSize (const RenderGroup_t *rg)
	Predicate returning `1` (true) if this RenderGroup_t's "font-size" element is set. More...

int	RenderGroup_isSetFontStyle (const RenderGroup_t *rg)
	Predicate returning `1` (true) if this RenderGroup_t's "font-style" attribute is set. More...

int	RenderGroup_isSetFontWeight (const RenderGroup_t *rg)
	Predicate returning `1` (true) if this RenderGroup_t's "font-weight" attribute is set. More...

int	RenderGroup_isSetStartHead (const RenderGroup_t *rg)
	Predicate returning `1` (true) if this RenderGroup_t's "startHead" attribute is set. More...

int	RenderGroup_isSetTextAnchor (const RenderGroup_t *rg)
	Predicate returning `1` (true) if this RenderGroup_t's "text-anchor" attribute is set. More...

int	RenderGroup_isSetVTextAnchor (const RenderGroup_t *rg)
	Predicate returning `1` (true) if this RenderGroup_t's "vtext-anchor" attribute is set. More...

Transformation2D_t *	RenderGroup_removeElement (RenderGroup_t *rg, unsigned int n)
	Removes the nth Transformation2D_t from this RenderGroup_t and returns a pointer to it. More...

int	RenderGroup_setEndHead (RenderGroup_t rg, const char endHead)
	Sets the value of the "endHead" attribute of this RenderGroup_t. More...

int	RenderGroup_setFontFamily (RenderGroup_t rg, const char fontFamily)
	Sets the value of the "font-family" attribute of this RenderGroup_t. More...

int	RenderGroup_setFontSize (RenderGroup_t rg, const RelAbsVector_t fontSize)
	Sets the value of the "font-size" element of this RenderGroup_t. More...

int	RenderGroup_setFontStyle (RenderGroup_t *rg, FontStyle_t fontStyle)
	Sets the value of the "font-style" attribute of this RenderGroup_t. More...

int	RenderGroup_setFontStyleAsString (RenderGroup_t rg, const char fontStyle)
	Sets the value of the "font-style" attribute of this RenderGroup_t. More...

int	RenderGroup_setFontWeight (RenderGroup_t *rg, FontWeight_t fontWeight)
	Sets the value of the "font-weight" attribute of this RenderGroup_t. More...

int	RenderGroup_setFontWeightAsString (RenderGroup_t rg, const char fontWeight)
	Sets the value of the "font-weight" attribute of this RenderGroup_t. More...

int	RenderGroup_setStartHead (RenderGroup_t rg, const char startHead)
	Sets the value of the "startHead" attribute of this RenderGroup_t. More...

int	RenderGroup_setTextAnchor (RenderGroup_t *rg, HTextAnchor_t textAnchor)
	Sets the value of the "text-anchor" attribute of this RenderGroup_t. More...

int	RenderGroup_setTextAnchorAsString (RenderGroup_t rg, const char textAnchor)
	Sets the value of the "text-anchor" attribute of this RenderGroup_t. More...

int	RenderGroup_setVTextAnchor (RenderGroup_t *rg, VTextAnchor_t vtextAnchor)
	Sets the value of the "vtext-anchor" attribute of this RenderGroup_t. More...

int	RenderGroup_setVTextAnchorAsString (RenderGroup_t rg, const char vtextAnchor)
	Sets the value of the "vtext-anchor" attribute of this RenderGroup_t. More...

int	RenderGroup_unsetEndHead (RenderGroup_t *rg)
	Unsets the value of the "endHead" attribute of this RenderGroup_t. More...

int	RenderGroup_unsetFontFamily (RenderGroup_t *rg)
	Unsets the value of the "font-family" attribute of this RenderGroup_t. More...

int	RenderGroup_unsetFontSize (RenderGroup_t *rg)
	Unsets the value of the "font-size" element of this RenderGroup_t. More...

int	RenderGroup_unsetFontStyle (RenderGroup_t *rg)
	Unsets the value of the "font-style" attribute of this RenderGroup_t. More...

int	RenderGroup_unsetFontWeight (RenderGroup_t *rg)
	Unsets the value of the "font-weight" attribute of this RenderGroup_t. More...

int	RenderGroup_unsetStartHead (RenderGroup_t *rg)
	Unsets the value of the "startHead" attribute of this RenderGroup_t. More...

int	RenderGroup_unsetTextAnchor (RenderGroup_t *rg)
	Unsets the value of the "text-anchor" attribute of this RenderGroup_t. More...

int	RenderGroup_unsetVTextAnchor (RenderGroup_t *rg)
	Unsets the value of the "vtext-anchor" attribute of this RenderGroup_t. More...

Member Function Documentation

int RenderGroup_addElement	(	RenderGroup_t *	rg,
		const Transformation2D_t *	td
	)

Adds a copy of the given Transformation2D_t to this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure to which the Transformation2D_t should be added.
td	the Transformation2D_t object to add.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

RenderGroup_t * RenderGroup_clone ( const RenderGroup_t * rg )

Creates and returns a deep copy of this RenderGroup_t object.

Parameters

rg	the RenderGroup_t structure.

Returns: a (deep) copy of this RenderGroup_t object.

Warning: The pointer that is returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the element will not be reflected in any resulting SBML document unless the element is added to an SBML Document. Even in this case, the element's deletion is still the responsibility of the caller with two exceptions: if it is used as the "disownedItem" in the ListOf_appendAndOwn() or ListOf_insertAndOwn() functions. All other functions in libsbml add a copy of the element, and do not transfer ownership of the pointer.

RenderGroup_t * RenderGroup_create	(	unsigned int	level,
		unsigned int	version,
		unsigned int	pkgVersion
	)

Creates a new RenderGroup_t using the given SBML Level, Version and “render” package version.

Parameters

level	an unsigned int, the SBML Level to assign to this RenderGroup_t.
version	an unsigned int, the SBML Version to assign to this RenderGroup_t.
pkgVersion	an unsigned int, the SBML Render Version to assign to this RenderGroup_t.

Note: Attempting to add an object to an SBMLDocument_t having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument_t), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute. For packages, this means that the parent object to which this package element is being added must have been created with the package namespace, or that the package namespace was added to it, even if that parent is not a package object itself.

Warning: The pointer that is returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the element will not be reflected in any resulting SBML document unless the element is added to an SBML Document. Even in this case, the element's deletion is still the responsibility of the caller with two exceptions: if it is used as the "disownedItem" in the ListOf_appendAndOwn() or ListOf_insertAndOwn() functions. All other functions in libsbml add a copy of the element, and do not transfer ownership of the pointer.

RenderCurve_t * RenderGroup_createCurve ( RenderGroup_t * rg )

Creates a new RenderCurve_t object, adds it to this RenderGroup_t object and returns the RenderCurve_t object created.

Parameters

rg	the RenderGroup_t structure to which the RenderCurve_t should be added.

Returns: a new RenderCurve_t object instance.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

Ellipse_t * RenderGroup_createEllipse ( RenderGroup_t * rg )

Creates a new Ellipse_t object, adds it to this RenderGroup_t object and returns the Ellipse_t object created.

Parameters

rg	the RenderGroup_t structure to which the Ellipse_t should be added.

Returns: a new Ellipse_t object instance.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

RelAbsVector_t * RenderGroup_createFontSize ( RenderGroup_t * rg )

Creates a new RelAbsVector_t object, adds it to this RenderGroup_t object and returns the RelAbsVector_t object created.

Parameters

rg	the RenderGroup_t structure to which the RelAbsVector_t should be added.

Returns: a new RelAbsVector_t object instance.

RenderGroup_t * RenderGroup_createGroup ( RenderGroup_t * rg )

Creates a new RenderGroup_t object, adds it to this RenderGroup_t object and returns the RenderGroup_t object created.

Parameters

rg	the RenderGroup_t structure to which the RenderGroup_t should be added.

Returns: a new RenderGroup_t object instance.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

Image_t * RenderGroup_createImage ( RenderGroup_t * rg )

Creates a new Image_t object, adds it to this RenderGroup_t object and returns the Image_t object created.

Parameters

rg	the RenderGroup_t structure to which the Image_t should be added.

Returns: a new Image_t object instance.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

LineEnding_t * RenderGroup_createLineEnding ( RenderGroup_t * rg )

Creates a new LineEnding_t object, adds it to this RenderGroup_t object and returns the LineEnding_t object created.

Parameters

rg	the RenderGroup_t structure to which the LineEnding_t should be added.

Returns: a new LineEnding_t object instance.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

Polygon_t * RenderGroup_createPolygon ( RenderGroup_t * rg )

Creates a new Polygon_t object, adds it to this RenderGroup_t object and returns the Polygon_t object created.

Parameters

rg	the RenderGroup_t structure to which the Polygon_t should be added.

Returns: a new Polygon_t object instance.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

Rectangle_t * RenderGroup_createRectangle ( RenderGroup_t * rg )

Creates a new Rectangle_t object, adds it to this RenderGroup_t object and returns the Rectangle_t object created.

Parameters

rg	the RenderGroup_t structure to which the Rectangle_t should be added.

Returns: a new Rectangle_t object instance.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

Text_t * RenderGroup_createText ( RenderGroup_t * rg )

Creates a new Text_t object, adds it to this RenderGroup_t object and returns the Text_t object created.

Parameters

rg	the RenderGroup_t structure to which the Text_t should be added.

Returns: a new Text_t object instance.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

void RenderGroup_free ( RenderGroup_t * rg )

Frees this RenderGroup_t object.

Parameters

rg	the RenderGroup_t structure.

Transformation2D_t * RenderGroup_getElement	(	RenderGroup_t *	rg,
		unsigned int	n
	)

Get a Transformation2D_t from the RenderGroup_t.

Parameters

rg	the RenderGroup_t structure to search.
n	an unsigned int representing the index of the Transformation2D_t to retrieve.

Returns: the nth Transformation2D_t in the ListOfDrawables_t within this RenderGroup_t. If the index n is invalid, NULL is returned.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

char * RenderGroup_getEndHead ( const RenderGroup_t * rg )

Returns the value of the "endHead" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure whose endHead is sought.

Returns: the value of the "endHead" attribute of this RenderGroup_t as a pointer to a string.

Warning: The string returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the string will not be reflected in any resulting SBML document unless the string is added to an SBML Document. Even in this case, the string should be deleted, as adding a string to an SBML Document adds a copy of the string, and does not transfer ownership of that string.

char * RenderGroup_getFontFamily ( const RenderGroup_t * rg )

Returns the value of the "font-family" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure whose font-family is sought.

Returns: the value of the "font-family" attribute of this RenderGroup_t as a pointer to a string.

Warning: The string returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the string will not be reflected in any resulting SBML document unless the string is added to an SBML Document. Even in this case, the string should be deleted, as adding a string to an SBML Document adds a copy of the string, and does not transfer ownership of that string.

const RelAbsVector_t * RenderGroup_getFontSize ( const RenderGroup_t * rg )

Returns the value of the "font-size" element of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure whose font-size is sought.

Returns: the value of the "font-size" element of this RenderGroup_t as a RelAbsVector_t.

FontStyle_t RenderGroup_getFontStyle ( const RenderGroup_t * rg )

Returns the value of the "font-style" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure whose font-style is sought.

Returns: the value of the "font-style" attribute of this RenderGroup_t as a FontStyle_t.

The attribute "font-style" is used to specify whether the text is to be "normal" or "italic". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-style":

"italic", slanted print
"normal", upright print

The value is drawn from the enumeration FontStyle_t. The possible values returned by this method are:

char * RenderGroup_getFontStyleAsString ( const RenderGroup_t * rg )

Returns the value of the "font-style" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure whose font-style is sought.

Returns: the value of the "font-style" attribute of this RenderGroup_t as a const char *.

Note: The string returned by this function is a pointer to a string literal defined in the libSBML library, and may not be modified or deleted.

The attribute "font-style" is used to specify whether the text is to be "normal" or "italic". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-style":

"italic", slanted print
"normal", upright print

The possible values returned by this method are:

"italic"
"normal"
"(Unknown FontStyle value)"

FontWeight_t RenderGroup_getFontWeight ( const RenderGroup_t * rg )

Returns the value of the "font-weight" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure whose font-weight is sought.

Returns: the value of the "font-weight" attribute of this RenderGroup_t as a FontWeight_t.

The attribute "font-weight" is used to specify whether the text is to be "normal" or "bold". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-weight":

"bold", darker and/or thicker than normal print.
"normal", the typical print weight; lighter and/or thinner than "bold".

The value is drawn from the enumeration FontWeight_t. The possible values returned by this method are:

char * RenderGroup_getFontWeightAsString ( const RenderGroup_t * rg )

Returns the value of the "font-weight" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure whose font-weight is sought.

Returns: the value of the "font-weight" attribute of this RenderGroup_t as a const char *.

Note: The string returned by this function is a pointer to a string literal defined in the libSBML library, and may not be modified or deleted.

The attribute "font-weight" is used to specify whether the text is to be "normal" or "bold". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-weight":

"bold", darker and/or thicker than normal print.
"normal", the typical print weight; lighter and/or thinner than "bold".

The possible values returned by this method are:

"bold"
"normal"
"Unknown FontWeight value"

ListOf_t * RenderGroup_getListOfElements ( RenderGroup_t * rg )

Returns a ListOf_t * containing Transformation2D_t objects from this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure whose ListOfDrawables_t is sought.

Returns: the ListOfDrawables_t from this RenderGroup_t as a ListOf_t *.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

See also: RenderGroup_addElement(); RenderGroup_createElement(); RenderGroup_getElementById(); RenderGroup_getElement(); RenderGroup_getNumElements(); RenderGroup_removeElementById(); RenderGroup_removeElement()

unsigned int RenderGroup_getNumElements ( RenderGroup_t * rg )

Get the number of Transformation2D_t objects in this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure to query.

Returns: the number of Transformation2D_t objects in this RenderGroup_t.

char * RenderGroup_getStartHead ( const RenderGroup_t * rg )

Returns the value of the "startHead" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure whose startHead is sought.

Returns: the value of the "startHead" attribute of this RenderGroup_t as a pointer to a string.

Warning: The string returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the string will not be reflected in any resulting SBML document unless the string is added to an SBML Document. Even in this case, the string should be deleted, as adding a string to an SBML Document adds a copy of the string, and does not transfer ownership of that string.

HTextAnchor_t RenderGroup_getTextAnchor ( const RenderGroup_t * rg )

Returns the value of the "text-anchor" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure whose text-anchor is sought.

Returns: the value of the "text-anchor" attribute of this RenderGroup_t as a HTextAnchor_t.

The attribute "text-anchor" is used to specify the horizontal alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "text-anchor":

"start", the start of the text is aligned to the horizontal center of the box.
"middle", the horizontal center of the text is aligned to the horizontal center of the box.
"end", the end of the text is aligned to the horizontal center of the box.

The value is drawn from the enumeration HTextAnchor_t. The possible values returned by this method are:

char * RenderGroup_getTextAnchorAsString ( const RenderGroup_t * rg )

Returns the value of the "text-anchor" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure whose text-anchor is sought.

Returns: the value of the "text-anchor" attribute of this RenderGroup_t as a const char *.

Note: The string returned by this function is a pointer to a string literal defined in the libSBML library, and may not be modified or deleted.

The attribute "text-anchor" is used to specify the horizontal alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "text-anchor":

"start", the start of the text is aligned to the horizontal center of the box.
"middle", the horizontal center of the text is aligned to the horizontal center of the box.
"end", the end of the text is aligned to the horizontal center of the box.

The possible values returned by this method are:

"start"
"middle"
"end"
"(Unknown HTextAnchor value)"

VTextAnchor_t RenderGroup_getVTextAnchor ( const RenderGroup_t * rg )

Returns the value of the "vtext-anchor" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure whose vtext-anchor is sought.

Returns: the value of the "vtext-anchor" attribute of this RenderGroup_t as a VTextAnchor_t.

The attribute "vtext-anchor" is used to specify the vertical alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "vtext-anchor":

"top", the top of the text is aligned to the vertical center of the box.
"middle", the vertical center of the text is aligned with the vertical center of the box.
"bottom", the bottom of the text (i.e. the very bottom of any descending letter like 'y' or 'p') is aligned with the vertical center of the box.
"baseline", the baseline of the text (i.e. the bottom of any non-descending letter like 'a' or e') is aligned with the vertical center of the box.

The value is drawn from the enumeration VTextAnchor_t. The possible values returned by this method are:

char * RenderGroup_getVTextAnchorAsString ( const RenderGroup_t * rg )

Returns the value of the "vtext-anchor" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure whose vtext-anchor is sought.

Returns: the value of the "vtext-anchor" attribute of this RenderGroup_t as a const char *.

Note: The string returned by this function is a pointer to a string literal defined in the libSBML library, and may not be modified or deleted.

The attribute "vtext-anchor" is used to specify the vertical alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "vtext-anchor":

"top", the top of the text is aligned to the vertical center of the box.
"middle", the vertical center of the text is aligned with the vertical center of the box.
"bottom", the bottom of the text (i.e. the very bottom of any descending letter like 'y' or 'p') is aligned with the vertical center of the box.
"baseline", the baseline of the text (i.e. the bottom of any non-descending letter like 'a' or e') is aligned with the vertical center of the box.

The possible values returned by this method are:

"top"
"middle"
"bottom"
"baseline"
"(Unknown VTextAnchor value)"

int RenderGroup_hasRequiredAttributes ( const RenderGroup_t * rg )

Predicate returning 1 (true) if all the required attributes for this RenderGroup_t object have been set.

Parameters

rg	the RenderGroup_t structure.

Returns: 1 (true) to indicate that all the required attributes of this RenderGroup_t have been set, otherwise 0 (false) is returned.

int RenderGroup_hasRequiredElements ( const RenderGroup_t * rg )

Predicate returning 1 (true) if all the required elements for this RenderGroup_t object have been set.

Parameters

rg	the RenderGroup_t structure.

Returns: 1 (true) to indicate that all the required elements of this RenderGroup_t have been set, otherwise 0 (false) is returned.

Note: The required elements for the RenderGroup_t object are:

int RenderGroup_isSetEndHead ( const RenderGroup_t * rg )

Predicate returning 1 (true) if this RenderGroup_t's "endHead" attribute is set.

Parameters

rg	the RenderGroup_t structure.

Returns: 1 (true) if this RenderGroup_t's "endHead" attribute has been set, otherwise 0 (false) is returned.

int RenderGroup_isSetFontFamily ( const RenderGroup_t * rg )

Predicate returning 1 (true) if this RenderGroup_t's "font-family" attribute is set.

Parameters

rg	the RenderGroup_t structure.

Returns: 1 (true) if this RenderGroup_t's "font-family" attribute has been set, otherwise 0 (false) is returned.

int RenderGroup_isSetFontSize ( const RenderGroup_t * rg )

Predicate returning 1 (true) if this RenderGroup_t's "font-size" element is set.

Parameters

rg	the RenderGroup_t structure.

Returns: 1 (true) if this RenderGroup_t's "font-size" element has been set, otherwise 0 (false) is returned.

int RenderGroup_isSetFontStyle ( const RenderGroup_t * rg )

Predicate returning 1 (true) if this RenderGroup_t's "font-style" attribute is set.

Parameters

rg	the RenderGroup_t structure.

Returns: 1 (true) if this RenderGroup_t's "font-style" attribute has been set, otherwise 0 (false) is returned.

The attribute "font-style" is used to specify whether the text is to be "normal" or "italic". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-style":

"italic", slanted print
"normal", upright print

int RenderGroup_isSetFontWeight ( const RenderGroup_t * rg )

Predicate returning 1 (true) if this RenderGroup_t's "font-weight" attribute is set.

Parameters

rg	the RenderGroup_t structure.

Returns: 1 (true) if this RenderGroup_t's "font-weight" attribute has been set, otherwise 0 (false) is returned.

The attribute "font-weight" is used to specify whether the text is to be "normal" or "bold". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-weight":

"bold", darker and/or thicker than normal print.
"normal", the typical print weight; lighter and/or thinner than "bold".

int RenderGroup_isSetStartHead ( const RenderGroup_t * rg )

Predicate returning 1 (true) if this RenderGroup_t's "startHead" attribute is set.

Parameters

rg	the RenderGroup_t structure.

Returns: 1 (true) if this RenderGroup_t's "startHead" attribute has been set, otherwise 0 (false) is returned.

int RenderGroup_isSetTextAnchor ( const RenderGroup_t * rg )

Predicate returning 1 (true) if this RenderGroup_t's "text-anchor" attribute is set.

Parameters

rg	the RenderGroup_t structure.

Returns: 1 (true) if this RenderGroup_t's "text-anchor" attribute has been set, otherwise 0 (false) is returned.

The attribute "text-anchor" is used to specify the horizontal alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "text-anchor":

"start", the start of the text is aligned to the horizontal center of the box.
"middle", the horizontal center of the text is aligned to the horizontal center of the box.
"end", the end of the text is aligned to the horizontal center of the box.

int RenderGroup_isSetVTextAnchor ( const RenderGroup_t * rg )

Predicate returning 1 (true) if this RenderGroup_t's "vtext-anchor" attribute is set.

Parameters

rg	the RenderGroup_t structure.

Returns: 1 (true) if this RenderGroup_t's "vtext-anchor" attribute has been set, otherwise 0 (false) is returned.

The attribute "vtext-anchor" is used to specify the vertical alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "vtext-anchor":

"top", the top of the text is aligned to the vertical center of the box.
"middle", the vertical center of the text is aligned with the vertical center of the box.
"bottom", the bottom of the text (i.e. the very bottom of any descending letter like 'y' or 'p') is aligned with the vertical center of the box.
"baseline", the baseline of the text (i.e. the bottom of any non-descending letter like 'a' or e') is aligned with the vertical center of the box.

Transformation2D_t * RenderGroup_removeElement	(	RenderGroup_t *	rg,
		unsigned int	n
	)

Removes the nth Transformation2D_t from this RenderGroup_t and returns a pointer to it.

Parameters

rg	the RenderGroup_t structure to search.
n	an unsigned int representing the index of the Transformation2D_t to remove.

Returns: a pointer to the nth Transformation2D_t in this RenderGroup_t.

Warning: The pointer that is returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the element will not be reflected in any resulting SBML document unless the element is added to an SBML Document. Even in this case, the element's deletion is still the responsibility of the caller with two exceptions: if it is used as the "disownedItem" in the ListOf_appendAndOwn() or ListOf_insertAndOwn() functions. All other functions in libsbml add a copy of the element, and do not transfer ownership of the pointer.

int RenderGroup_setEndHead	(	RenderGroup_t *	rg,
		const char *	endHead
	)

Sets the value of the "endHead" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure.
endHead	const char * value of the "endHead" attribute to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int RenderGroup_setFontFamily	(	RenderGroup_t *	rg,
		const char *	fontFamily
	)

Sets the value of the "font-family" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure.
fontFamily	const char * value of the "font-family" attribute to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

Calling this function with fontFamily = NULL or an empty string is equivalent to calling RenderGroup_unsetFontFamily().

int RenderGroup_setFontSize	(	RenderGroup_t *	rg,
		const RelAbsVector_t *	fontSize
	)

Sets the value of the "font-size" element of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure.
fontSize	RelAbsVector_t value of the "font-size" element to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int RenderGroup_setFontStyle	(	RenderGroup_t *	rg,
		FontStyle_t	fontStyle
	)

Sets the value of the "font-style" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure.
fontStyle	FontStyle_t value of the "font-style" attribute to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

The attribute "font-style" is used to specify whether the text is to be "normal" or "italic". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-style":

"italic", slanted print
"normal", upright print

int RenderGroup_setFontStyleAsString	(	RenderGroup_t *	rg,
		const char *	fontStyle
	)

Sets the value of the "font-style" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure.
fontStyle	const char * of the "font-style" attribute to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

The attribute "font-style" is used to specify whether the text is to be "normal" or "italic". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-style":

"italic", slanted print
"normal", upright print

int RenderGroup_setFontWeight	(	RenderGroup_t *	rg,
		FontWeight_t	fontWeight
	)

Sets the value of the "font-weight" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure.
fontWeight	FontWeight_t value of the "font-weight" attribute to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

The attribute "font-weight" is used to specify whether the text is to be "normal" or "bold". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-weight":

"bold", darker and/or thicker than normal print.
"normal", the typical print weight; lighter and/or thinner than "bold".

int RenderGroup_setFontWeightAsString	(	RenderGroup_t *	rg,
		const char *	fontWeight
	)

Sets the value of the "font-weight" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure.
fontWeight	const char * of the "font-weight" attribute to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

The attribute "font-weight" is used to specify whether the text is to be "normal" or "bold". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-weight":

"bold", darker and/or thicker than normal print.
"normal", the typical print weight; lighter and/or thinner than "bold".

int RenderGroup_setStartHead	(	RenderGroup_t *	rg,
		const char *	startHead
	)

Sets the value of the "startHead" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure.
startHead	const char * value of the "startHead" attribute to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int RenderGroup_setTextAnchor	(	RenderGroup_t *	rg,
		HTextAnchor_t	textAnchor
	)

Sets the value of the "text-anchor" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure.
textAnchor	HTextAnchor_t value of the "text-anchor" attribute to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

The attribute "text-anchor" is used to specify the horizontal alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "text-anchor":

"start", the start of the text is aligned to the horizontal center of the box.
"middle", the horizontal center of the text is aligned to the horizontal center of the box.
"end", the end of the text is aligned to the horizontal center of the box.

int RenderGroup_setTextAnchorAsString	(	RenderGroup_t *	rg,
		const char *	textAnchor
	)

Sets the value of the "text-anchor" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure.
textAnchor	const char * of the "text-anchor" attribute to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

The attribute "text-anchor" is used to specify the horizontal alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "text-anchor":

"start", the start of the text is aligned to the horizontal center of the box.
"middle", the horizontal center of the text is aligned to the horizontal center of the box.
"end", the end of the text is aligned to the horizontal center of the box.

int RenderGroup_setVTextAnchor	(	RenderGroup_t *	rg,
		VTextAnchor_t	vtextAnchor
	)

Sets the value of the "vtext-anchor" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure.
vtextAnchor	VTextAnchor_t value of the "vtext-anchor" attribute to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

The attribute "vtext-anchor" is used to specify the vertical alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "vtext-anchor":

"top", the top of the text is aligned to the vertical center of the box.
"middle", the vertical center of the text is aligned with the vertical center of the box.
"bottom", the bottom of the text (i.e. the very bottom of any descending letter like 'y' or 'p') is aligned with the vertical center of the box.
"baseline", the baseline of the text (i.e. the bottom of any non-descending letter like 'a' or e') is aligned with the vertical center of the box.

int RenderGroup_setVTextAnchorAsString	(	RenderGroup_t *	rg,
		const char *	vtextAnchor
	)

Sets the value of the "vtext-anchor" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure.
vtextAnchor	const char * of the "vtext-anchor" attribute to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

The attribute "vtext-anchor" is used to specify the vertical alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "vtext-anchor":

"top", the top of the text is aligned to the vertical center of the box.
"middle", the vertical center of the text is aligned with the vertical center of the box.
"bottom", the bottom of the text (i.e. the very bottom of any descending letter like 'y' or 'p') is aligned with the vertical center of the box.
"baseline", the baseline of the text (i.e. the bottom of any non-descending letter like 'a' or e') is aligned with the vertical center of the box.

int RenderGroup_unsetEndHead ( RenderGroup_t * rg )

Unsets the value of the "endHead" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int RenderGroup_unsetFontFamily ( RenderGroup_t * rg )

Unsets the value of the "font-family" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int RenderGroup_unsetFontSize ( RenderGroup_t * rg )

Unsets the value of the "font-size" element of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int RenderGroup_unsetFontStyle ( RenderGroup_t * rg )

Unsets the value of the "font-style" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

The attribute "font-style" is used to specify whether the text is to be "normal" or "italic". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-style":

"italic", slanted print
"normal", upright print

int RenderGroup_unsetFontWeight ( RenderGroup_t * rg )

Unsets the value of the "font-weight" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

The attribute "font-weight" is used to specify whether the text is to be "normal" or "bold". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-weight":

"bold", darker and/or thicker than normal print.
"normal", the typical print weight; lighter and/or thinner than "bold".

int RenderGroup_unsetStartHead ( RenderGroup_t * rg )

Unsets the value of the "startHead" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int RenderGroup_unsetTextAnchor ( RenderGroup_t * rg )

Unsets the value of the "text-anchor" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

The attribute "text-anchor" is used to specify the horizontal alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "text-anchor":

"start", the start of the text is aligned to the horizontal center of the box.
"middle", the horizontal center of the text is aligned to the horizontal center of the box.
"end", the end of the text is aligned to the horizontal center of the box.

int RenderGroup_unsetVTextAnchor ( RenderGroup_t * rg )

Unsets the value of the "vtext-anchor" attribute of this RenderGroup_t.

Parameters

rg	the RenderGroup_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

The attribute "vtext-anchor" is used to specify the vertical alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "vtext-anchor":

"top", the top of the text is aligned to the vertical center of the box.
"middle", the vertical center of the text is aligned with the vertical center of the box.
"bottom", the bottom of the text (i.e. the very bottom of any descending letter like 'y' or 'p') is aligned with the vertical center of the box.
"baseline", the baseline of the text (i.e. the bottom of any non-descending letter like 'a' or e') is aligned with the vertical center of the box.

Detailed Description

Public Member Functions

Member Function Documentation