Package org.sbml.jsbml.ext.layout

Class CubicBezier

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.layout.CurveSegment

org.sbml.jsbml.ext.layout.LineSegment

org.sbml.jsbml.ext.layout.CubicBezier

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.TreeNode, SBase, TreeNodeWithChangeSupport

public class CubicBezier
extends LineSegment

Represents smooth curves in the Layout package.

It represents a Bezier curve, and is readily available in most graphics APIs. The class CubicBezier is derived from LineSegment. It consists of four elements: the two inherited elements 'start' and 'end', which specify the starting point and the endpoint of the cubic bezier curve, and two elements 'basePoint1' and 'basePoint2', which specify the two additional base points that are needed to describe a cubic bezier curve. These basepoints also allow tools that cannot render bezier curves to approximate them by directly connecting the four points.

Since:

1.0

Author:

Nicolas Rodriguez, Andreas Dräger, David Vetter

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.sbml.jsbml.ext.layout.CurveSegment

CurveSegment.Type

Field Summary

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements, JSBML_WRONG_SBO_TERM, packageName

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, resourceBundle

Constructor Summary

Constructors

Constructor	Description
CubicBezier()
CubicBezier(int level, int version)
CubicBezier(CubicBezier cubicBezier)

Method Summary

Modifier and Type	Method	Description
CubicBezier	clone()
Point	createBasePoint1()	Creates, sets and returns a Point
Point	createBasePoint1(double x, double y, double z)	Creates, sets and returns a Point based on the given values.
Point	createBasePoint2()	Creates, sets and returns a Point
Point	createBasePoint2(double x, double y, double z)	Creates, sets and returns a Point based on the given values.
boolean	equals(java.lang.Object object)
Point	getBasePoint1()
Point	getBasePoint2()
javax.swing.tree.TreeNode	getChildAt(int index)
int	getChildCount()
int	hashCode()
boolean	isSetBasePoint1()
boolean	isSetBasePoint2()
Point	removeBasePoint1()	Removes the basepoint 1 from this CubicBezier After calling this method, isSetBasePoint1() is false
Point	removeBasePoint2()	Removes the basepoint 2 from this CubicBezier After calling this method, isSetBasePoint2() is false
void	setBasePoint1(Point basePoint1)	basePoint1 specifies represents the base point closer to the start point.
void	setBasePoint2(Point basePoint2)
void	unsetBasePoint1()	Unsets the Base point 1 (and fires appropriate event)
void	unsetBasePoint2()	Unsets the Base point 2 (and fires appropriate event)

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, addResources, appendAnnotation, appendAnnotation, appendNotes, appendNotes, checkAndSetPackageNamespaceAndVersion, checkAndSetPackageNamespaceAndVersion, checkAttribute, checkIdentifier, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAllDeclaredNamespaces, getAllowsChildren, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getFirstElementIndex, getHistory, getId, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasExtension, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isIdMandatory, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, toString, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, unsetNamespace, unsetNotes, unsetPlugin, unsetSBOTerm

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, getRoot, getTreeNodeChangeListenerCount, getUserObject, indexOf, isCloningInProgress, isInvalidSBMLAllowed, isLeaf, isReadingInProgress, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet

Methods inherited from class org.sbml.jsbml.ext.layout.CurveSegment

getType, isCubicBezier, isLineSegment, isSetType, readAttribute, removeEnd, removeStart, writeXMLAttributes

Methods inherited from class org.sbml.jsbml.ext.layout.LineSegment

createEnd, createEnd, createStart, createStart, getEnd, getStart, isSetEnd, isSetStart, setEnd, setStart, unsetEnd, unsetStart

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.sbml.jsbml.SBase

removeTreeNodeChangeListener

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, isLeaf

Methods inherited from interface org.sbml.jsbml.util.TreeNodeWithChangeSupport

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet

Constructor Detail

CubicBezier

public CubicBezier()

CubicBezier

public CubicBezier(CubicBezier cubicBezier)

Parameters:

cubicBezier -

CubicBezier

public CubicBezier(int level,
                   int version)

Parameters:

level -

version -

Method Detail

clone

public CubicBezier clone()

Specified by:

clone in interface SBase

Overrides:

clone in class LineSegment

createBasePoint1

public Point createBasePoint1()

Creates, sets and returns a Point

Returns:

new Point object.

createBasePoint1

public Point createBasePoint1(double x,
                              double y,
                              double z)

Creates, sets and returns a Point based on the given values.

Parameters:

x -

y -

z -

Returns:

new Point object.

createBasePoint2

public Point createBasePoint2()

Creates, sets and returns a Point

Returns:

new Point object.

createBasePoint2

public Point createBasePoint2(double x,
                              double y,
                              double z)

Creates, sets and returns a Point based on the given values.

Parameters:

x -

y -

z -

Returns:

new Point object.

equals

public boolean equals(java.lang.Object object)

Specified by:

equals in interface SBase

Overrides:

equals in class LineSegment

getBasePoint1

public Point getBasePoint1()

Returns:

getBasePoint2

public Point getBasePoint2()

Returns:

getChildAt

public javax.swing.tree.TreeNode getChildAt(int index)

Specified by:

getChildAt in interface javax.swing.tree.TreeNode

Overrides:

getChildAt in class LineSegment

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface javax.swing.tree.TreeNode

Overrides:

getChildCount in class LineSegment

hashCode

public int hashCode()

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class LineSegment

isSetBasePoint1

public boolean isSetBasePoint1()

Returns:

isSetBasePoint2

public boolean isSetBasePoint2()

Returns:

removeBasePoint1

public Point removeBasePoint1()

Removes the basepoint 1 from this CubicBezier
After calling this method, isSetBasePoint1() is false

Returns:

The removed basepoint 1

removeBasePoint2

public Point removeBasePoint2()

Removes the basepoint 2 from this CubicBezier
After calling this method, isSetBasePoint2() is false

Returns:

The removed basepoint 2

setBasePoint1

public void setBasePoint1(Point basePoint1)

basePoint1 specifies represents the base point closer to the start point.

Parameters:

basePoint1 -

setBasePoint2

public void setBasePoint2(Point basePoint2)

Parameters:

basePoint2 -

unsetBasePoint1

public void unsetBasePoint1()

Unsets the Base point 1 (and fires appropriate event)

unsetBasePoint2

public void unsetBasePoint2()

Unsets the Base point 2 (and fires appropriate event)