BoundingBox (LibSBML Java API)

java.lang.Object
- org.sbml.libsbml.SBase
- - org.sbml.libsbml.BoundingBox

```
public class BoundingBox
extends SBase
```
layout A bounding box for an item in a diagram.

Constructor Summary

Constructors
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`

Method Summary

All Methods Instance Methods Concrete Methods
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.

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, 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

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

- Constructor Detail
  - BoundingBox
```
public BoundingBox(long level,
                   long version,
                   long pkgVersion)
            throws SBMLConstructorException
```
    Default Constructor set position and dimensions to (0.0,0.0,0.0) and the id to an empty string.
    
    Throws:
    
    SBMLConstructorException
  - BoundingBox
```
public BoundingBox(long level,
                   long version)
            throws SBMLConstructorException
```
    Default Constructor set position and dimensions to (0.0,0.0,0.0) and the id to an empty string.
    
    Throws:
    
    SBMLConstructorException
  - BoundingBox
```
public BoundingBox(long level)
            throws SBMLConstructorException
```
    Default Constructor set position and dimensions to (0.0,0.0,0.0) and the id to an empty string.
    
    Throws:
    
    SBMLConstructorException
  - BoundingBox
```
public BoundingBox()
            throws SBMLConstructorException
```
    Default Constructor set position and dimensions to (0.0,0.0,0.0) and the id to an empty string.
    
    Throws:
    
    SBMLConstructorException
  - BoundingBox
```
public BoundingBox(LayoutPkgNamespaces layoutns)
            throws SBMLConstructorException
```
    Creates a new BoundingBox object with the given LayoutPkgNamespaces object.
    
    Throws:
    
    SBMLConstructorException
  - BoundingBox
```
public BoundingBox(BoundingBox orig)
            throws SBMLConstructorException
```
    Copy constructor.
    
    Throws:
    
    SBMLConstructorException
  - BoundingBox
```
public BoundingBox(LayoutPkgNamespaces layoutns,
                   java.lang.String id)
            throws SBMLConstructorException
```
    Constructor set position and dimensions to (0.0,0.0,0.0) and the id to a copy of the given string.
    (FOR BACKWARD COMPATIBILITY)
    
    Throws:
    
    SBMLConstructorException
  - BoundingBox
```
public BoundingBox(LayoutPkgNamespaces layoutns,
                   java.lang.String id,
                   double x,
                   double y,
                   double width,
                   double height)
            throws SBMLConstructorException
```
    Constructor which sets the id, the coordinates and the dimensions to the given 2D values.
    (FOR BACKWARD COMPATIBILITY)
    
    Throws:
    
    SBMLConstructorException
  - BoundingBox
```
public BoundingBox(LayoutPkgNamespaces layoutns,
                   java.lang.String id,
                   double x,
                   double y,
                   double z,
                   double width,
                   double height,
                   double depth)
            throws SBMLConstructorException
```
    Constructor which sets the id, the coordinates and the dimensions to the given 3D values.
    (FOR BACKWARD COMPATIBILITY)
    
    Throws:
    
    SBMLConstructorException
  - BoundingBox
```
public BoundingBox(LayoutPkgNamespaces layoutns,
                   java.lang.String id,
                   Point p,
                   Dimensions d)
            throws SBMLConstructorException
```
    Constructor which sets the id, the coordinates and the dimensions to the given values.
    (FOR BACKWARD COMPATIBILITY)
    
    Throws:
    
    SBMLConstructorException
  - BoundingBox
```
public BoundingBox(XMLNode node,
                   long l2version)
            throws SBMLConstructorException
```
    Creates a new BoundingBox from the given XMLNode
    (FOR BACKWARD COMPATIBILITY)
    
    Throws:
    
    SBMLConstructorException
  - BoundingBox
```
public BoundingBox(XMLNode node)
            throws SBMLConstructorException
```
    Creates a new BoundingBox from the given XMLNode
    (FOR BACKWARD COMPATIBILITY)
    
    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 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.
    
    Overrides:
    
    delete in class SBase
  - getId
```
public java.lang.String getId()
```
    Returns the value of the 'id' attribute of this BoundingBox.
    
    Overrides:
    
    getId in class SBase
  - isSetId
```
public boolean isSetId()
```
    Predicate returning true or false depending on whether this BoundingBox's 'id' attribute has been set.
    
    Overrides:
    
    isSetId in class SBase
  - setId
```
public int setId(java.lang.String id)
```
    Sets the value of the 'id' attribute of this BoundingBox.
    
    Overrides:
    
    setId in class SBase
  - unsetId
```
public int unsetId()
```
    Unsets the value of the 'id' attribute of this BoundingBox.
    Overrides:
    
    unsetId in class SBase
    
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED
  - getPosition
```
public Point getPosition()
```
    Returns the position of the BoundingBox as referece to a Point object.
  - getDimensions
```
public Dimensions getDimensions()
```
    Returns the dimensions of the BoundingBox as referece to a Dimensions object.
  - setPosition
```
public void setPosition(Point p)
```
    Sets the position to a copy of the Point object given.
  - setDimensions
```
public void setDimensions(Dimensions d)
```
    Sets the dimensions to a copy of the Dimensions object given.
  - getDimensionsExplicitlySet
```
public boolean getDimensionsExplicitlySet()
```
    Return true or false based on whether Dimensions have been set
  - getPositionExplicitlySet
```
public boolean getPositionExplicitlySet()
```
    Return true or false based on whether Dimensions have been set
  - initDefaults
```
public void initDefaults()
```
    Does nothing yet since there are no defaults fo a BoundingBox.
  - x
```
public double x()
```
    Get the x offset of the bounding box.
  - y
```
public double y()
```
    Get the y offset of the bounding box.
  - z
```
public double z()
```
    Get the z offset of the bounding box.
  - width
```
public double width()
```
    Get the width of the bounding box.
  - height
```
public double height()
```
    Get the height of the bounding box.
  - depth
```
public double depth()
```
    Get the depth of the bounding box.
  - setX
```
public void setX(double x)
```
    Set x offset of the bounding box
  - setY
```
public void setY(double y)
```
    Set y offset of the bounding box
  - setZ
```
public void setZ(double z)
```
    Set z offset of the bounding box
  - setWidth
```
public void setWidth(double width)
```
    Set width of the bounding box
  - setHeight
```
public void setHeight(double height)
```
    Set height of the bounding box
  - setDepth
```
public void setDepth(double depth)
```
    Set depth of the bounding box
  - getElementName
```
public java.lang.String getElementName()
```
    Returns the XML element name of this SBML object.
    
    Overrides:
    
    getElementName in class SBase
    
    Returns:
    
    the string of the name of this element.
  - cloneObject
```
public BoundingBox cloneObject()
```
    Creates and returns a deep copy of this BoundingBox.
    
    Overrides:
    
    cloneObject in class SBase
    
    Returns:
    
    a (deep) copy of this BoundingBox.
  - getTypeCode
```
public int getTypeCode()
```
    Returns the libSBML type code of this object instance.
    
    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.
    
    Overrides:
    
    getTypeCode in class SBase
    
    Returns:
    
    the SBML type code for this object: SBML_LAYOUT_BOUNDINGBOX
    
    See Also:
    
    BoundingBox.getElementName(), SBase.getPackageName()
    
    "Warning:"
    
    The specific integer values of the possible type codes may be reused by different Level 3 package plug-ins. Thus, to identifiy the correct code, it is necessary to invoke both getTypeCode() and getPackageName().
  - toXML
```
public XMLNode toXML()
```
    Creates an XMLNode object from this.
  - connectToChild
```
public void connectToChild()
```
    Overrides:
    
    connectToChild in class SBase

Class BoundingBox

Constructor Summary

Method Summary

Methods inherited from class org.sbml.libsbml.SBase

Methods inherited from class java.lang.Object

Constructor Detail

BoundingBox

BoundingBox

BoundingBox

BoundingBox

BoundingBox

BoundingBox

BoundingBox

BoundingBox

BoundingBox

BoundingBox

BoundingBox

BoundingBox

Method Detail

delete

getId

isSetId

setId

unsetId

getPosition

getDimensions

setPosition

setDimensions

getDimensionsExplicitlySet

getPositionExplicitlySet

initDefaults

x

y

z

width

height

depth

setX

setY

setZ

setWidth

setHeight

setDepth

getElementName

cloneObject

getTypeCode

toXML

connectToChild