Detailed Description

render Representation of cubic Bezier curves.

The RenderCubicBezier_t is derived from RenderPoint_t and is the second element needed to represent arbitrary curves with relative coordinates as they can appear in RenderCurve_t and Polygon_t objects. In addition to the attributes inherited from RenderPoint_t, RenderCubicBezier_t has two additional attributes for the two base points that define a cubic bezier curve.

Segments in a RenderCurve_t or a Polygon_t are always defined by two consecutive RenderPoint_t or RenderCubicBezier_t elements. The first element in a list of RenderPoints has to be a RenderPoint_t object, all following elements can either be RenderPoint_t or RenderCubicBezier_t elements. If the second element is a RenderPoint_t, the two elements represent a straight line segement; if the second element if a RenderCubicBezier_t, the two elements represent a cubic bezier curve segment.

For further details please have a look at the SBML Level 3 Render package specification.

Public Member Functions
RenderCubicBezier_t *	RenderCubicBezier_clone (const RenderCubicBezier_t *rcb)
	Creates and returns a deep copy of this RenderCubicBezier_t object. More...

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

void	RenderCubicBezier_free (RenderCubicBezier_t *rcb)
	Frees this RenderCubicBezier_t object. More...

const RelAbsVector_t *	RenderCubicBezier_getBasePoint1_x (const RenderCubicBezier_t *rcb)
	Returns the value of the "basePoint1_x" element of this RenderCubicBezier_t. More...

const RelAbsVector_t *	RenderCubicBezier_getBasePoint1_y (const RenderCubicBezier_t *rcb)
	Returns the value of the "basePoint1_y" element of this RenderCubicBezier_t. More...

const RelAbsVector_t *	RenderCubicBezier_getBasePoint1_z (const RenderCubicBezier_t *rcb)
	Returns the value of the "basePoint1_z" element of this RenderCubicBezier_t. More...

const RelAbsVector_t *	RenderCubicBezier_getBasePoint2_x (const RenderCubicBezier_t *rcb)
	Returns the value of the "basePoint2_x" element of this RenderCubicBezier_t. More...

const RelAbsVector_t *	RenderCubicBezier_getBasePoint2_y (const RenderCubicBezier_t *rcb)
	Returns the value of the "basePoint2_y" element of this RenderCubicBezier_t. More...

const RelAbsVector_t *	RenderCubicBezier_getBasePoint2_z (const RenderCubicBezier_t *rcb)
	Returns the value of the "basePoint2_z" element of this RenderCubicBezier_t. More...

int	RenderCubicBezier_hasRequiredAttributes (const RenderCubicBezier_t *rcb)
	Predicate returning `1` (true) if all the required attributes for this RenderCubicBezier_t object have been set. More...

int	RenderCubicBezier_isSetBasePoint1_x (const RenderCubicBezier_t *rcb)
	Predicate returning `1` (true) if this RenderCubicBezier_t's "basePoint1_x" element is set. More...

int	RenderCubicBezier_isSetBasePoint1_y (const RenderCubicBezier_t *rcb)
	Predicate returning `1` (true) if this RenderCubicBezier_t's "basePoint1_y" element is set. More...

int	RenderCubicBezier_isSetBasePoint1_z (const RenderCubicBezier_t *rcb)
	Predicate returning `1` (true) if this RenderCubicBezier_t's "basePoint1_z" element is set. More...

int	RenderCubicBezier_isSetBasePoint2_x (const RenderCubicBezier_t *rcb)
	Predicate returning `1` (true) if this RenderCubicBezier_t's "basePoint2_x" element is set. More...

int	RenderCubicBezier_isSetBasePoint2_y (const RenderCubicBezier_t *rcb)
	Predicate returning `1` (true) if this RenderCubicBezier_t's "basePoint2_y" element is set. More...

int	RenderCubicBezier_isSetBasePoint2_z (const RenderCubicBezier_t *rcb)
	Predicate returning `1` (true) if this RenderCubicBezier_t's "basePoint2_z" element is set. More...

int	RenderCubicBezier_setBasePoint1_x (RenderCubicBezier_t rcb, const RelAbsVector_t basePoint1_x)
	Sets the value of the "basePoint1_x" element of this RenderCubicBezier_t. More...

int	RenderCubicBezier_setBasePoint1_y (RenderCubicBezier_t rcb, const RelAbsVector_t basePoint1_y)
	Sets the value of the "basePoint1_y" element of this RenderCubicBezier_t. More...

int	RenderCubicBezier_setBasePoint1_z (RenderCubicBezier_t rcb, const RelAbsVector_t basePoint1_z)
	Sets the value of the "basePoint1_z" element of this RenderCubicBezier_t. More...

int	RenderCubicBezier_setBasePoint2_x (RenderCubicBezier_t rcb, const RelAbsVector_t basePoint2_x)
	Sets the value of the "basePoint2_x" element of this RenderCubicBezier_t. More...

int	RenderCubicBezier_setBasePoint2_y (RenderCubicBezier_t rcb, const RelAbsVector_t basePoint2_y)
	Sets the value of the "basePoint2_y" element of this RenderCubicBezier_t. More...

int	RenderCubicBezier_setBasePoint2_z (RenderCubicBezier_t rcb, const RelAbsVector_t basePoint2_z)
	Sets the value of the "basePoint2_z" element of this RenderCubicBezier_t. More...

int	RenderCubicBezier_unsetBasePoint1_x (RenderCubicBezier_t *rcb)
	Unsets the value of the "basePoint1_x" element of this RenderCubicBezier_t. More...

int	RenderCubicBezier_unsetBasePoint1_y (RenderCubicBezier_t *rcb)
	Unsets the value of the "basePoint1_y" element of this RenderCubicBezier_t. More...

int	RenderCubicBezier_unsetBasePoint1_z (RenderCubicBezier_t *rcb)
	Unsets the value of the "basePoint1_z" element of this RenderCubicBezier_t. More...

int	RenderCubicBezier_unsetBasePoint2_x (RenderCubicBezier_t *rcb)
	Unsets the value of the "basePoint2_x" element of this RenderCubicBezier_t. More...

int	RenderCubicBezier_unsetBasePoint2_y (RenderCubicBezier_t *rcb)
	Unsets the value of the "basePoint2_y" element of this RenderCubicBezier_t. More...

int	RenderCubicBezier_unsetBasePoint2_z (RenderCubicBezier_t *rcb)
	Unsets the value of the "basePoint2_z" element of this RenderCubicBezier_t. More...

Member Function Documentation

RenderCubicBezier_t * RenderCubicBezier_clone ( const RenderCubicBezier_t * rcb )

Creates and returns a deep copy of this RenderCubicBezier_t object.

Parameters

rcb	the RenderCubicBezier_t structure.

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

RenderCubicBezier_t * RenderCubicBezier_create	(	unsigned int	level,
		unsigned int	version,
		unsigned int	pkgVersion
	)

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

Parameters

level	an unsigned int, the SBML Level to assign to this RenderCubicBezier_t.
version	an unsigned int, the SBML Version to assign to this RenderCubicBezier_t.
pkgVersion	an unsigned int, the SBML Render Version to assign to this RenderCubicBezier_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 RenderCubicBezier_free ( RenderCubicBezier_t * rcb )

Frees this RenderCubicBezier_t object.

Parameters

rcb	the RenderCubicBezier_t structure.

const RelAbsVector_t * RenderCubicBezier_getBasePoint1_x ( const RenderCubicBezier_t * rcb )

Returns the value of the "basePoint1_x" element of this RenderCubicBezier_t.

Parameters

rcb	the RenderCubicBezier_t structure whose basePoint1_x is sought.

Returns: the value of the "basePoint1_x" element of this RenderCubicBezier_t as a RelAbsVector_t.

const RelAbsVector_t * RenderCubicBezier_getBasePoint1_y ( const RenderCubicBezier_t * rcb )

Returns the value of the "basePoint1_y" element of this RenderCubicBezier_t.

Parameters

rcb	the RenderCubicBezier_t structure whose basePoint1_y is sought.

Returns: the value of the "basePoint1_y" element of this RenderCubicBezier_t as a RelAbsVector_t.

const RelAbsVector_t * RenderCubicBezier_getBasePoint1_z ( const RenderCubicBezier_t * rcb )

Returns the value of the "basePoint1_z" element of this RenderCubicBezier_t.

Parameters

rcb	the RenderCubicBezier_t structure whose basePoint1_z is sought.

Returns: the value of the "basePoint1_z" element of this RenderCubicBezier_t as a RelAbsVector_t.

const RelAbsVector_t * RenderCubicBezier_getBasePoint2_x ( const RenderCubicBezier_t * rcb )

Returns the value of the "basePoint2_x" element of this RenderCubicBezier_t.

Parameters

rcb	the RenderCubicBezier_t structure whose basePoint2_x is sought.

Returns: the value of the "basePoint2_x" element of this RenderCubicBezier_t as a RelAbsVector_t.

const RelAbsVector_t * RenderCubicBezier_getBasePoint2_y ( const RenderCubicBezier_t * rcb )

Returns the value of the "basePoint2_y" element of this RenderCubicBezier_t.

Parameters

rcb	the RenderCubicBezier_t structure whose basePoint2_y is sought.

Returns: the value of the "basePoint2_y" element of this RenderCubicBezier_t as a RelAbsVector_t.

const RelAbsVector_t * RenderCubicBezier_getBasePoint2_z ( const RenderCubicBezier_t * rcb )

Returns the value of the "basePoint2_z" element of this RenderCubicBezier_t.

Parameters

rcb	the RenderCubicBezier_t structure whose basePoint2_z is sought.

Returns: the value of the "basePoint2_z" element of this RenderCubicBezier_t as a RelAbsVector_t.

int RenderCubicBezier_hasRequiredAttributes ( const RenderCubicBezier_t * rcb )

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

Parameters

rcb	the RenderCubicBezier_t structure.

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

Note

The required attributes for the RenderCubicBezier_t object are:

"basePoint1_x"
"basePoint1_y"
"basePoint2_x"
"basePoint2_y"

int RenderCubicBezier_isSetBasePoint1_x ( const RenderCubicBezier_t * rcb )

Predicate returning 1 (true) if this RenderCubicBezier_t's "basePoint1_x" element is set.

Parameters

rcb	the RenderCubicBezier_t structure.

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

int RenderCubicBezier_isSetBasePoint1_y ( const RenderCubicBezier_t * rcb )

Predicate returning 1 (true) if this RenderCubicBezier_t's "basePoint1_y" element is set.

Parameters

rcb	the RenderCubicBezier_t structure.

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

int RenderCubicBezier_isSetBasePoint1_z ( const RenderCubicBezier_t * rcb )

Predicate returning 1 (true) if this RenderCubicBezier_t's "basePoint1_z" element is set.

Parameters

rcb	the RenderCubicBezier_t structure.

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

int RenderCubicBezier_isSetBasePoint2_x ( const RenderCubicBezier_t * rcb )

Predicate returning 1 (true) if this RenderCubicBezier_t's "basePoint2_x" element is set.

Parameters

rcb	the RenderCubicBezier_t structure.

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

int RenderCubicBezier_isSetBasePoint2_y ( const RenderCubicBezier_t * rcb )

Predicate returning 1 (true) if this RenderCubicBezier_t's "basePoint2_y" element is set.

Parameters

rcb	the RenderCubicBezier_t structure.

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

int RenderCubicBezier_isSetBasePoint2_z ( const RenderCubicBezier_t * rcb )

Predicate returning 1 (true) if this RenderCubicBezier_t's "basePoint2_z" element is set.

Parameters

rcb	the RenderCubicBezier_t structure.

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

int RenderCubicBezier_setBasePoint1_x	(	RenderCubicBezier_t *	rcb,
		const RelAbsVector_t *	basePoint1_x
	)

Sets the value of the "basePoint1_x" element of this RenderCubicBezier_t.

Parameters

rcb	the RenderCubicBezier_t structure.
basePoint1_x	RelAbsVector_t value of the "basePoint1_x" element to be set.

Returns