org.simbrain.network.layouts

Class LineLayout

java.lang.Object

org.simbrain.network.layouts.LineLayout

All Implemented Interfaces:

Layout

public class LineLayout
extends java.lang.Object
implements Layout

Lay neurons out in a line.

Author:

jyoshimi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LineLayout.LineOrientation Orientation of the line.

Field Summary

Fields

Modifier and Type	Field and Description
static LineLayout.LineOrientation	DEFAULT_LINE_ORIENTATION The default orientation of the line.
static double	DEFAULT_SPACING The default spacing between neurons when laid out.

Constructor Summary

Constructors

Constructor and Description
LineLayout() Default Constructor.
LineLayout(double x, double y, double spacing, LineLayout.LineOrientation orientation) Create a line layout with all values specified.
LineLayout(double spacing, LineLayout.LineOrientation orientation) Create a layout.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription()
LineLayout.LineOrientation	getOrientation()
double	getSpacing()
void	layoutNeurons(java.util.List<Neuron> neurons) Layout a list of neurons.
void	setInitialLocation(java.awt.geom.Point2D initialPoint) Set the initial position.
void	setOrientation(LineLayout.LineOrientation orientation)
void	setSpacing(double spacing)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LINE_ORIENTATION

public static final LineLayout.LineOrientation DEFAULT_LINE_ORIENTATION

The default orientation of the line.

DEFAULT_SPACING

public static final double DEFAULT_SPACING

The default spacing between neurons when laid out.

See Also:

Constant Field Values

Constructor Detail

LineLayout

public LineLayout(double spacing,
                  LineLayout.LineOrientation orientation)

Create a layout.

Parameters:

spacing - spacing between neurons

orientation - of the neurons

LineLayout

public LineLayout(double x,
                  double y,
                  double spacing,
                  LineLayout.LineOrientation orientation)

Create a line layout with all values specified.

Parameters:

x - initial x position

y - initial y position

spacing - spacing between neurons

orientation - vertical or horizontal

LineLayout

public LineLayout()

Default Constructor.

Method Detail

layoutNeurons

public void layoutNeurons(java.util.List<Neuron> neurons)

Description copied from interface: Layout

Layout a list of neurons.

Specified by:

layoutNeurons in interface Layout

Parameters:

neurons - the list of neurons

setInitialLocation

public void setInitialLocation(java.awt.geom.Point2D initialPoint)

Description copied from interface: Layout

Set the initial position.

Specified by:

setInitialLocation in interface Layout

Parameters:

initialPoint - initial position

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Layout

Returns:

the name of this layout type

getOrientation

public LineLayout.LineOrientation getOrientation()

Returns:

the orientation

setOrientation

public void setOrientation(LineLayout.LineOrientation orientation)

Parameters:

orientation - the orientation to set

getSpacing

public double getSpacing()

Returns:

the spacing

setSpacing

public void setSpacing(double spacing)

Parameters:

spacing - the spacing to set

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object