RadialGradient (LibSBML Java API)

java.lang.Object
- org.sbml.libsbml.SBase
- - org.sbml.libsbml.GradientBase
  - - org.sbml.libsbml.RadialGradient

```
public class RadialGradient
extends GradientBase
```
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 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 object definitions, see the SBML Render package specification and/or the SVG specification.

See Also:

GradientBase, RelAbsVector

Field Summary
- Fields inherited from class org.sbml.libsbml.GradientBase
  INVALID, PAD, REFLECT, REPEAT

Constructor Summary

Constructors
Constructor and Description
`RadialGradient()` Creates a new `RadialGradient` using the given SBML Level, Version and “render” package version.
`RadialGradient(long level)` Creates a new `RadialGradient` using the given SBML Level, Version and “render” package version.
`RadialGradient(long level, long version)` Creates a new `RadialGradient` using the given SBML Level, Version and “render” package version.
`RadialGradient(long level, long version, long pkgVersion)` Creates a new `RadialGradient` using the given SBML Level, Version and “render” package version.
`RadialGradient(RadialGradient orig)` Copy constructor for `RadialGradient`.
`RadialGradient(RenderPkgNamespaces renderns)` Creates a new `RadialGradient` using the given `RenderPkgNamespaces` object.
`RadialGradient(RenderPkgNamespaces renderns, java.lang.String id)` Constructor which creates a `RadialGradient` with no gradient stops.
`RadialGradient(XMLNode node, long l2version)` Creates a new `RadialGradient` object from the given `XMLNode` object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RadialGradient`	`cloneObject()` Creates and returns a deep copy of this `RadialGradient` object.
`void`	`delete()` Explicitly deletes the underlying native object.
`RelAbsVector`	`getCenterX()` Returns the x coordinate for the start point as a reference.
`RelAbsVector`	`getCenterY()` Returns the y coordinate for the start point as a reference.
`RelAbsVector`	`getCenterZ()` Returns the z coordinate for the start point as a reference.
`RelAbsVector`	`getCx()` Returns the value of the 'cx' element of this `RadialGradient`.
`RelAbsVector`	`getCy()` Returns the value of the 'cy' element of this `RadialGradient`.
`RelAbsVector`	`getCz()` Returns the value of the 'cz' element of this `RadialGradient`.
`java.lang.String`	`getElementName()` Returns the XML element name of this `RadialGradient` object.
`RelAbsVector`	`getFocalPointX()` Returns the x coordinate for the start point as a reference.
`RelAbsVector`	`getFocalPointY()` Returns the y coordinate for the start point as a reference.
`RelAbsVector`	`getFocalPointZ()` Returns the z coordinate for the start point as a reference.
`RelAbsVector`	`getFx()` Returns the value of the 'fx' element of this `RadialGradient`.
`RelAbsVector`	`getFy()` Returns the value of the 'fy' element of this `RadialGradient`.
`RelAbsVector`	`getFz()` Returns the value of the 'fz' element of this `RadialGradient`.
`RelAbsVector`	`getR()` Returns the value of the 'r' element of this `RadialGradient`.
`RelAbsVector`	`getRadius()` Returns the radius as a reference.
`int`	`getTypeCode()` Returns the libSBML type code for this `RadialGradient` object.
`boolean`	`isSetCx()` Predicate returning `true` if this `RadialGradient`'s 'cx' element is set.
`boolean`	`isSetCy()` Predicate returning `true` if this `RadialGradient`'s 'cy' element is set.
`boolean`	`isSetCz()` Predicate returning `true` if this `RadialGradient`'s 'cz' element is set.
`boolean`	`isSetFx()` Predicate returning `true` if this `RadialGradient`'s 'fx' element is set.
`boolean`	`isSetFy()` Predicate returning `true` if this `RadialGradient`'s 'fy' element is set.
`boolean`	`isSetFz()` Predicate returning `true` if this `RadialGradient`'s 'fz' element is set.
`boolean`	`isSetR()` Predicate returning `true` if this `RadialGradient`'s 'r' element is set.
`void`	`setCenter(RelAbsVector x, RelAbsVector y)` Sets the coordinates for the center point.
`void`	`setCenter(RelAbsVector x, RelAbsVector y, RelAbsVector z)` Sets the coordinates for the center point.
`void`	`setCoordinates(RelAbsVector x, RelAbsVector y, RelAbsVector r, RelAbsVector fx, RelAbsVector fy)` Sets the 2D coordinates for the center and the focal point as well as the radius.
`void`	`setCoordinates(RelAbsVector x, RelAbsVector y, RelAbsVector z, RelAbsVector r, RelAbsVector fx, RelAbsVector fy, RelAbsVector fz)` Sets the 3D coordinates for the center and the focal point as well as the radius.
`int`	`setCx(RelAbsVector cx)` Sets the value of the 'cx' element of this `RadialGradient`.
`int`	`setCy(RelAbsVector cy)` Sets the value of the 'cy' element of this `RadialGradient`.
`int`	`setCz(RelAbsVector cz)` Sets the value of the 'cz' element of this `RadialGradient`.
`void`	`setFocalPoint(RelAbsVector x, RelAbsVector y)` Sets the coordinates for the focal point.
`void`	`setFocalPoint(RelAbsVector x, RelAbsVector y, RelAbsVector z)` Sets the coordinates for the focal point.
`int`	`setFx(RelAbsVector fx)` Sets the value of the 'fx' element of this `RadialGradient`.
`int`	`setFy(RelAbsVector fy)` Sets the value of the 'fy' element of this `RadialGradient`.
`int`	`setFz(RelAbsVector fz)` Sets the value of the 'fz' element of this `RadialGradient`.
`int`	`setR(RelAbsVector r)` Sets the value of the 'r' element of this `RadialGradient`.
`int`	`setRadius(RelAbsVector r)` Sets the radius of the radial gradient.
`XMLNode`	`toXML()` Creates an `XMLNode` object from this `RadialGradient` object.
`int`	`unsetCx()` Unsets the value of the 'cx' element of this `RadialGradient`.
`int`	`unsetCy()` Unsets the value of the 'cy' element of this `RadialGradient`.
`int`	`unsetCz()` Unsets the value of the 'cz' element of this `RadialGradient`.
`int`	`unsetFx()` Unsets the value of the 'fx' element of this `RadialGradient`.
`int`	`unsetFy()` Unsets the value of the 'fy' element of this `RadialGradient`.
`int`	`unsetFz()` Unsets the value of the 'fz' element of this `RadialGradient`.
`int`	`unsetR()` Unsets the value of the 'r' element of this `RadialGradient`.

Methods inherited from class org.sbml.libsbml.SBase
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, connectToChild, deleteDisabledPlugins, deleteDisabledPlugins, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getDisabledPlugin, getIdAttribute, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumDisabledPlugins, getNumPlugins, getPackageCoreVersion, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getPlugin, getPrefix, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getURI, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetIdAttribute, isSetMetaId, isSetModelHistory, isSetNotes, isSetSBOTerm, isSetUserData, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeFromParentAndDelete, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setIdAttribute, setMetaId, setModelHistory, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetIdAttribute, unsetMetaId, unsetModelHistory, unsetNotes, unsetSBOTerm, unsetUserData

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RadialGradient
```
public RadialGradient(long level,
                      long version,
                      long pkgVersion)
               throws SBMLConstructorException
```
    Creates a new RadialGradient using the given SBML Level, Version and “render” package version.
    
    Parameters:
    
    level - a long integer, the SBML Level to assign to this RadialGradient.
    
    version - a long integer, the SBML Version to assign to this RadialGradient.
    
    pkgVersion - a long integer, the SBML Render Version to assign to this RadialGradient.
    
    Throws:
    
    SBMLConstructorException
    
    Note:
    
    Attempting to add an object to an SBMLDocument 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), 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.
  - RadialGradient
```
public RadialGradient(long level,
                      long version)
               throws SBMLConstructorException
```
    Creates a new RadialGradient using the given SBML Level, Version and “render” package version.
    
    Parameters:
    
    level - a long integer, the SBML Level to assign to this RadialGradient.
    
    version - a long integer, the SBML Version to assign to this RadialGradient.
    
    pkgVersion - a long integer, the SBML Render Version to assign to this RadialGradient.
    
    Throws:
    
    SBMLConstructorException
    
    Note:
    
    Attempting to add an object to an SBMLDocument 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), 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.
  - RadialGradient
```
public RadialGradient(long level)
               throws SBMLConstructorException
```
    Creates a new RadialGradient using the given SBML Level, Version and “render” package version.
    
    Parameters:
    
    level - a long integer, the SBML Level to assign to this RadialGradient.
    
    version - a long integer, the SBML Version to assign to this RadialGradient.
    
    pkgVersion - a long integer, the SBML Render Version to assign to this RadialGradient.
    
    Throws:
    
    SBMLConstructorException
    
    Note:
    
    Attempting to add an object to an SBMLDocument 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), 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.
  - RadialGradient
```
public RadialGradient()
               throws SBMLConstructorException
```
    Creates a new RadialGradient using the given SBML Level, Version and “render” package version.
    
    Parameters:
    
    level - a long integer, the SBML Level to assign to this RadialGradient.
    
    version - a long integer, the SBML Version to assign to this RadialGradient.
    
    pkgVersion - a long integer, the SBML Render Version to assign to this RadialGradient.
    
    Throws:
    
    SBMLConstructorException
    
    Note:
    
    Attempting to add an object to an SBMLDocument 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), 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.
  - RadialGradient
```
public RadialGradient(RenderPkgNamespaces renderns)
               throws SBMLConstructorException
```
    Creates a new RadialGradient using the given RenderPkgNamespaces object.
    
    The package namespaces object used in this constructor is derived from a SBMLNamespaces object, which encapsulates SBML Level/Version/namespaces information. It is used to communicate the SBML Level, Version, and package version and name information used in addition to SBML Level 3 Core. A common approach to using libSBML's SBMLNamespaces facilities is to create an package namespace object somewhere in a program once, then hand that object as needed to object constructors of that package that accept it as and argument, such as this one.
    
    Parameters:
    
    renderns - the RenderPkgNamespaces object.
    
    Throws:
    
    SBMLConstructorException
    
    Note:
    
    Attempting to add an object to an SBMLDocument 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), 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.
  - RadialGradient
```
public RadialGradient(XMLNode node,
                      long l2version)
               throws SBMLConstructorException
```
    Creates a new RadialGradient object from the given XMLNode object. The XMLNode object has to contain a valid XML representation of a RadialGradient object as defined in the render extension specification. This method is normally called when render information is read from a file and should normally not have to be called explicitly.
    
    Parameters:
    
    node - the XMLNode object reference that describes the RadialGradient object to be instantiated.
    
    l2version - an integer indicating the version of SBML Level 2
    
    Throws:
    
    SBMLConstructorException
  - RadialGradient
```
public RadialGradient(RenderPkgNamespaces renderns,
                      java.lang.String id)
               throws SBMLConstructorException
```
    Constructor which creates a RadialGradient with no gradient stops. The id is set to the given value. The RadialGradient object is invalid until it has an id and at least two gradient stops. The start and the end of the linear gradient vector are set to (0,0,0). A linear gradient with a vector of length zero should also be considered invalid.
    
    Parameters:
    
    renderns - the SBMLNamespaces object for the SBML 'render' package
    
    id - the new id for the RadialGradient.
    
    Throws:
    
    SBMLConstructorException
    
    Warning:
    
    This constructor is deprecated. The new libSBML API uses constructors that either take the SBML Level and Version, or take an SBMLNamespaces object.
  - RadialGradient
```
public RadialGradient(RadialGradient orig)
               throws SBMLConstructorException
```
    Copy constructor for RadialGradient.
    
    Parameters:
    
    orig - the RadialGradient instance to copy.
    
    Throws:
    
    SBMLConstructorException
- Method Detail
  - delete
```
public void delete()
```
    Explicitly deletes the underlying native object.
    In general, application software will not need to call this method directly. The Java language binding for libSBML is implemented as a language wrapper that provides a Java interface to libSBML's underlying C++/C code. Some of the Java methods return objects that are linked to objects created not by Java code, but by C++ code. The Java objects wrapped around them will be deleted when the garbage collector invokes the corresponding C++ finalize() methods for the objects. The finalize() methods in turn call the RadialGradient.delete() method on the libSBML object.
    This method is exposed in case calling programs want to ensure that the underlying object is freed immediately, and not at some arbitrary time determined by the Java garbage collector. In normal usage, callers do not need to invoke RadialGradient.delete() themselves.
    
    Overrides:
    
    delete in class GradientBase
  - cloneObject
```
public RadialGradient cloneObject()
```
    Creates and returns a deep copy of this RadialGradient object.
    
    Overrides:
    
    cloneObject in class GradientBase
    
    Returns:
    
    a (deep) copy of this RadialGradient object.
  - getCx
```
public RelAbsVector getCx()
```
    Returns the value of the 'cx' element of this RadialGradient.
    
    Returns:
    
    the value of the 'cx' element of this RadialGradient as a RelAbsVector.
  - getCenterX
```
public RelAbsVector getCenterX()
```
    Returns the x coordinate for the start point as a reference.
    
    Returns:
    
    RelAbsVector that represents the x value of the start point.
  - getCy
```
public RelAbsVector getCy()
```
    Returns the value of the 'cy' element of this RadialGradient.
    
    Returns:
    
    the value of the 'cy' element of this RadialGradient as a RelAbsVector.
  - getCenterY
```
public RelAbsVector getCenterY()
```
    Returns the y coordinate for the start point as a reference.
    
    Returns:
    
    RelAbsVector that represents the y value of the start point.
  - getCz
```
public RelAbsVector getCz()
```
    Returns the value of the 'cz' element of this RadialGradient.
    
    Returns:
    
    the value of the 'cz' element of this RadialGradient as a RelAbsVector.
  - getCenterZ
```
public RelAbsVector getCenterZ()
```
    Returns the z coordinate for the start point as a reference.
    
    Returns:
    
    RelAbsVector that represents the z value of the start point.
  - getR
```
public RelAbsVector getR()
```
    Returns the value of the 'r' element of this RadialGradient.
    
    Returns:
    
    the value of the 'r' element of this RadialGradient as a RelAbsVector.
  - getRadius
```
public RelAbsVector getRadius()
```
    Returns the radius as a reference.
    
    Returns:
    
    reference to the radius
  - getFx
```
public RelAbsVector getFx()
```
    Returns the value of the 'fx' element of this RadialGradient.
    
    Returns:
    
    the value of the 'fx' element of this RadialGradient as a RelAbsVector.
  - getFocalPointX
```
public RelAbsVector getFocalPointX()
```
    Returns the x coordinate for the start point as a reference.
    
    Returns:
    
    RelAbsVector that represents the x value of the start point.
  - getFy
```
public RelAbsVector getFy()
```
    Returns the value of the 'fy' element of this RadialGradient.
    
    Returns:
    
    the value of the 'fy' element of this RadialGradient as a RelAbsVector.
  - getFocalPointY
```
public RelAbsVector getFocalPointY()
```
    Returns the y coordinate for the start point as a reference.
    
    Returns:
    
    RelAbsVector that represents the y value of the start point.
  - getFz
```
public RelAbsVector getFz()
```
    Returns the value of the 'fz' element of this RadialGradient.
    
    Returns:
    
    the value of the 'fz' element of this RadialGradient as a RelAbsVector.
  - getFocalPointZ
```
public RelAbsVector getFocalPointZ()
```
    Returns the z coordinate for the start point as a reference.
    
    Returns:
    
    RelAbsVector that represents the z value of the start point.
  - isSetCx
```
public boolean isSetCx()
```
    Predicate returning true if this RadialGradient's 'cx' element is set.
    
    Returns:
    
    true if this RadialGradient's 'cx' element has been set, otherwise false is returned.
  - isSetCy
```
public boolean isSetCy()
```
    Predicate returning true if this RadialGradient's 'cy' element is set.
    
    Returns:
    
    true if this RadialGradient's 'cy' element has been set, otherwise false is returned.
  - isSetCz
```
public boolean isSetCz()
```
    Predicate returning true if this RadialGradient's 'cz' element is set.
    
    Returns:
    
    true if this RadialGradient's 'cz' element has been set, otherwise false is returned.
  - isSetR
```
public boolean isSetR()
```
    Predicate returning true if this RadialGradient's 'r' element is set.
    
    Returns:
    
    true if this RadialGradient's 'r' element has been set, otherwise false is returned.
  - isSetFx
```
public boolean isSetFx()
```
    Predicate returning true if this RadialGradient's 'fx' element is set.
    
    Returns:
    
    true if this RadialGradient's 'fx' element has been set, otherwise false is returned.
  - isSetFy
```
public boolean isSetFy()
```
    Predicate returning true if this RadialGradient's 'fy' element is set.
    
    Returns:
    
    true if this RadialGradient's 'fy' element has been set, otherwise false is returned.
  - isSetFz
```
public boolean isSetFz()
```
    Predicate returning true if this RadialGradient's 'fz' element is set.
    
    Returns:
    
    true if this RadialGradient's 'fz' element has been set, otherwise false is returned.
  - setCx
```
public int setCx(RelAbsVector cx)
```
    Sets the value of the 'cx' element of this RadialGradient.
    Parameters:
    
    cx - RelAbsVector value of the 'cx' element to be set.
    
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - setCy
```
public int setCy(RelAbsVector cy)
```
    Sets the value of the 'cy' element of this RadialGradient.
    Parameters:
    
    cy - RelAbsVector value of the 'cy' element to be set.
    
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - setCz
```
public int setCz(RelAbsVector cz)
```
    Sets the value of the 'cz' element of this RadialGradient.
    Parameters:
    
    cz - RelAbsVector value of the 'cz' element to be set.
    
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - setR
```
public int setR(RelAbsVector r)
```
    Sets the value of the 'r' element of this RadialGradient.
    Parameters:
    
    r - RelAbsVector value of the 'r' element to be set.
    
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - setRadius
```
public int setRadius(RelAbsVector r)
```
    Sets the radius of the radial gradient.
    Parameters:
    
    r - radius of the radial gradient vector.
    
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - setFx
```
public int setFx(RelAbsVector fx)
```
    Sets the value of the 'fx' element of this RadialGradient.
    Parameters:
    
    fx - RelAbsVector value of the 'fx' element to be set.
    
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - setFy
```
public int setFy(RelAbsVector fy)
```
    Sets the value of the 'fy' element of this RadialGradient.
    Parameters:
    
    fy - RelAbsVector value of the 'fy' element to be set.
    
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - setFz
```
public int setFz(RelAbsVector fz)
```
    Sets the value of the 'fz' element of this RadialGradient.
    Parameters:
    
    fz - RelAbsVector value of the 'fz' element to be set.
    
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - setCoordinates
```
public void setCoordinates(RelAbsVector x,
                           RelAbsVector y,
                           RelAbsVector z,
                           RelAbsVector r,
                           RelAbsVector fx,
                           RelAbsVector fy,
                           RelAbsVector fz)
```
    Sets the 3D coordinates for the center and the focal point as well as the radius. Each value can be a combination of absolute and relative value and is represented by a RelAbsVector object.
    
    Parameters:
    
    x - x value of the center point of the radial gradient vector
    
    y - y value of the center point of the radial gradient vector
    
    z - z value of the center point of the radial gradient vector
    
    r - x value of the radius of the radial gradient vector
    
    fx - x value of the focal point of the radial gradient vector
    
    fy - y value of the focal point of the radial gradient vector
    
    fz - z value of the focal point of the radial gradient vector
  - setCoordinates
```
public void setCoordinates(RelAbsVector x,
                           RelAbsVector y,
                           RelAbsVector r,
                           RelAbsVector fx,
                           RelAbsVector fy)
```
    Sets the 2D coordinates for the center and the focal point as well as the radius. The z values are automatically set to 0. Each value can be a combination of absolute and relative value and is represented by a RelAbsVector object.
    
    Parameters:
    
    x - x value of the center point of the radial gradient vector
    
    y - y value of the center point of the radial gradient vector
    
    r - x value of the radius of the radial gradient vector
    
    fx - x value of the focal point of the radial gradient vector
    
    fy - y value of the focal point of the radial gradient vector
  - setCenter
```
public void setCenter(RelAbsVector x,
                      RelAbsVector y,
                      RelAbsVector z)
```
    Sets the coordinates for the center point.
    
    Parameters:
    
    x - x value of the center point of the radial gradient vector
    
    y - y value of the center point of the radial gradient vector
    
    z - z value of the center point of the radial gradient vector The z argument can be omitted. In that case it is set to 0.
  - setCenter
```
public void setCenter(RelAbsVector x,
                      RelAbsVector y)
```
    Sets the coordinates for the center point.
    
    Parameters:
    
    x - x value of the center point of the radial gradient vector
    
    y - y value of the center point of the radial gradient vector
    
    z - z value of the center point of the radial gradient vector The z argument can be omitted. In that case it is set to 0.
  - setFocalPoint
```
public void setFocalPoint(RelAbsVector x,
                          RelAbsVector y,
                          RelAbsVector z)
```
    Sets the coordinates for the focal point.
    
    Parameters:
    
    x - x value of the focal point of the radial gradient vector
    
    y - y value of the focal point of the radial gradient vector
    
    z - z value of the focal point of the radial gradient vector. The z argument can be omitted. In that case it is set to 0.
  - setFocalPoint
```
public void setFocalPoint(RelAbsVector x,
                          RelAbsVector y)
```
    Sets the coordinates for the focal point.
    
    Parameters:
    
    x - x value of the focal point of the radial gradient vector
    
    y - y value of the focal point of the radial gradient vector
    
    z - z value of the focal point of the radial gradient vector. The z argument can be omitted. In that case it is set to 0.
  - unsetCx
```
public int unsetCx()
```
    Unsets the value of the 'cx' element of this RadialGradient.
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - unsetCy
```
public int unsetCy()
```
    Unsets the value of the 'cy' element of this RadialGradient.
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - unsetCz
```
public int unsetCz()
```
    Unsets the value of the 'cz' element of this RadialGradient.
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - unsetR
```
public int unsetR()
```
    Unsets the value of the 'r' element of this RadialGradient.
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - unsetFx
```
public int unsetFx()
```
    Unsets the value of the 'fx' element of this RadialGradient.
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - unsetFy
```
public int unsetFy()
```
    Unsets the value of the 'fy' element of this RadialGradient.
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - unsetFz
```
public int unsetFz()
```
    Unsets the value of the 'fz' element of this RadialGradient.
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - getElementName
```
public java.lang.String getElementName()
```
    Returns the XML element name of this RadialGradient object.
    For RadialGradient, the XML element name is always 'radialGradient'.
    
    Overrides:
    
    getElementName in class GradientBase
    
    Returns:
    
    the name of this element, i.e. 'radialGradient'.
  - getTypeCode
```
public int getTypeCode()
```
    Returns the libSBML type code for this RadialGradient object.
    
    LibSBML attaches an identifying code to every kind of SBML object. These are integer constants known as SBML type codes. The names of all the codes begin with the characters SBML_. In the Java language interface for libSBML, the type codes are defined as static integer constants in the interface class libsbmlConstants. Note that different Level 3 package plug-ins may use overlapping type codes; to identify the package to which a given object belongs, call the SBase.getPackageName() method on the object.
    The exception to this is lists: all SBML-style list elements have the type SBML_LIST_OF, regardless of what package they are from.
    
    Overrides:
    
    getTypeCode in class GradientBase
    
    Returns:
    
    the SBML type code for this object: SBML_RENDER_RADIALGRADIENT.
    
    See Also:
    
    RadialGradient.getElementName(), SBase.getPackageName()
    
    Warning:
    
    The specific integer values of the possible type codes may be reused by different libSBML plug-ins for SBML Level 3. packages, To fully identify the correct code, it is necessary to invoke both getPackageName() and getTypeCode() (or ListOf.getItemTypeCode()).
  - toXML
```
public XMLNode toXML()
```
    Creates an XMLNode object from this RadialGradient object.
    
    Overrides:
    
    toXML in class GradientBase
    
    Returns:
    
    the XMLNode with the XML representation for the RadialGradient object.

Class RadialGradient

Field Summary

Fields inherited from class org.sbml.libsbml.GradientBase

Constructor Summary

Method Summary

Methods inherited from class org.sbml.libsbml.GradientBase

Methods inherited from class org.sbml.libsbml.SBase

Methods inherited from class java.lang.Object

Constructor Detail

RadialGradient

RadialGradient

RadialGradient

RadialGradient

RadialGradient

RadialGradient

RadialGradient

RadialGradient

Method Detail

delete

cloneObject

getCx

getCenterX

getCy

getCenterY

getCz

getCenterZ

getR

getRadius

getFx

getFocalPointX

getFy

getFocalPointY

getFz

getFocalPointZ

isSetCx

isSetCy

isSetCz

isSetR

isSetFx

isSetFy

isSetFz

setCx

setCy

setCz

setR

setRadius

setFx

setFy

setFz

setCoordinates

setCoordinates

setCenter

setCenter

setFocalPoint

setFocalPoint

unsetCx

unsetCy

unsetCz

unsetR

unsetFx

unsetFy

unsetFz

getElementName

getTypeCode

toXML