Detailed Description

render Representation of a radial gradient.

The concept of a radial gradient is more or or less taken from SVG. A radial gradient is defined by a center point, a radius and an optional focal point. A valid gradient will have a positive radius greater than 0, and the focal point should be within the circle defined by the center point and the radius. Otherwise all restrictions for the GradientBase_t class apply.

The center and the focal point of a radial gradient are defined by three pairs of absolute-relative value. The radius is also defined as an absolute-relative value pair. For examples of RadialGradient_t object definitions, see the SBML Render package specification and/or the SVG specification.

See also: GradientBase_t; RelAbsVector_t

Public Member Functions
RadialGradient_t *	RadialGradient_clone (const RadialGradient_t *rg)
	Creates and returns a deep copy of this RadialGradient_t object. More...

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

void	RadialGradient_free (RadialGradient_t *rg)
	Frees this RadialGradient_t object. More...

const RelAbsVector_t *	RadialGradient_getCx (const RadialGradient_t *rg)
	Returns the value of the "cx" element of this RadialGradient_t. More...

const RelAbsVector_t *	RadialGradient_getCy (const RadialGradient_t *rg)
	Returns the value of the "cy" element of this RadialGradient_t. More...

const RelAbsVector_t *	RadialGradient_getCz (const RadialGradient_t *rg)
	Returns the value of the "cz" element of this RadialGradient_t. More...

const RelAbsVector_t *	RadialGradient_getFx (const RadialGradient_t *rg)
	Returns the value of the "fx" element of this RadialGradient_t. More...

const RelAbsVector_t *	RadialGradient_getFy (const RadialGradient_t *rg)
	Returns the value of the "fy" element of this RadialGradient_t. More...

const RelAbsVector_t *	RadialGradient_getFz (const RadialGradient_t *rg)
	Returns the value of the "fz" element of this RadialGradient_t. More...

const RelAbsVector_t *	RadialGradient_getR (const RadialGradient_t *rg)
	Returns the value of the "r" element of this RadialGradient_t. More...

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

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

int	RadialGradient_isSetCx (const RadialGradient_t *rg)
	Predicate returning `1` (true) if this RadialGradient_t's "cx" element is set. More...

int	RadialGradient_isSetCy (const RadialGradient_t *rg)
	Predicate returning `1` (true) if this RadialGradient_t's "cy" element is set. More...

int	RadialGradient_isSetCz (const RadialGradient_t *rg)
	Predicate returning `1` (true) if this RadialGradient_t's "cz" element is set. More...

int	RadialGradient_isSetFx (const RadialGradient_t *rg)
	Predicate returning `1` (true) if this RadialGradient_t's "fx" element is set. More...

int	RadialGradient_isSetFy (const RadialGradient_t *rg)
	Predicate returning `1` (true) if this RadialGradient_t's "fy" element is set. More...

int	RadialGradient_isSetFz (const RadialGradient_t *rg)
	Predicate returning `1` (true) if this RadialGradient_t's "fz" element is set. More...

int	RadialGradient_isSetR (const RadialGradient_t *rg)
	Predicate returning `1` (true) if this RadialGradient_t's "r" element is set. More...

int	RadialGradient_setCx (RadialGradient_t rg, const RelAbsVector_t cx)
	Sets the value of the "cx" element of this RadialGradient_t. More...

int	RadialGradient_setCy (RadialGradient_t rg, const RelAbsVector_t cy)
	Sets the value of the "cy" element of this RadialGradient_t. More...

int	RadialGradient_setCz (RadialGradient_t rg, const RelAbsVector_t cz)
	Sets the value of the "cz" element of this RadialGradient_t. More...

int	RadialGradient_setFx (RadialGradient_t rg, const RelAbsVector_t fx)
	Sets the value of the "fx" element of this RadialGradient_t. More...

int	RadialGradient_setFy (RadialGradient_t rg, const RelAbsVector_t fy)
	Sets the value of the "fy" element of this RadialGradient_t. More...

int	RadialGradient_setFz (RadialGradient_t rg, const RelAbsVector_t fz)
	Sets the value of the "fz" element of this RadialGradient_t. More...

int	RadialGradient_setR (RadialGradient_t rg, const RelAbsVector_t r)
	Sets the value of the "r" element of this RadialGradient_t. More...

int	RadialGradient_unsetCx (RadialGradient_t *rg)
	Unsets the value of the "cx" element of this RadialGradient_t. More...

int	RadialGradient_unsetCy (RadialGradient_t *rg)
	Unsets the value of the "cy" element of this RadialGradient_t. More...

int	RadialGradient_unsetCz (RadialGradient_t *rg)
	Unsets the value of the "cz" element of this RadialGradient_t. More...

int	RadialGradient_unsetFx (RadialGradient_t *rg)
	Unsets the value of the "fx" element of this RadialGradient_t. More...

int	RadialGradient_unsetFy (RadialGradient_t *rg)
	Unsets the value of the "fy" element of this RadialGradient_t. More...

int	RadialGradient_unsetFz (RadialGradient_t *rg)
	Unsets the value of the "fz" element of this RadialGradient_t. More...

int	RadialGradient_unsetR (RadialGradient_t *rg)
	Unsets the value of the "r" element of this RadialGradient_t. More...

Member Function Documentation

RadialGradient_t * RadialGradient_clone ( const RadialGradient_t * rg )

Creates and returns a deep copy of this RadialGradient_t object.

Parameters

rg	the RadialGradient_t structure.

Returns: a (deep) copy of this RadialGradient_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.

RadialGradient_t * RadialGradient_create	(	unsigned int	level,
		unsigned int	version,
		unsigned int	pkgVersion
	)

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

Parameters

level	an unsigned int, the SBML Level to assign to this RadialGradient_t.
version	an unsigned int, the SBML Version to assign to this RadialGradient_t.
pkgVersion	an unsigned int, the SBML Render Version to assign to this RadialGradient_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.

void RadialGradient_free ( RadialGradient_t * rg )

Frees this RadialGradient_t object.

Parameters

rg	the RadialGradient_t structure.

const RelAbsVector_t * RadialGradient_getCx ( const RadialGradient_t * rg )

Returns the value of the "cx" element of this RadialGradient_t.

Parameters

rg	the RadialGradient_t structure whose cx is sought.

Returns: the value of the "cx" element of this RadialGradient_t as a RelAbsVector_t.

const RelAbsVector_t * RadialGradient_getCy ( const RadialGradient_t * rg )

Returns the value of the "cy" element of this RadialGradient_t.

Parameters

rg	the RadialGradient_t structure whose cy is sought.

Returns: the value of the "cy" element of this RadialGradient_t as a RelAbsVector_t.

const RelAbsVector_t * RadialGradient_getCz ( const RadialGradient_t * rg )

Returns the value of the "cz" element of this RadialGradient_t.

Parameters

rg	the RadialGradient_t structure whose cz is sought.

Returns: the value of the "cz" element of this RadialGradient_t as a RelAbsVector_t.

const RelAbsVector_t * RadialGradient_getFx ( const RadialGradient_t * rg )

Returns the value of the "fx" element of this RadialGradient_t.

Parameters

rg	the RadialGradient_t structure whose fx is sought.

Returns: the value of the "fx" element of this RadialGradient_t as a RelAbsVector_t.

const RelAbsVector_t * RadialGradient_getFy ( const RadialGradient_t * rg )

Returns the value of the "fy" element of this RadialGradient_t.

Parameters

rg	the RadialGradient_t structure whose fy is sought.

Returns: the value of the "fy" element of this RadialGradient_t as a RelAbsVector_t.

const RelAbsVector_t * RadialGradient_getFz ( const RadialGradient_t * rg )

Returns the value of the "fz" element of this RadialGradient_t.

Parameters

rg	the RadialGradient_t structure whose fz is sought.

Returns: the value of the "fz" element of this RadialGradient_t as a RelAbsVector_t.

const RelAbsVector_t * RadialGradient_getR ( const RadialGradient_t * rg )

Returns the value of the "r" element of this RadialGradient_t.

Parameters

rg	the RadialGradient_t structure whose r is sought.

Returns: the value of the "r" element of this RadialGradient_t as a RelAbsVector_t.

int RadialGradient_hasRequiredAttributes ( const RadialGradient_t * rg )

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

Parameters

rg	the RadialGradient_t structure.

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

int RadialGradient_hasRequiredElements ( const RadialGradient_t * rg )

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

Parameters

rg	the RadialGradient_t structure.

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

Note: The required elements for the RadialGradient_t object are:

int RadialGradient_isSetCx ( const RadialGradient_t * rg )

Predicate returning 1 (true) if this RadialGradient_t's "cx" element is set.

Parameters

rg	the RadialGradient_t structure.

Returns: 1 (true) if this RadialGradient_t's "cx" element has been set, otherwise 0 (false) is returned.

int RadialGradient_isSetCy ( const RadialGradient_t * rg )

Predicate returning 1 (true) if this RadialGradient_t's "cy" element is set.

Parameters

rg	the RadialGradient_t structure.

Returns: 1 (true) if this RadialGradient_t's "cy" element has been set, otherwise 0 (false) is returned.

int RadialGradient_isSetCz ( const RadialGradient_t * rg )

Predicate returning 1 (true) if this RadialGradient_t's "cz" element is set.

Parameters

rg	the RadialGradient_t structure.

Returns: 1 (true) if this RadialGradient_t's "cz" element has been set, otherwise 0 (false) is returned.

int RadialGradient_isSetFx ( const RadialGradient_t * rg )

Predicate returning 1 (true) if this RadialGradient_t's "fx" element is set.

Parameters

rg	the RadialGradient_t structure.

Returns: 1 (true) if this RadialGradient_t's "fx" element has been set, otherwise 0 (false) is returned.

int RadialGradient_isSetFy ( const RadialGradient_t * rg )

Predicate returning 1 (true) if this RadialGradient_t's "fy" element is set.

Parameters

rg	the RadialGradient_t structure.

Returns: 1 (true) if this RadialGradient_t's "fy" element has been set, otherwise 0 (false) is returned.

int RadialGradient_isSetFz ( const RadialGradient_t * rg )

Predicate returning 1 (true) if this RadialGradient_t's "fz" element is set.

Parameters

rg	the RadialGradient_t structure.

Returns: 1 (true) if this RadialGradient_t's "fz" element has been set, otherwise 0 (false) is returned.

int RadialGradient_isSetR ( const RadialGradient_t * rg )

Predicate returning 1 (true) if this RadialGradient_t's "r" element is set.

Parameters

rg	the RadialGradient_t structure.

Returns: 1 (true) if this RadialGradient_t's "r" element has been set, otherwise 0 (false) is returned.

int RadialGradient_setCx	(	RadialGradient_t *	rg,
		const RelAbsVector_t *	cx
	)

Sets the value of the "cx" element of this RadialGradient_t.

Parameters

rg	the RadialGradient_t structure.
cx	RelAbsVector_t value of the "cx" element to be set.

Returns