org.simbrain.network.gui.nodes

Class SynapseNode

java.lang.Object

org.piccolo2d.PNode

org.piccolo2d.nodes.PShape

org.piccolo2d.nodes.PPath

org.piccolo2d.nodes.PPath.Float

org.simbrain.network.gui.nodes.ScreenElement

org.simbrain.network.gui.nodes.SynapseNode

All Implemented Interfaces:

java.awt.print.Printable, java.io.Serializable, java.lang.Cloneable

public final class SynapseNode
extends ScreenElement

SynapseNode is a Piccolo PNode corresponding to a Neuron in the neural network model.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.piccolo2d.nodes.PPath

org.piccolo2d.nodes.PPath.Double, org.piccolo2d.nodes.PPath.Float

Nested classes/interfaces inherited from class org.piccolo2d.PNode

org.piccolo2d.PNode.PSceneGraphDelegate

Field Summary

Fields inherited from class org.piccolo2d.nodes.PShape

DEFAULT_PAINT, DEFAULT_STROKE, DEFAULT_STROKE_PAINT

Fields inherited from class org.piccolo2d.PNode

FILL_STRATEGY_ASPECT_COVER, FILL_STRATEGY_ASPECT_FIT, FILL_STRATEGY_EXACT_FIT, PROPERTY_BOUNDS, PROPERTY_CHILDREN, PROPERTY_CHILDREN_PICKABLE, PROPERTY_CLIENT_PROPERTIES, PROPERTY_CODE_BOUNDS, PROPERTY_CODE_CHILDREN, PROPERTY_CODE_CHILDREN_PICKABLE, PROPERTY_CODE_CLIENT_PROPERTIES, PROPERTY_CODE_FULL_BOUNDS, PROPERTY_CODE_PAINT, PROPERTY_CODE_PARENT, PROPERTY_CODE_PICKABLE, PROPERTY_CODE_TRANSFORM, PROPERTY_CODE_TRANSPARENCY, PROPERTY_CODE_VISIBLE, PROPERTY_FULL_BOUNDS, PROPERTY_PAINT, PROPERTY_PARENT, PROPERTY_PICKABLE, PROPERTY_TRANSFORM, PROPERTY_TRANSPARENCY, PROPERTY_VISIBLE, SCENE_GRAPH_DELEGATE

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Constructor Summary

Constructors

Constructor and Description
SynapseNode(NetworkPanel net, NeuronNode source, NeuronNode target, Synapse synapse) Create a new synapse node connecting a source and target neuron.

Method Summary

Modifier and Type	Method and Description
java.awt.geom.Point2D	calcCenter(java.awt.geom.Point2D src, java.awt.geom.Point2D tar) Calculates the position of the synapse circle based on the positions of the source and target NeuronNodes.
protected javax.swing.JPopupMenu	getContextMenu() Return a context menu specific to this screen element.
static java.awt.Color	getExcitatoryColor()
static java.awt.Color	getInhibitoryColor()
java.awt.geom.Line2D.Double	getLine()
static java.awt.Color	getLineColor()
static int	getMaxDiameter()
static int	getMinDiameter()
protected javax.swing.JDialog	getPropertyDialog() Return a property dialog for this screen element.
NeuronNode	getSource()
Synapse	getSynapse()
NeuronNode	getTarget()
protected java.lang.String	getToolTipText() Return a String to use as tool tip text for this screen element.
static java.awt.Color	getZeroWeightColor()
boolean	hasContextMenu() Return true if this screen element has a context menu.
protected boolean	hasPropertyDialog() Return true if this screen element has a property dialog.
protected boolean	hasToolTipText() Return true if this screen element has tool tip text.
boolean	isDraggable() Return true if this screen element is draggable.
boolean	isSelectable() Return true if this screen element is selectable.
void	resetColors() Reset colors when default colors have been changed in NetworkPreferences.
static void	setExcitatoryColor(java.awt.Color excitatoryColor)
static void	setInhibitoryColor(java.awt.Color inhibitoryColor)
static void	setLineColor(java.awt.Color lineColor)
static void	setMaxDiameter(int maxDiameter)
static void	setMinDiameter(int minDiameter)
void	setSource(NeuronNode source)
void	setSynapse(Synapse synapse)
void	setTarget(NeuronNode target)
static void	setZeroWeightColor(java.awt.Color zeroWeightColor)
boolean	showSelectionHandle() Return true if this screen element should show a selection handle.
java.lang.String	toString() Returns String representation of this NeuronNode.
void	updateColor() Calculates the color for a weight, based on its current strength.
void	updateDiameter() Update the diameter of the drawn weight based on the logical weight's strength.
void	updatePosition() Update position of synapse.

Methods inherited from class org.simbrain.network.gui.nodes.ScreenElement

getNetworkPanel, isGrouped, setGrouped, setNetworkPanel, singleClickEvent

Methods inherited from class org.piccolo2d.nodes.PPath

append, append, closePath, createArc, createArc, createCubicCurve, createCubicCurve, createEllipse, createEllipse, createLine, createLine, createQuadCurve, createQuadCurve, createRectangle, createRectangle, createRoundRectangle, createRoundRectangle, curveTo, getPath, getPathReference, getShape, lineTo, moveTo, quadTo, reset, transform

Methods inherited from class org.piccolo2d.nodes.PShape

getBoundsWithStroke, getStroke, getStrokePaint, internalUpdateBounds, intersects, paint, setStroke, setStrokePaint, updateBoundsFromShape

Methods inherited from class org.piccolo2d.PNode

addActivity, addAttribute, addChild, addChild, addChildren, addInputEventListener, addPropertyChangeListener, addPropertyChangeListener, animateToBounds, animateToColor, animateToPositionScaleRotation, animateToRelativePosition, animateToTransform, animateToTransparency, animateTransformToBounds, centerBoundsOnPoint, centerFullBoundsOnPoint, clone, computeFullBounds, endResizeBounds, findIntersectingNodes, fireChildPropertyChange, firePropertyChange, fullIntersects, fullPaint, fullPick, getAllNodes, getAllNodes, getAttribute, getAttribute, getBooleanAttribute, getBounds, getBoundsChanged, getBoundsReference, getBoundsVolatile, getChild, getChildBoundsInvalid, getChildBoundsVolatile, getChildPaintInvalid, getChildrenCount, getChildrenIterator, getChildrenPickable, getChildrenReference, getClientProperties, getClientPropertyKeysEnumeration, getDoubleAttribute, getFullBounds, getFullBoundsInvalid, getFullBoundsReference, getGlobalBounds, getGlobalFullBounds, getGlobalRotation, getGlobalScale, getGlobalToLocalTransform, getGlobalTranslation, getHeight, getInputEventListeners, getIntegerAttribute, getInverseTransform, getListenerList, getLocalToGlobalTransform, getName, getOccluded, getOffset, getPaint, getPaintInvalid, getParent, getPickable, getPropertyChangeParentMask, getRoot, getRotation, getScale, getTransform, getTransformReference, getTransparency, getUnionOfChildrenBounds, getVisible, getWidth, getX, getXOffset, getY, getYOffset, globalToLocal, globalToLocal, globalToLocal, indexOfChild, invalidateFullBounds, invalidateLayout, invalidatePaint, isAncestorOf, isDescendentOf, isDescendentOfRoot, isOpaque, layoutChildren, lerp, localToGlobal, localToGlobal, localToGlobal, localToParent, localToParent, localToParent, lower, lower, lowerBelow, lowerToBottom, lowerToBottom, offset, paintAfterChildren, parentBoundsChanged, parentToLocal, parentToLocal, parentToLocal, pick, pickAfterChildren, print, print, raise, raise, raiseAbove, raiseToTop, raiseToTop, removeAllChildren, removeChild, removeChild, removeChildren, removeFromParent, removeInputEventListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaintFrom, reparent, replaceWith, resetBounds, rotate, rotateAboutPoint, rotateAboutPoint, rotateInPlace, scale, scaleAboutPoint, scaleAboutPoint, setBounds, setBounds, setBoundsChanged, setChildBoundsInvalid, setChildBoundsVolatile, setChildPaintInvalid, setChildrenPickable, setFullBoundsInvalid, setGlobalRotation, setGlobalScale, setGlobalTranslation, setHeight, setName, setOccluded, setOffset, setOffset, setPaint, setPaintInvalid, setParent, setPickable, setPropertyChangeParentMask, setRotation, setScale, setTransform, setTransparency, setVisible, setWidth, setX, setY, signalBoundsChanged, startResizeBounds, toImage, toImage, toImage, toImage, transformBy, translate, validateFullBounds, validateFullPaint

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SynapseNode

public SynapseNode(NetworkPanel net,
                   NeuronNode source,
                   NeuronNode target,
                   Synapse synapse)

Create a new synapse node connecting a source and target neuron.

Parameters:

net - Reference to NetworkPanel

source - source neuronnode

target - target neuronmode

synapse - the model synapse this PNode represents

Method Detail

updatePosition

public void updatePosition()

Update position of synapse.

updateColor

public void updateColor()

Calculates the color for a weight, based on its current strength. Positive values are (for example) red, negative values blue.

updateDiameter

public void updateDiameter()

Update the diameter of the drawn weight based on the logical weight's strength.

calcCenter

public java.awt.geom.Point2D calcCenter(java.awt.geom.Point2D src,
                                        java.awt.geom.Point2D tar)

Calculates the position of the synapse circle based on the positions of the source and target NeuronNodes.

Parameters:

src - Source NeuronNode

tar - Target NeuronNode

Returns:

the appropriate position for the synapse circle

isSelectable

public boolean isSelectable()

Description copied from class: ScreenElement

Return true if this screen element is selectable.

Being selectable requires that this screen element is pickable as far as the Piccolo API is concerned, so if this method returns true , be sure that this class also returns true for its getPickable() method.

Specified by:

isSelectable in class ScreenElement

Returns:

See Also:

ScreenElement

showSelectionHandle

public boolean showSelectionHandle()

Description copied from class: ScreenElement

Return true if this screen element should show a selection handle.

Showing a selection handle requires that this screen element is pickable as far as the Piccolo API is concerned, so if this method returns true, be sure that this class also returns true for its getPickable() method.

Showing a selection handle also requires that this screen element is selectable, so if this method returns true, be sure that this class also returns true for its isSelectable() method.

Specified by:

showSelectionHandle in class ScreenElement

Returns:

See Also:

ScreenElement

isDraggable

public boolean isDraggable()

Description copied from class: ScreenElement

Return true if this screen element is draggable.

Being draggable requires that this screen element is pickable as far as the Piccolo API is concerned, so if this method returns true , be sure that this class also returns true for its getPickable() method.

Being draggable also requires that this screen element is selectable, so if this method returns true, be sure that this class also returns true for its isSelectable() method.

Specified by:

isDraggable in class ScreenElement

Returns:

See Also:

ScreenElement

hasToolTipText

protected boolean hasToolTipText()

Description copied from class: ScreenElement

Return true if this screen element has tool tip text. If this screen element does not have tool tip text, a tool tip event handler will not be registered.

Specified by:

hasToolTipText in class ScreenElement

Returns:

true if this screen element has tool tip text

See Also:

ScreenElement

getToolTipText

protected java.lang.String getToolTipText()

Description copied from class: ScreenElement

Return a String to use as tool tip text for this screen element. Return null if this screen element does not have tool tip text or to temporarily prevent the tool tip from displaying.

Specified by:

getToolTipText in class ScreenElement

Returns:

a String to use as tool tip text for this screen element

See Also:

ScreenElement

hasContextMenu

public boolean hasContextMenu()

Description copied from class: ScreenElement

Return true if this screen element has a context menu. If this screen element does not have a context menu, a context menu event handler will not be registered.

Specified by:

hasContextMenu in class ScreenElement

Returns:

See Also:

ScreenElement

getContextMenu

protected javax.swing.JPopupMenu getContextMenu()

Description copied from class: ScreenElement

Return a context menu specific to this screen element. Return null if this screen element does not have a context menu.

Specified by:

getContextMenu in class ScreenElement

Returns:

a context menu specific to this screen element

See Also:

ScreenElement

hasPropertyDialog

protected boolean hasPropertyDialog()

Description copied from class: ScreenElement

Return true if this screen element has a property dialog. If this screen element does not have a property dialog, a property dialog event handler will not be registered.

Specified by:

hasPropertyDialog in class ScreenElement

Returns:

true if this screen element has a property dialog

See Also:

ScreenElement

getPropertyDialog

protected javax.swing.JDialog getPropertyDialog()

Description copied from class: ScreenElement

Return a property dialog for this screen element. Return null if this screen element does not have a property dialog.

Specified by:

getPropertyDialog in class ScreenElement

Returns:

a property dialog for this screen element

See Also:

ScreenElement

toString

public java.lang.String toString()

Returns String representation of this NeuronNode.

Overrides:

toString in class java.lang.Object

Returns:

String representation of this node.

getSynapse

public Synapse getSynapse()

Returns:

Returns the synapse.

setSynapse

public void setSynapse(Synapse synapse)

Parameters:

synapse - The synapse to set.

getSource

public NeuronNode getSource()

Returns:

Returns the source.

getTarget

public NeuronNode getTarget()

Returns:

Returns the target.

setSource

public void setSource(NeuronNode source)

Parameters:

source - The source to set.

setTarget

public void setTarget(NeuronNode target)

Parameters:

target - The target to set.

resetColors

public void resetColors()

Description copied from class: ScreenElement

Reset colors when default colors have been changed in NetworkPreferences.

Specified by:

resetColors in class ScreenElement

See Also:

ScreenElement

getLine

public java.awt.geom.Line2D.Double getLine()

Returns:

the publicLine

getExcitatoryColor

public static java.awt.Color getExcitatoryColor()

Returns:

the excitatoryColor

setExcitatoryColor

public static void setExcitatoryColor(java.awt.Color excitatoryColor)

Parameters:

excitatoryColor - the excitatoryColor to set

getInhibitoryColor

public static java.awt.Color getInhibitoryColor()

Returns:

the inhibitoryColor

setInhibitoryColor

public static void setInhibitoryColor(java.awt.Color inhibitoryColor)

Parameters:

inhibitoryColor - the inhibitoryColor to set

getZeroWeightColor

public static java.awt.Color getZeroWeightColor()

Returns:

the zeroWeightColor

setZeroWeightColor

public static void setZeroWeightColor(java.awt.Color zeroWeightColor)

Parameters:

zeroWeightColor - the zeroWeightColor to set

getMaxDiameter

public static int getMaxDiameter()

Returns:

the maxDiameter

setMaxDiameter

public static void setMaxDiameter(int maxDiameter)

Parameters:

maxDiameter - the maxDiameter to set

getMinDiameter

public static int getMinDiameter()

Returns:

the minDiameter

setMinDiameter

public static void setMinDiameter(int minDiameter)

Parameters:

minDiameter - the minDiameter to set

getLineColor

public static java.awt.Color getLineColor()

Returns:

the lineColor

setLineColor

public static void setLineColor(java.awt.Color lineColor)

Parameters:

lineColor - the lineColor to set