public class RenderCubicBezier extends RenderPoint
CubicBezier
representation for RenderCurve
objects and Polygon
objects.
The RenderCubicBezier
is derived from RenderPoint
and is the second element needed to
represent arbitrary curves with relative coordinates as they can appear in RenderCurves
and Polygon
objects.
In addition to the attributes inherited from RenderPoint
, RenderCubicBezier
has two additional
attributes for the two base points that define a cubic bezier curve.
Segments in a RenderCurve
or a Polygon
are always defined by two consecutive RenderPoint
or
RenderCubicBezier
elements. The first element in a list of RenderPoints has to be a RenderPoint
object, all following elements can either be RenderPoints or RenderCubicBezier
elements.
If the second element is a RenderPoint
, the two elements represent a straight line segement,
if the second element if a RenderCubicBezier
, the two elements represent a cubic bezier curve
segment.
For further details please have a look at the SBML render extension specification.
Constructor and Description |
---|
RenderCubicBezier()
Creates a new
RenderCubicBezier object with the given SBML level
and SBML version. |
RenderCubicBezier(long level)
Creates a new
RenderCubicBezier object with the given SBML level
and SBML version. |
RenderCubicBezier(long level,
long version)
Creates a new
RenderCubicBezier object with the given SBML level
and SBML version. |
RenderCubicBezier(long level,
long version,
long pkgVersion)
Creates a new
RenderCubicBezier object with the given SBML level
and SBML version. |
RenderCubicBezier(RenderCubicBezier orig)
Copy constructor for
RenderCubicBezier objects. |
RenderCubicBezier(RenderPkgNamespaces renderns)
Creates a new
RenderCubicBezier object with the given SBMLNamespaces . |
RenderCubicBezier(RenderPkgNamespaces renderns,
RelAbsVector bp1_x,
RelAbsVector bp1_y,
RelAbsVector bp1_z,
RelAbsVector bp2_x,
RelAbsVector bp2_y,
RelAbsVector bp2_z,
RelAbsVector end_x,
RelAbsVector end_y,
RelAbsVector end_z)
Creates a
CubicBezier with the given points. |
RenderCubicBezier(XMLNode node)
Creates a new
RenderCubicBezier object from the given XMLNode object. |
RenderCubicBezier(XMLNode node,
long l2version)
Creates a new
RenderCubicBezier object from the given XMLNode object. |
Modifier and Type | Method and Description |
---|---|
RelAbsVector |
basePoint1_X()
Returns the x value of the first base point of the curve (the one closer to the
starting point) as a reference.
|
RelAbsVector |
basePoint1_Y()
Returns the y value of the first base point of the curve (the one closer to the
starting point) as a reference.
|
RelAbsVector |
basePoint1_Z()
Returns the z value of the first base point of the curve (the one closer to the
starting point) as a reference.
|
RelAbsVector |
basePoint2_X()
Returns the x value of the second base point of the curve (the one further from the
starting point) as a reference.
|
RelAbsVector |
basePoint2_Y()
Returns the y value of the second base point of the curve (the one further from the
starting point) as a reference.
|
RelAbsVector |
basePoint2_Z()
Returns the z value of the second base point of the curve (the one further from the
starting point) as a reference.
|
RenderCubicBezier |
cloneObject()
Creates and returns a deep copy of the
RenderCubicBezier object. |
void |
delete()
Explicitly deletes the underlying native object.
|
java.lang.String |
getElementName()
Returns the XML element name of this object, which for
RenderCubicBezier , is always 'element'. |
int |
getTypeCode()
Returns the libSBML type code for the objects contained in this
ListOf
(i.e., ColorDefinition objects, if the list is non-empty). |
void |
setBasePoint1_X(RelAbsVector x)
Sets the x value of the first base point of the curve (the one closer to the
starting point).
|
void |
setBasePoint1_Y(RelAbsVector y)
Sets the y value of the first base point of the curve (the one closer to the
starting point).
|
void |
setBasePoint1_Z(RelAbsVector z)
Sets the z value of the first base point of the curve (the one closer to the
starting point).
|
void |
setBasePoint1(RelAbsVector x,
RelAbsVector y)
Sets the first basepoint to the given coordinatees.
|
void |
setBasePoint1(RelAbsVector x,
RelAbsVector y,
RelAbsVector z)
Sets the first basepoint to the given coordinatees.
|
void |
setBasePoint2_X(RelAbsVector x)
Sets the x value of the second base point of the curve (the one further from the
starting point).
|
void |
setBasePoint2_Y(RelAbsVector y)
Sets the y value of the second base point of the curve (the one further from the
starting point).
|
void |
setBasePoint2_Z(RelAbsVector z)
Sets the z value of the second base point of the curve (the one further from the
starting point).
|
void |
setBasePoint2(RelAbsVector x,
RelAbsVector y)
Sets the second basepoint to the given coordinatees.
|
void |
setBasePoint2(RelAbsVector x,
RelAbsVector y,
RelAbsVector z)
Sets the second basepoint to the given coordinatees.
|
XMLNode |
toXML(java.lang.String name)
Creates an
XMLNode object from this RenderCubicBezier object. |
initDefaults, setCoordinates, setCoordinates, setElementName, setOffsets, setOffsets, setX, setY, setZ, x, y, z
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, connectToChild, deleteDisabledPlugins, deleteDisabledPlugins, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getDisabledPlugin, getElementByMetaId, getElementBySId, getId, getIdAttribute, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getName, 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, isSetId, isSetIdAttribute, isSetMetaId, isSetModelHistory, isSetName, isSetNotes, isSetSBOTerm, isSetUserData, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeFromParentAndDelete, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setId, setIdAttribute, setMetaId, setModelHistory, setName, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetId, unsetIdAttribute, unsetMetaId, unsetModelHistory, unsetName, unsetNotes, unsetSBOTerm, unsetUserData
public RenderCubicBezier(long level, long version, long pkgVersion) throws SBMLConstructorException
RenderCubicBezier
object with the given SBML level
and SBML version.
level
- SBML level of the new objectlevel
- SBML version of the new objectSBMLConstructorException
public RenderCubicBezier(long level, long version) throws SBMLConstructorException
RenderCubicBezier
object with the given SBML level
and SBML version.
level
- SBML level of the new objectlevel
- SBML version of the new objectSBMLConstructorException
public RenderCubicBezier(long level) throws SBMLConstructorException
RenderCubicBezier
object with the given SBML level
and SBML version.
level
- SBML level of the new objectlevel
- SBML version of the new objectSBMLConstructorException
public RenderCubicBezier() throws SBMLConstructorException
RenderCubicBezier
object with the given SBML level
and SBML version.
level
- SBML level of the new objectlevel
- SBML version of the new objectSBMLConstructorException
public RenderCubicBezier(RenderPkgNamespaces renderns) throws SBMLConstructorException
RenderCubicBezier
object with the given SBMLNamespaces
.
sbmlns
- The SBML namespace for the object.SBMLConstructorException
public RenderCubicBezier(RenderCubicBezier orig) throws SBMLConstructorException
RenderCubicBezier
objects.SBMLConstructorException
public RenderCubicBezier(RenderPkgNamespaces renderns, RelAbsVector bp1_x, RelAbsVector bp1_y, RelAbsVector bp1_z, RelAbsVector bp2_x, RelAbsVector bp2_y, RelAbsVector bp2_z, RelAbsVector end_x, RelAbsVector end_y, RelAbsVector end_z) throws SBMLConstructorException
CubicBezier
with the given points.
bp1_x
- x coordinatee of the first base point.bp1_y
- y coordinatee of the first base point.bp1_z
- z coordinatee of the first base point.bp1_x
- x coordinatee of the second base point.bp1_y
- y coordinatee of the second base point.bp1_z
- z coordinatee of the second base point.bp1_x
- x coordinatee of the end point.bp1_y
- y coordinatee of the end point.bp1_z
- z coordinatee of the end point.SBMLConstructorException
public RenderCubicBezier(XMLNode node, long l2version) throws SBMLConstructorException
RenderCubicBezier
object from the given XMLNode
object.
The XMLNode
object has to contain a valid XML representation of a
RenderCubicBezier
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.
node
- the XMLNode
object reference that describes the RenderCubicBezier
object to be instantiated.SBMLConstructorException
public RenderCubicBezier(XMLNode node) throws SBMLConstructorException
RenderCubicBezier
object from the given XMLNode
object.
The XMLNode
object has to contain a valid XML representation of a
RenderCubicBezier
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.
node
- the XMLNode
object reference that describes the RenderCubicBezier
object to be instantiated.SBMLConstructorException
public void delete()
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 RenderCubicBezier.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 RenderCubicBezier.delete()
themselves.
delete
 in class RenderPoint
public RelAbsVector basePoint1_X()
public RelAbsVector basePoint1_Y()
public RelAbsVector basePoint1_Z()
public RelAbsVector basePoint2_X()
public RelAbsVector basePoint2_Y()
public RelAbsVector basePoint2_Z()
public void setBasePoint1_X(RelAbsVector x)
x
- x coordinate of first base point.public void setBasePoint1_Y(RelAbsVector y)
y
- y coordinate of first base point.public void setBasePoint1_Z(RelAbsVector z)
z
- z coordinate of first base point.public void setBasePoint2_X(RelAbsVector x)
x
- value of second base point.public void setBasePoint2_Y(RelAbsVector y)
y
- value of second base point.public void setBasePoint2_Z(RelAbsVector z)
z
- value of second base point.public void setBasePoint1(RelAbsVector x, RelAbsVector y, RelAbsVector z)
x
- coordinate of second base point.y
- coordinate of second base point.z
- coordinate of second base point.
If the z coodinate is omitted, it is set to 0.public void setBasePoint1(RelAbsVector x, RelAbsVector y)
x
- coordinate of second base point.y
- coordinate of second base point.z
- coordinate of second base point.
If the z coodinate is omitted, it is set to 0.public void setBasePoint2(RelAbsVector x, RelAbsVector y, RelAbsVector z)
x
- coordinate of second base point.y
- coordinate of second base point.z
- coordinate of second base point.
If the z coodinate is omitted, it is set to 0.public void setBasePoint2(RelAbsVector x, RelAbsVector y)
x
- coordinate of second base point.y
- coordinate of second base point.z
- coordinate of second base point.
If the z coodinate is omitted, it is set to 0.public java.lang.String getElementName()
RenderCubicBezier
, is always 'element'.
getElementName
 in class RenderPoint
'element'.
public RenderCubicBezier cloneObject()
RenderCubicBezier
object.
cloneObject
 in class RenderPoint
RenderCubicBezier
public int getTypeCode()
ListOf
(i.e., ColorDefinition
objects, if the list is non-empty).
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_.
getTypeCode
 in class RenderPoint
ListOf
instance, or SBML_UNKNOWN
(default).
RenderCubicBezier.getElementName()
public XMLNode toXML(java.lang.String name)
XMLNode
object from this RenderCubicBezier
object.
toXML
 in class RenderPoint
XMLNode
with the XML representation for the
RenderCubicBezier
object.