public class BoundingBox extends SBase
Constructor and Description |
---|
BoundingBox()
Default Constructor set position and dimensions to (0.0,0.0,0.0) and
the id to an empty string.
|
BoundingBox(BoundingBox orig)
Copy constructor.
|
BoundingBox(LayoutPkgNamespaces layoutns)
Creates a new
BoundingBox object with the given LayoutPkgNamespaces object. |
BoundingBox(LayoutPkgNamespaces layoutns,
java.lang.String id)
Constructor set position and dimensions to (0.0,0.0,0.0) and the id to
a copy of the given string.
|
BoundingBox(LayoutPkgNamespaces layoutns,
java.lang.String id,
double x,
double y,
double width,
double height)
Constructor which sets the id, the coordinates and the dimensions to
the given 2D values.
|
BoundingBox(LayoutPkgNamespaces layoutns,
java.lang.String id,
double x,
double y,
double z,
double width,
double height,
double depth)
Constructor which sets the id, the coordinates and the dimensions to
the given 3D values.
|
BoundingBox(LayoutPkgNamespaces layoutns,
java.lang.String id,
Point p,
Dimensions d)
Constructor which sets the id, the coordinates and the dimensions to
the given values.
|
BoundingBox(long level)
Default Constructor set position and dimensions to (0.0,0.0,0.0) and
the id to an empty string.
|
BoundingBox(long level,
long version)
Default Constructor set position and dimensions to (0.0,0.0,0.0) and
the id to an empty string.
|
BoundingBox(long level,
long version,
long pkgVersion)
Default Constructor set position and dimensions to (0.0,0.0,0.0) and
the id to an empty string.
|
BoundingBox(XMLNode node)
Creates a new
BoundingBox from the given XMLNode |
BoundingBox(XMLNode node,
long l2version)
Creates a new
BoundingBox from the given XMLNode |
Modifier and Type | Method and Description |
---|---|
BoundingBox |
cloneObject()
Creates and returns a deep copy of this
BoundingBox . |
void |
connectToChild()   |
void |
delete()
Explicitly deletes the underlying native object.
|
double |
depth()
Get the depth of the bounding box.
|
Dimensions |
getDimensions()
Returns the dimensions of the
BoundingBox as referece to a Dimensions
object. |
boolean |
getDimensionsExplicitlySet()
Return true or false based on whether
Dimensions have been set |
java.lang.String |
getElementName()
Returns the XML element name of
this SBML object.
|
java.lang.String |
getId()
Returns the value of the 'id' attribute of this
BoundingBox . |
Point |
getPosition()
Returns the position of the
BoundingBox as referece to a Point object. |
boolean |
getPositionExplicitlySet()
Return true or false based on whether
Dimensions have been set |
int |
getTypeCode()
Returns the libSBML type code of this object instance.
|
double |
height()
Get the height of the bounding box.
|
void |
initDefaults()
Does nothing yet since there are no defaults fo a
BoundingBox . |
boolean |
isSetId()
Predicate returning
true or false depending on whether this
BoundingBox 's 'id' attribute has been set. |
void |
setDepth(double depth)
Set depth of the bounding box
|
void |
setDimensions(Dimensions d)
Sets the dimensions to a copy of the
Dimensions object given. |
void |
setHeight(double height)
Set height of the bounding box
|
int |
setId(java.lang.String id)
Sets the value of the 'id' attribute of this
BoundingBox . |
void |
setPosition(Point p)
Sets the position to a copy of the
Point object given. |
void |
setWidth(double width)
Set width of the bounding box
|
void |
setX(double x)
Set x offset of the bounding box
|
void |
setY(double y)
Set y offset of the bounding box
|
void |
setZ(double z)
Set z offset of the bounding box
|
XMLNode |
toXML()
Creates an
XMLNode object from this. |
int |
unsetId()
Unsets the value of the 'id' attribute of this
BoundingBox . |
double |
width()
Get the width of the bounding box.
|
double |
x()
Get the x offset of the bounding box.
|
double |
y()
Get the y offset of the bounding box.
|
double |
z()
Get the z offset of the bounding box.
|
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, 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, unsetMetaId, unsetModelHistory, unsetName, unsetNotes, unsetSBOTerm, unsetUserData
public BoundingBox(long level, long version, long pkgVersion) throws SBMLConstructorException
SBMLConstructorException
public BoundingBox(long level, long version) throws SBMLConstructorException
SBMLConstructorException
public BoundingBox(long level) throws SBMLConstructorException
SBMLConstructorException
public BoundingBox() throws SBMLConstructorException
SBMLConstructorException
public BoundingBox(LayoutPkgNamespaces layoutns) throws SBMLConstructorException
BoundingBox
object with the given LayoutPkgNamespaces
object.SBMLConstructorException
public BoundingBox(BoundingBox orig) throws SBMLConstructorException
SBMLConstructorException
public BoundingBox(LayoutPkgNamespaces layoutns, java.lang.String id) throws SBMLConstructorException
(FOR BACKWARD COMPATIBILITY)
SBMLConstructorException
public BoundingBox(LayoutPkgNamespaces layoutns, java.lang.String id, double x, double y, double width, double height) throws SBMLConstructorException
(FOR BACKWARD COMPATIBILITY)
SBMLConstructorException
public BoundingBox(LayoutPkgNamespaces layoutns, java.lang.String id, double x, double y, double z, double width, double height, double depth) throws SBMLConstructorException
(FOR BACKWARD COMPATIBILITY)
SBMLConstructorException
public BoundingBox(LayoutPkgNamespaces layoutns, java.lang.String id, Point p, Dimensions d) throws SBMLConstructorException
(FOR BACKWARD COMPATIBILITY)
SBMLConstructorException
public BoundingBox(XMLNode node, long l2version) throws SBMLConstructorException
SBMLConstructorException
public BoundingBox(XMLNode node) throws SBMLConstructorException
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 BoundingBox.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 BoundingBox.delete()
themselves.
public java.lang.String getId()
BoundingBox
.public boolean isSetId()
true
or false
depending on whether this
BoundingBox
's 'id' attribute has been set.public int setId(java.lang.String id)
BoundingBox
.public int unsetId()
BoundingBox
.public Point getPosition()
BoundingBox
as referece to a Point
object.public Dimensions getDimensions()
BoundingBox
as referece to a Dimensions
object.public void setPosition(Point p)
Point
object given.public void setDimensions(Dimensions d)
Dimensions
object given.public boolean getDimensionsExplicitlySet()
Dimensions
have been setpublic boolean getPositionExplicitlySet()
Dimensions
have been setpublic void initDefaults()
BoundingBox
.public double x()
public double y()
public double z()
public double width()
public double height()
public double depth()
public void setX(double x)
public void setY(double y)
public void setZ(double z)
public void setWidth(double width)
public void setHeight(double height)
public void setDepth(double depth)
public java.lang.String getElementName()
getElementName
 in class SBase
public BoundingBox cloneObject()
BoundingBox
.
cloneObject
 in class SBase
BoundingBox
.public int getTypeCode()
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 getPackageName()
method on the object.
getTypeCode
 in class SBase
SBML_LAYOUT_BOUNDINGBOX
BoundingBox.getElementName()
,
SBase.getPackageName()
public void connectToChild()
connectToChild
 in class SBase