org.simbrain.network.gui.nodes

Class NeuronGroupNode

java.lang.Object

org.piccolo2d.PNode

org.simbrain.network.gui.nodes.NeuronGroupNode

All Implemented Interfaces:

java.awt.print.Printable, java.beans.PropertyChangeListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, GroupNode

Direct Known Subclasses:

CompetitiveGroupNode, SOMGroupNode

public class NeuronGroupNode
extends org.piccolo2d.PNode
implements GroupNode, java.beans.PropertyChangeListener

PNode representation of a group of neurons. Contains an interaction box and outlined objects (neuron nodes) as children. Compare SubnetworkNode.

Author:

Jeff Yoshimi

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	NeuronGroupNode.NeuronGroupInteractionBox Custom interaction box for Subnetwork node.
static class	NeuronGroupNode.Port

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

org.piccolo2d.PNode.PSceneGraphDelegate

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.swing.Action	clampNeuronsAction Action for clamping neurons
protected javax.swing.Action	removeAction Action for removing this group
protected javax.swing.Action	renameAction Action for editing the group name.
protected javax.swing.Action	testInputsAction Open a window for sending inputs to this neuron group.
protected javax.swing.Action	unclampNeuronsAction Action for unclamping neurons

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
NeuronGroupNode(NetworkPanel networkPanel, NeuronGroup group) Create a Neuron Group PNode.

Method Summary

Modifier and Type	Method and Description
void	addCustomMenuItem(javax.swing.JMenuItem item) Add a custom menu item to the list.
void	addNeuronNode(NeuronNode node) Add a neuron node to the group node.
java.util.HashMap<java.awt.geom.Point2D,SynapseGroupArrow>	generateTerminaMappings(java.util.Set<SynapseGroupArrow> synGroups)
javax.swing.JPopupMenu	getDefaultContextMenu() Returns default actions for a context menu.
java.awt.geom.Point2D	getDockingPoint(NeuronGroupNode.Port port, SynapseGroupArrow synGN)
java.util.HashMap<NeuronGroupNode.Port,java.util.HashMap<SynapseGroupArrow,java.awt.geom.Point2D>>	getDockingPorts()
NeuronGroupNode.NeuronGroupInteractionBox	getInteractionBox()
java.util.List<InteractionBox>	getInteractionBoxes() Returns a list of child interaction boxes, or null if it does not contain an interaction box.
NetworkPanel	getNetworkPanel()
NeuronGroup	getNeuronGroup() Get a reference to the underlying neuron group.
java.awt.geom.Point2D	getTerminus(SynapseGroupArrow synGN)
void	layoutChildren() Override PNode layoutChildren method in order to properly set the positions of children nodes.
void	offset(double dx, double dy)
void	propertyChange(java.beans.PropertyChangeEvent evt)
java.util.LinkedHashMap<java.awt.geom.Point2D,java.awt.geom.Point2D>	proposeMapping(java.util.List<java.awt.geom.Point2D> dockPoints, java.util.Set<SynapseGroupArrow> groups, NeuronGroupNode.Port port)
void	removeNeuronNode(NeuronNode node) Remove a neuron node from the group node.
void	removeSynapseDock(NeuronGroupNode.Port port, SynapseGroupArrow synGN)
protected void	setInteractionBox(NeuronGroupNode.NeuronGroupInteractionBox newBox) Set a custom interaction box.
java.util.LinkedHashMap<java.awt.geom.Point2D,java.awt.geom.Point2D>	untangle(java.util.LinkedHashMap<java.awt.geom.Point2D,java.awt.geom.Point2D> map, java.util.HashMap<java.awt.geom.Point2D,SynapseGroupArrow> terminaMap)
void	updateConstituentNodes() Update all pnode constituents of this group node to update their visible state (in the case of synapse group nodes, only do this if there are visible synapses).
void	updateSynapseNodePositions() Call update synapse node positions on all constituent neuron nodes.
void	updateText() Update the text in the interaction box.

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, internalUpdateBounds, intersects, invalidateFullBounds, invalidateLayout, invalidatePaint, isAncestorOf, isDescendentOf, isDescendentOfRoot, isOpaque, lerp, localToGlobal, localToGlobal, localToGlobal, localToParent, localToParent, localToParent, lower, lower, lowerBelow, lowerToBottom, lowerToBottom, paint, 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, toString, wait, wait, wait

Field Detail

renameAction

protected javax.swing.Action renameAction

Action for editing the group name.

removeAction

protected javax.swing.Action removeAction

Action for removing this group

clampNeuronsAction

protected javax.swing.Action clampNeuronsAction

Action for clamping neurons

unclampNeuronsAction

protected javax.swing.Action unclampNeuronsAction

Action for unclamping neurons

testInputsAction

protected javax.swing.Action testInputsAction

Open a window for sending inputs to this neuron group.

Constructor Detail

NeuronGroupNode

public NeuronGroupNode(NetworkPanel networkPanel,
                       NeuronGroup group)

Create a Neuron Group PNode.

Parameters:

networkPanel - parent panel

group - the neuron group

Method Detail

getDockingPorts

public java.util.HashMap<NeuronGroupNode.Port,java.util.HashMap<SynapseGroupArrow,java.awt.geom.Point2D>> getDockingPorts()

layoutChildren

public void layoutChildren()

Override PNode layoutChildren method in order to properly set the positions of children nodes.

Overrides:

layoutChildren in class org.piccolo2d.PNode

getNetworkPanel

public NetworkPanel getNetworkPanel()

Returns:

the networkPanel

getNeuronGroup

public NeuronGroup getNeuronGroup()

Get a reference to the underlying neuron group.

Returns:

reference to the neuron group.

addCustomMenuItem

public void addCustomMenuItem(javax.swing.JMenuItem item)

Add a custom menu item to the list.

Parameters:

item - the custom item to add

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

updateSynapseNodePositions

public void updateSynapseNodePositions()

Call update synapse node positions on all constituent neuron nodes. Ensures synapse nodes are updated properly when this is moved.

updateConstituentNodes

public void updateConstituentNodes()

Description copied from interface: GroupNode

Update all pnode constituents of this group node to update their visible state (in the case of synapse group nodes, only do this if there are visible synapses).

Specified by:

updateConstituentNodes in interface GroupNode

offset

public void offset(double dx,
                   double dy)

Overrides:

offset in class org.piccolo2d.PNode

addNeuronNode

public void addNeuronNode(NeuronNode node)

Add a neuron node to the group node.

Parameters:

node - to add

removeNeuronNode

public void removeNeuronNode(NeuronNode node)

Remove a neuron node from the group node.

Parameters:

node - to remove

getDefaultContextMenu

public javax.swing.JPopupMenu getDefaultContextMenu()

Returns default actions for a context menu.

Returns:

the default context menu

getInteractionBox

public NeuronGroupNode.NeuronGroupInteractionBox getInteractionBox()

Returns:

the interactionBox

setInteractionBox

protected void setInteractionBox(NeuronGroupNode.NeuronGroupInteractionBox newBox)

Set a custom interaction box.

Parameters:

newBox - the newBox to set.

updateText

public void updateText()

Update the text in the interaction box.

getDockingPoint

public java.awt.geom.Point2D getDockingPoint(NeuronGroupNode.Port port,
                                             SynapseGroupArrow synGN)

Parameters:

port -

synGN -

Returns:

proposeMapping

public java.util.LinkedHashMap<java.awt.geom.Point2D,java.awt.geom.Point2D> proposeMapping(java.util.List<java.awt.geom.Point2D> dockPoints,
                                                                                           java.util.Set<SynapseGroupArrow> groups,
                                                                                           NeuronGroupNode.Port port)

Parameters:

dockPoints -

groups -

port -

Returns:

untangle

public java.util.LinkedHashMap<java.awt.geom.Point2D,java.awt.geom.Point2D> untangle(java.util.LinkedHashMap<java.awt.geom.Point2D,java.awt.geom.Point2D> map,
                                                                                     java.util.HashMap<java.awt.geom.Point2D,SynapseGroupArrow> terminaMap)

Parameters:

map -

terminaMap -

Returns:

getTerminus

public java.awt.geom.Point2D getTerminus(SynapseGroupArrow synGN)

Parameters:

synGN -

Returns:

generateTerminaMappings

public java.util.HashMap<java.awt.geom.Point2D,SynapseGroupArrow> generateTerminaMappings(java.util.Set<SynapseGroupArrow> synGroups)

Parameters:

synGroups -

Returns:

removeSynapseDock

public void removeSynapseDock(NeuronGroupNode.Port port,
                              SynapseGroupArrow synGN)

getInteractionBoxes

public java.util.List<InteractionBox> getInteractionBoxes()

Description copied from interface: GroupNode

Returns a list of child interaction boxes, or null if it does not contain an interaction box. Note that this is not a recursive list of all interaction boxes below this one. Rather, some group nodes have multiple interaction boxes (currently just SynapseGroupNodeBidirectional).

Specified by:

getInteractionBoxes in interface GroupNode

Returns:

the node's interaction box