boone.map

Class Position

java.lang.Object

boone.map.Position

All Implemented Interfaces:

Storable, java.lang.Cloneable

public class Position
extends java.lang.Object
implements java.lang.Cloneable, Storable

A 3D neuron position description. For persistence, see the standard persistence methods in the Boone class.

Version:

$Id$

Author:

August Mayer

Field Summary

Fields

Modifier and Type	Field and Description
protected float	xPos x and y and z positions of the neuron.
protected float	yPos x and y and z positions of the neuron.
protected float	zPos x and y and z positions of the neuron.

Constructor Summary

Constructors

Constructor and Description
Position() Simple constructor for default values.
Position(float xPos, float yPos) sophisticated constructor specifying the position.
Position(float xPos, float yPos, float zPos) sophisticated constructor specifying the position, with z coordinate
Position(Position pos) copy constructor

Method Summary

Modifier and Type	Method and Description
Position	clone() Returns a shallow clone.
double	distanceTo(Position otherP) distance to other Position (pythagoras)
void	fromXML(org.jdom2.Element element) Reads specific attributes from XML tree.
float	getXPos()
float	getYPos()
float	getZPos()
void	set(float[] array) Set from a float array.
void	set(float xPos, float yPos) Set new position in 2D.
void	set(float xPos, float yPos, float zPos) Set new position in 3D.
void	set(Position pos) Set new position in 3D, copying from another Position.
void	setXPos(float xPos)
void	setYPos(float yPos)
void	setZPos(float zPos)
float[]	toArray() Convert to a float array.
java.lang.String	toString() Returns a string representation of this position.
org.jdom2.Element	toXML(org.jdom2.Element element) Writes attributes to XML tree.

Methods inherited from class java.lang.Object

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

Field Detail

xPos

protected float xPos

x and y and z positions of the neuron. default = (0,0,0)

yPos

protected float yPos

x and y and z positions of the neuron. default = (0,0,0)

zPos

protected float zPos

x and y and z positions of the neuron. default = (0,0,0)

Constructor Detail

Position

public Position()

Simple constructor for default values.

Position

public Position(Position pos)

copy constructor

Position

public Position(float xPos,
                float yPos)

sophisticated constructor specifying the position. Z is set to 0.

Position

public Position(float xPos,
                float yPos,
                float zPos)

sophisticated constructor specifying the position, with z coordinate

Method Detail

clone

public Position clone()

Returns a shallow clone.

Overrides:

clone in class java.lang.Object

Returns:

the clone

toXML

public org.jdom2.Element toXML(org.jdom2.Element element)

Writes attributes to XML tree.

Specified by:

toXML in interface Storable

Parameters:

element - a JDOM element

Returns:

the position element

fromXML

public void fromXML(org.jdom2.Element element)

Reads specific attributes from XML tree.

Specified by:

fromXML in interface Storable

Parameters:

element - a JDOM element

getXPos

public float getXPos()

Returns:

Value of property xPos.

setXPos

public void setXPos(float xPos)

Parameters:

xPos - New value of property xPos.

getYPos

public float getYPos()

Returns:

Value of property yPos.

setYPos

public void setYPos(float yPos)

Parameters:

yPos - New value of property yPos.

getZPos

public float getZPos()

Returns:

Value of property zPos.

setZPos

public void setZPos(float zPos)

Parameters:

zPos - New value of property zPos.

set

public void set(float xPos,
                float yPos)

Set new position in 2D. Doesn't touch the z position.

set

public void set(float xPos,
                float yPos,
                float zPos)

Set new position in 3D.

set

public void set(Position pos)

Set new position in 3D, copying from another Position.

toArray

public float[] toArray()

Convert to a float array.

set

public void set(float[] array)

Set from a float array. If the array is only of size 2, doesn't touch the z coordinate.

distanceTo

public double distanceTo(Position otherP)

distance to other Position (pythagoras)

toString

public java.lang.String toString()

Returns a string representation of this position.

Overrides:

toString in class java.lang.Object

Returns:

the coordinates