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

In order to be able to represent smooth curves the Layout package defines the class CubicBezier. 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

Version:

$Rev: 1904 $

Author:

Nicolas Rodriguez, Andreas Dräger

See Also:

Serialized Form

Nested Class Summary

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

CurveSegment.Type

Field Summary

Fields

Modifier and Type	Field and Description
private Point	basePoint1
private Point	basePoint2
private static long	serialVersionUID Generated serial version identifier.

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

end, start

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CubicBezier	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
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) Returns true if and only if the given SBase has exactly the same properties like this SBase instance.
Point	getBasePoint1()
Point	getBasePoint2()
javax.swing.tree.TreeNode	getChildAt(int index)
int	getChildCount()
int	hashCode() Returns a hash code value for this SBase instance.
boolean	isSetBasePoint1()
boolean	isSetBasePoint2()
Point	removeBasePoint1()
Point	removeBasePoint2()
void	setBasePoint1(Point basePoint1) basePoint1 specifies represents the base point closer to the start point.
void	setBasePoint2(Point basePoint2)

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

createEnd, createEnd, createStart, createStart, getEnd, getStart, isSetEnd, isSetStart, setEnd, setStart, toString

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

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

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendNotes, appendNotes, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAllowsChildren, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, setAnnotation, setHistory, setLevel, setMetaId, setNamespace, setNotes, setNotes, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, 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, isLeaf, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet

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

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, isLeaf

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier.

See Also:

Constant Field Values

basePoint1

private Point basePoint1

basePoint2

private Point basePoint2

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()

Description copied from interface: SBase

Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.

Specified by:

clone in interface SBase

Overrides:

clone in class LineSegment

Returns:

a copy of this object

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)

Description copied from interface: SBase

Returns true if and only if the given SBase has exactly the same properties like this SBase instance.

Specified by:

equals in interface SBase

Overrides:

equals in class LineSegment

Parameters:

object - the SBase to be compared to.

Returns:

true if and only if the given Object is an instance of SBase that has exactly the same properties like this SBase instance.

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()

Description copied from interface: SBase

Returns a hash code value for this SBase instance.

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class LineSegment

Returns:

a hash code value for this SBase instance.

See Also:

Object.hashCode()

isSetBasePoint1

public boolean isSetBasePoint1()

Returns:

isSetBasePoint2

public boolean isSetBasePoint2()

Returns:

removeBasePoint1

public Point removeBasePoint1()

Returns:

removeBasePoint2

public Point removeBasePoint2()

Returns:

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 -