LinearGradient (LibSBML Java API)

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

```
public class LinearGradient
extends GradientBase
```
Representation of a linear gradient object from the SBML render extension.
The concept of a linear gradient is more or or less taken from SVG. A linear gradient is defined by a vector which determines the direction and the length of the gradient. So for a valid gradient this vector should have a length different from 0. Otherwise all restrictions for the GradientBase class apply. ( The vector for a linear gradient is defined by a start and an endpoint and each point consists of three absolute-relative value pairs (@see RelAbsVector)
For examples of LinearGradients see the render extension specification and/or the SVG specification.

See Also:

GradientBase)

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

Constructor Summary

Constructors
Constructor and Description
`LinearGradient()` Creates a new `LinearGradient` object with the given SBML level and SBML version.
`LinearGradient(long level)` Creates a new `LinearGradient` object with the given SBML level and SBML version.
`LinearGradient(long level, long version)` Creates a new `LinearGradient` object with the given SBML level and SBML version.
`LinearGradient(long level, long version, long pkgVersion)` Creates a new `LinearGradient` object with the given SBML level and SBML version.
`LinearGradient(RenderPkgNamespaces renderns)` Creates a new `LinearGradient` object with the given `SBMLNamespaces`.
`LinearGradient(RenderPkgNamespaces renderns, java.lang.String id)` Constructor which creates a `LinearGradient` with no gradient stops.
`LinearGradient(XMLNode node)` Creates a new `LinearGradient` object from the given `XMLNode` object.
`LinearGradient(XMLNode node, long l2version)` Creates a new `LinearGradient` object from the given `XMLNode` object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LinearGradient`	`cloneObject()` Creates and returns a deep copy of this `LinearGradient` object.
`void`	`delete()` Explicitly deletes the underlying native object.
`java.lang.String`	`getElementName()` Returns the XML element name of this object.
`int`	`getTypeCode()` Returns the libSBML type code for this SBML object.
`RelAbsVector`	`getXPoint1()` Returns the x coordinate for the start point as a reference.
`RelAbsVector`	`getXPoint2()` Returns the x coordinate for the end point as a reference.
`RelAbsVector`	`getYPoint1()` Returns the y coordinate for the start point as a reference.
`RelAbsVector`	`getYPoint2()` Returns the y coordinate for the end point as a reference.
`RelAbsVector`	`getZPoint1()` Returns the z coordinate for the start point as a reference.
`RelAbsVector`	`getZPoint2()` Returns the z coordinate for the end point as a reference.
`void`	`setCoordinates(RelAbsVector x1, RelAbsVector y1, RelAbsVector x2, RelAbsVector y2)` Sets the 2D coordinates for the start and the end point of the linear gradient vector.
`void`	`setCoordinates(RelAbsVector x1, RelAbsVector y1, RelAbsVector z1, RelAbsVector x2, RelAbsVector y2, RelAbsVector z2)` Sets the 3D coordinates for the start and the end point of the linear gradient vector.
`void`	`setPoint1(RelAbsVector x, RelAbsVector y)` Sets the coordinates for the start point of the linear gradient vector.
`void`	`setPoint1(RelAbsVector x, RelAbsVector y, RelAbsVector z)` Sets the coordinates for the start point of the linear gradient vector.
`void`	`setPoint2(RelAbsVector x, RelAbsVector y)` Sets the coordinates for the end point of the linear gradient vector.
`void`	`setPoint2(RelAbsVector x, RelAbsVector y, RelAbsVector z)` Sets the coordinates for the end point of the linear gradient vector.
`XMLNode`	`toXML()` Creates an `XMLNode` object from this `LinearGradient` object.

Methods inherited from class org.sbml.libsbml.GradientBase
addGradientStop, connectToChild, createGradientStop, getGradientStop, getId, getListOfGradientStops, getName, getNumGradientStops, getSpreadMethod, isSetId, isSetName, setId, setName, setSpreadMethod, unsetId, unsetName

Methods inherited from class org.sbml.libsbml.SBase
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, deleteDisabledPlugins, deleteDisabledPlugins, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getDisabledPlugin, getElementByMetaId, getElementBySId, 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
  - LinearGradient
```
public LinearGradient(long level,
                      long version,
                      long pkgVersion)
               throws SBMLConstructorException
```
    Creates a new LinearGradient object with the given SBML level and SBML version.
    
    Parameters:
    
    level - SBML level of the new object
    
    level - SBML version of the new object
    
    Throws:
    
    SBMLConstructorException
  - LinearGradient
```
public LinearGradient(long level,
                      long version)
               throws SBMLConstructorException
```
    Creates a new LinearGradient object with the given SBML level and SBML version.
    
    Parameters:
    
    level - SBML level of the new object
    
    level - SBML version of the new object
    
    Throws:
    
    SBMLConstructorException
  - LinearGradient
```
public LinearGradient(long level)
               throws SBMLConstructorException
```
    Creates a new LinearGradient object with the given SBML level and SBML version.
    
    Parameters:
    
    level - SBML level of the new object
    
    level - SBML version of the new object
    
    Throws:
    
    SBMLConstructorException
  - LinearGradient
```
public LinearGradient()
               throws SBMLConstructorException
```
    Creates a new LinearGradient object with the given SBML level and SBML version.
    
    Parameters:
    
    level - SBML level of the new object
    
    level - SBML version of the new object
    
    Throws:
    
    SBMLConstructorException
  - LinearGradient
```
public LinearGradient(RenderPkgNamespaces renderns)
               throws SBMLConstructorException
```
    Creates a new LinearGradient object with the given SBMLNamespaces.
    
    Parameters:
    
    sbmlns - The SBML namespace for the object.
    
    Throws:
    
    SBMLConstructorException
  - LinearGradient
```
public LinearGradient(XMLNode node,
                      long l2version)
               throws SBMLConstructorException
```
    Creates a new LinearGradient object from the given XMLNode object. The XMLNode object has to contain a valid XML representation of a LinearGradient 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 LinearGradient object to be instantiated.
    
    Throws:
    
    SBMLConstructorException
  - LinearGradient
```
public LinearGradient(XMLNode node)
               throws SBMLConstructorException
```
    Creates a new LinearGradient object from the given XMLNode object. The XMLNode object has to contain a valid XML representation of a LinearGradient 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 LinearGradient object to be instantiated.
    
    Throws:
    
    SBMLConstructorException
  - LinearGradient
```
public LinearGradient(RenderPkgNamespaces renderns,
                      java.lang.String id)
               throws SBMLConstructorException
```
    Constructor which creates a LinearGradient with no gradient stops. The id is set to the given value. The LinearGradient 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:
    
    id - the new id for the LinearGradient.
    This constructor is deprecated. The new libsbml API only has constructors which take the SBML level and version or one that takes an SBMLNamespaces object.
    
    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 LinearGradient.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 LinearGradient.delete() themselves.
    
    Overrides:
    
    delete in class GradientBase
  - setCoordinates
```
public void setCoordinates(RelAbsVector x1,
                           RelAbsVector y1,
                           RelAbsVector z1,
                           RelAbsVector x2,
                           RelAbsVector y2,
                           RelAbsVector z2)
```
    Sets the 3D coordinates for the start and the end point of the linear gradient vector. Each value can be a combination of absolute and relative value and is represented by a RelAbsVector object.
    
    Parameters:
    
    x1 - x value of the start point of the linear gradient vector
    
    y1 - y value of the start point of the linear gradient vector
    
    z1 - z value of the start point of the linear gradient vector
    
    x2 - x value of the end point of the linear gradient vector
    
    y2 - y value of the end point of the linear gradient vector
    
    z2 - z value of the end point of the linear gradient vector
  - setCoordinates
```
public void setCoordinates(RelAbsVector x1,
                           RelAbsVector y1,
                           RelAbsVector x2,
                           RelAbsVector y2)
```
    Sets the 2D coordinates for the start and the end point of the linear gradient vector. 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:
    
    x1 - x value of the start point of the linear gradient vector
    
    y1 - y value of the start point of the linear gradient vector
    
    x2 - x value of the end point of the linear gradient vector
    
    y2 - y value of the end point of the linear gradient vector
  - setPoint1
```
public void setPoint1(RelAbsVector x,
                      RelAbsVector y,
                      RelAbsVector z)
```
    Sets the coordinates for the start point of the linear gradient vector.
    Each value can be a combination of absolute and relative value and is represented by a RelAbsVector object.
    The z value can be omitted. In that case it is set to 0.
    
    Parameters:
    
    x - x value of the start point of the linear gradient vector
    
    y - y value of the start point of the linear gradient vector
    
    z - z value of the start point of the linear gradient vector
  - setPoint1
```
public void setPoint1(RelAbsVector x,
                      RelAbsVector y)
```
    Sets the coordinates for the start point of the linear gradient vector.
    Each value can be a combination of absolute and relative value and is represented by a RelAbsVector object.
    The z value can be omitted. In that case it is set to 0.
    
    Parameters:
    
    x - x value of the start point of the linear gradient vector
    
    y - y value of the start point of the linear gradient vector
    
    z - z value of the start point of the linear gradient vector
  - setPoint2
```
public void setPoint2(RelAbsVector x,
                      RelAbsVector y,
                      RelAbsVector z)
```
    Sets the coordinates for the end point of the linear gradient vector.
    Each value can be a combination of absolute and relative value and is represented by a RelAbsVector object.
    The z value can be omitted. In that case it is set to 0.
    
    Parameters:
    
    x - x value of the end point of the linear gradient vector
    
    y - y value of the end point of the linear gradient vector
    
    z - z value of the end point of the linear gradient vector
  - setPoint2
```
public void setPoint2(RelAbsVector x,
                      RelAbsVector y)
```
    Sets the coordinates for the end point of the linear gradient vector.
    Each value can be a combination of absolute and relative value and is represented by a RelAbsVector object.
    The z value can be omitted. In that case it is set to 0.
    
    Parameters:
    
    x - x value of the end point of the linear gradient vector
    
    y - y value of the end point of the linear gradient vector
    
    z - z value of the end point of the linear gradient vector
  - getXPoint1
```
public RelAbsVector getXPoint1()
```
    Returns the x coordinate for the start point as a reference.
    
    Returns:
    
    RelAbsVector that represents the x value of the start point.
  - getYPoint1
```
public RelAbsVector getYPoint1()
```
    Returns the y coordinate for the start point as a reference.
    
    Returns:
    
    RelAbsVector that represents the y value of the start point.
  - getZPoint1
```
public RelAbsVector getZPoint1()
```
    Returns the z coordinate for the start point as a reference.
    
    Returns:
    
    RelAbsVector that represents the z value of the start point.
  - getXPoint2
```
public RelAbsVector getXPoint2()
```
    Returns the x coordinate for the end point as a reference.
    
    Returns:
    
    RelAbsVector that represents the x value of the start point.
  - getYPoint2
```
public RelAbsVector getYPoint2()
```
    Returns the y coordinate for the end point as a reference.
    
    Returns:
    
    RelAbsVector that represents the y value of the start point.
  - getZPoint2
```
public RelAbsVector getZPoint2()
```
    Returns the z coordinate for the end point as a reference.
    
    Returns:
    
    RelAbsVector that represents the z value of the start point.
  - cloneObject
```
public LinearGradient cloneObject()
```
    Creates and returns a deep copy of this LinearGradient object.
    
    Overrides:
    
    cloneObject in class GradientBase
    
    Returns:
    
    a (deep) copy of this LinearGradient object
  - getElementName
```
public java.lang.String getElementName()
```
    Returns the XML element name of this object.
    This is overridden by subclasses to return a string appropriate to the SBML component. For example, Model defines it as returning 'model', CompartmentType defines it as returning 'compartmentType', etc.
    
    Overrides:
    
    getElementName in class GradientBase
  - getTypeCode
```
public int getTypeCode()
```
    Returns the libSBML type code for this SBML object.
    LibSBML attaches an identifying code to every kind of SBML object. These are known as SBML type codes. In other languages, the set of type codes is stored in an enumeration in the Java language interface for libSBML, the type codes are defined as static integer constants in interface class libsbmlConstants. The names of the type codes all begin with the characters SBML_.
    
    Overrides:
    
    getTypeCode in class SBase
    
    Returns:
    
    the SBML type code for this object, or SBML_UNKNOWN (default).
    
    See Also:
    
    LinearGradient.getElementName()
  - toXML
```
public XMLNode toXML()
```
    Creates an XMLNode object from this LinearGradient object.
    
    Overrides:
    
    toXML in class GradientBase
    
    Returns:
    
    the XMLNode with the XML representation for the LinearGradient object.

Class LinearGradient

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

LinearGradient

LinearGradient

LinearGradient

LinearGradient

LinearGradient

LinearGradient

LinearGradient

LinearGradient

Method Detail

delete

setCoordinates

setCoordinates

setPoint1

setPoint1

setPoint2

setPoint2

getXPoint1

getYPoint1

getZPoint1

getXPoint2

getYPoint2

getZPoint2

cloneObject

getElementName

getTypeCode

toXML