public class RenderPoint extends SBase
RenderPoint
and the RenderCubicBezier
class in the render extension.
Those two classes are used to specify curve and polygon elements (@see RenderCurve or @see Polygon).
RelAbsVector)
Constructor and Description |
---|
RenderPoint()
Creates a new
RenderPoint object with the given SBML level
and SBML version. |
RenderPoint(long level)
Creates a new
RenderPoint object with the given SBML level
and SBML version. |
RenderPoint(long level,
long version)
Creates a new
RenderPoint object with the given SBML level
and SBML version. |
RenderPoint(long level,
long version,
long pkgVersion)
Creates a new
RenderPoint object with the given SBML level
and SBML version. |
RenderPoint(RenderPkgNamespaces renderns)
Creates a new
RenderPoint object with the given SBMLNamespaces . |
RenderPoint(RenderPkgNamespaces renderns,
RelAbsVector x,
RelAbsVector y)
Creates a new point with the given ccordinates.
|
RenderPoint(RenderPkgNamespaces renderns,
RelAbsVector x,
RelAbsVector y,
RelAbsVector z)
Creates a new point with the given ccordinates.
|
RenderPoint(RenderPoint orig)
Copy constructor for
RenderPoint objects. |
RenderPoint(XMLNode node)
Creates a new
RenderPoint object from the given XMLNode object. |
RenderPoint(XMLNode node,
long l2version)
Creates a new
RenderPoint object from the given XMLNode object. |
Modifier and Type | Method and Description |
---|---|
RenderPoint |
cloneObject()
Creates and returns a deep copy of this
RenderPoint object. |
void |
delete()
Explicitly deletes the underlying native object.
|
java.lang.String |
getElementName()
Returns the XML element name of this object, which for
RenderPoint , depends on the context. |
int |
getTypeCode()
Returns the libSBML type code for this SBML object.
|
void |
initDefaults()
Sets the Z offset to 0.0.
|
void |
setCoordinates(RelAbsVector x,
RelAbsVector y)
Sets the coordinates of the
RenderPoint to the given values. |
void |
setCoordinates(RelAbsVector x,
RelAbsVector y,
RelAbsVector z)
Sets the coordinates of the
RenderPoint to the given values. |
void |
setElementName(java.lang.String name)
Sets the element name which is returned by getElementName.
|
void |
setOffsets(RelAbsVector x,
RelAbsVector y)
Sets the coordinates of the
RenderPoint to the given values. |
void |
setOffsets(RelAbsVector x,
RelAbsVector y,
RelAbsVector z)
Sets the coordinates of the
RenderPoint to the given values. |
void |
setX(RelAbsVector x)
Sets the x ccordiante of the
RenderPoint object. |
void |
setY(RelAbsVector y)
Sets the y ccordiante of the
RenderPoint object. |
void |
setZ(RelAbsVector z)
Sets the z ccordiante of the
RenderPoint object. |
XMLNode |
toXML(java.lang.String name)
Creates an
XMLNode object from this ColorDefinition object. |
RelAbsVector |
x()
Returns the x coordinate of the
RenderPoint as a reference. |
RelAbsVector |
y()
Returns the y coordinate of the
RenderPoint as a reference. |
RelAbsVector |
z()
Returns the z coordinate of the
RenderPoint as a reference. |
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, connectToChild, deleteDisabledPlugins, deleteDisabledPlugins, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getDisabledPlugin, getElementByMetaId, getElementBySId, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumDisabledPlugins, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getPlugin, getPrefix, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getURI, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetMetaId, isSetModelHistory, isSetNotes, isSetSBOTerm, isSetUserData, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeFromParentAndDelete, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setMetaId, setModelHistory, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetId, unsetMetaId, unsetModelHistory, unsetName, unsetNotes, unsetSBOTerm, unsetUserData
public RenderPoint(long level, long version, long pkgVersion) throws SBMLConstructorException
RenderPoint
object with the given SBML level
and SBML version.
level
- SBML level of the new objectlevel
- SBML version of the new objectSBMLConstructorException
public RenderPoint(long level, long version) throws SBMLConstructorException
RenderPoint
object with the given SBML level
and SBML version.
level
- SBML level of the new objectlevel
- SBML version of the new objectSBMLConstructorException
public RenderPoint(long level) throws SBMLConstructorException
RenderPoint
object with the given SBML level
and SBML version.
level
- SBML level of the new objectlevel
- SBML version of the new objectSBMLConstructorException
public RenderPoint() throws SBMLConstructorException
RenderPoint
object with the given SBML level
and SBML version.
level
- SBML level of the new objectlevel
- SBML version of the new objectSBMLConstructorException
public RenderPoint(RenderPkgNamespaces renderns) throws SBMLConstructorException
RenderPoint
object with the given SBMLNamespaces
.
sbmlns
- The SBML namespace for the object.SBMLConstructorException
public RenderPoint(RenderPoint orig) throws SBMLConstructorException
RenderPoint
objects.SBMLConstructorException
public RenderPoint(RenderPkgNamespaces renderns, RelAbsVector x, RelAbsVector y, RelAbsVector z) throws SBMLConstructorException
x
- x coordinate of the RenderPoint
objecty
- y coordinate of the RenderPoint
objectz
- z coordinate of the RenderPoint
object
If the z value is omitted, it is set to 0.SBMLConstructorException
public RenderPoint(RenderPkgNamespaces renderns, RelAbsVector x, RelAbsVector y) throws SBMLConstructorException
x
- x coordinate of the RenderPoint
objecty
- y coordinate of the RenderPoint
objectz
- z coordinate of the RenderPoint
object
If the z value is omitted, it is set to 0.SBMLConstructorException
public RenderPoint(XMLNode node, long l2version) throws SBMLConstructorException
RenderPoint
object from the given XMLNode
object.
The XMLNode
object has to contain a valid XML representation of a
RenderPoint
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 RenderPoint
object to be instantiated.SBMLConstructorException
public RenderPoint(XMLNode node) throws SBMLConstructorException
RenderPoint
object from the given XMLNode
object.
The XMLNode
object has to contain a valid XML representation of a
RenderPoint
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 RenderPoint
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 RenderPoint.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 RenderPoint.delete()
themselves.
public RelAbsVector x()
RenderPoint
as a reference.
public RelAbsVector y()
RenderPoint
as a reference.
public RelAbsVector z()
RenderPoint
as a reference.
public void setX(RelAbsVector x)
RenderPoint
object.
x
- x coordinate to be set.public void setY(RelAbsVector y)
RenderPoint
object.
y
- y coordinate to be set.public void setZ(RelAbsVector z)
RenderPoint
object.
z
- z coordinate to be set.public void setCoordinates(RelAbsVector x, RelAbsVector y, RelAbsVector z)
RenderPoint
to the given values.
x
- x coordinate to be set.y
- y coordinate to be set.z
- z coordinate to be set. If the z coordinate is omitted, it is set to 0.public void setCoordinates(RelAbsVector x, RelAbsVector y)
RenderPoint
to the given values.
x
- x coordinate to be set.y
- y coordinate to be set.z
- z coordinate to be set. If the z coordinate is omitted, it is set to 0.public void setOffsets(RelAbsVector x, RelAbsVector y, RelAbsVector z)
RenderPoint
to the given values.
This method is deprecated, please use setCoordinates.
x
- x coordinate to be set.y
- y coordinate to be set.z
- z coordinate to be set. If the z coordinate is omitted, it is set to 0.public void setOffsets(RelAbsVector x, RelAbsVector y)
RenderPoint
to the given values.
This method is deprecated, please use setCoordinates.
x
- x coordinate to be set.y
- y coordinate to be set.z
- z coordinate to be set. If the z coordinate is omitted, it is set to 0.public void initDefaults()
public void setElementName(java.lang.String name)
RenderPoint
objects can have different element names depending on context.
name
- the string with the element name to be set.public java.lang.String getElementName()
RenderPoint
, depends on the context.
The name that is returned has to be set with
setElementName.
getElementName
 in class SBase
public RenderPoint cloneObject()
RenderPoint
object.
cloneObject
 in class SBase
RenderPoint
objectpublic int getTypeCode()
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 SBase
SBML_UNKNOWN
(default).
RenderPoint.getElementName()
public XMLNode toXML(java.lang.String name)
XMLNode
object from this ColorDefinition
object.
XMLNode
with the XML representation for the
ColorDefinition
object.