PointsList (QuimP 19.08.01 API)

java.lang.Object
- com.github.celldynamics.quimp.PointsList<T>

Type Parameters:

T - Type of point, currently can be Node or Vert

Direct Known Subclasses:

Node, Vert
```
public abstract class PointsList<T extends PointsList<T>>
extends Object
```
Represents node of bidirectional list of points in Cartesian coordinates.
This abstract class contains basic properties of points and provides method for moving across the list. Points in list are numbered from 1 and list can be looped. There is one special node called head that indicates beginning of the list (and its end if the list is looped). PointList is assumed to be infinite long and may not be looped.

Author:

p.baniukiewicz

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`head` Indicate if this point is head.
`protected T`	`next` Next point in list, null if no other point.
`protected ExtendedVector2d`	`normal` Normal vector.
`protected ExtendedVector2d`	`point` x,y co-ordinates of the point.
`protected double`	`position` Normalized position on list.
`protected T`	`prev` Previous point in list, null if no other point.
`protected ExtendedVector2d`	`tan` tangent vector.
`protected int`	`tracknumber` ID number of point, unique across list.

Constructor Summary

Constructors
Constructor and Description
`PointsList()` Default constructor, assumes that first point is created on list with ID = 1.
`PointsList(double xx, double yy, int t)` Creates point with given ID and coordinates.
`PointsList(int t)` Create point with given ID.
`PointsList(PointsList<?> src)` Copy constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`void`	`freeze()` Freeze Point.
`double`	`getCurvatureLocal()` Evaluate local curvature of T related to previous, this and next T.
`T`	`getNext()` Get next node in chain (previous if not clockwise).
`ExtendedVector2d`	`getNormal()` Gets the normal.
`ExtendedVector2d`	`getPoint()` Gets the point.
`double`	`getPosition()` Get normalised position of node.
`T`	`getPrev()` Get previous node in chain (next if not clockwise).
`ExtendedVector2d`	`getTangent()` Gets the tangent.
`int`	`getTrackNum()` Gets the track num.
`double`	`getX()` point getter.
`double`	`getY()` point getter.
`int`	`hashCode()`
`boolean`	`isFrozen()` Getter to frozen field.
`boolean`	`isHead()` Checks if is head.
`static void`	`randDirection()` Set direction of list.
`static void`	`setClockwise(boolean b)` Sets the clockwise.
`void`	`setHead(boolean t)` Set head marker to current node.
`void`	`setNext(T n)` Adds next (or previous if not clockwise) Node to list.
`void`	`setNormal(double x, double y)` Sets the normal.
`void`	`setPosition(double position)` Set normalised position of node.
`void`	`setPrev(T n)` Adds previous (or next if not clockwise) Node to list.
`void`	`setTrackNum(int b)` Sets the track num.
`void`	`setX(double x)` Set X space co-ordinate.
`void`	`setY(double y)` Set Y space co-ordinate.
`String`	`toString()`
`void`	`unfreeze()` Unfreeze Point.
`void`	`updateNormale(boolean inner)` Updates the normal (must point inwards).

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - prev
```
protected transient T extends PointsList<T> prev
```
    Previous point in list, null if no other point.
  - next
```
protected transient T extends PointsList<T> next
```
    Next point in list, null if no other point.
  - point
```
protected ExtendedVector2d point
```
    x,y co-ordinates of the point.
  - normal
```
protected ExtendedVector2d normal
```
    Normal vector. Calculated by updateNormale(boolean) and implicitly by Shape.updateNormals(boolean) from Shape during serialization and deserialization and changing the shape of Shape
  - tan
```
protected ExtendedVector2d tan
```
    tangent vector. Calculated by com.github.celldynamics.quimp.PointsList.calcTan(). Implicitly during calculating normals (see normal)
  - head
```
protected boolean head
```
    Indicate if this point is head.
  - tracknumber
```
protected int tracknumber
```
    ID number of point, unique across list. Given during adding point to list, controlled by Shape
  - position
```
protected double position
```
    Normalized position on list.
    0 - beginning , 1 - end of the list according to Shape perimeter. Set by com.github.celldynamics.quimp.Shape.setPositions() and called before and after serialise and on Shape writing.
- Constructor Detail
  - PointsList
```
public PointsList()
```
    Default constructor, assumes that first point is created on list with ID = 1.
  - PointsList
```
public PointsList(int t)
```
    Create point with given ID. New point is not linked to any other yet.
    Caller should care about correct numbering of points
    
    Parameters:
    
    t - ID of point
  - PointsList
```
public PointsList(PointsList<?> src)
```
    Copy constructor. Make copy of properties of passed point.
    Previous or next points are not copied
    
    Parameters:
    
    src - Source Point
  - PointsList
```
public PointsList(double xx,
                  double yy,
                  int t)
```
    Creates point with given ID and coordinates. New point is not linked to any other yet.
    Caller should care about correct numbering of points
    
    Parameters:
    
    xx - x coordinate of point
    
    yy - y coordinate of point
    
    t - ID of point
- Method Detail
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getX
```
public double getX()
```
    point getter.
    
    Returns:
    
    X space co-ordinate
  - getY
```
public double getY()
```
    point getter.
    
    Returns:
    
    Y space co-ordinate
  - setX
```
public void setX(double x)
```
    Set X space co-ordinate.
    
    Parameters:
    
    x - coordinate
  - setY
```
public void setY(double y)
```
    Set Y space co-ordinate.
    
    Parameters:
    
    y - coordinate
  - setClockwise
```
public static void setClockwise(boolean b)
```
    Sets the clockwise.
    
    Parameters:
    
    b - the new clockwise
  - getPoint
```
public ExtendedVector2d getPoint()
```
    Gets the point.
    
    Returns:
    
    the point
  - getTrackNum
```
public int getTrackNum()
```
    Gets the track num.
    
    Returns:
    
    the track num
  - getNormal
```
public ExtendedVector2d getNormal()
```
    Gets the normal.
    
    Returns:
    
    the normal
  - getTangent
```
public ExtendedVector2d getTangent()
```
    Gets the tangent.
    
    Returns:
    
    the tangent
  - getPosition
```
public double getPosition()
```
    Get normalised position of node.
    
    Returns:
    
    the position
  - setPosition
```
public void setPosition(double position)
```
    Set normalised position of node.
    
    Parameters:
    
    position - the position to set
  - isHead
```
public boolean isHead()
```
    Checks if is head.
    
    Returns:
    
    true, if is head
  - setNormal
```
public void setNormal(double x,
                      double y)
```
    Sets the normal.
    
    Parameters:
    
    x - the x
    
    y - the y
  - setTrackNum
```
public void setTrackNum(int b)
```
    Sets the track num.
    
    Parameters:
    
    b - the new track num
  - setHead
```
public void setHead(boolean t)
```
    Set head marker to current node.
    Warning
    Only one Node in Snake can be head
    
    Parameters:
    
    t - true if current node is head, false otherwise
    
    See Also:
    
    Shape.setHead(int), Snake
  - getPrev
```
public T getPrev()
```
    Get previous node in chain (next if not clockwise).
    
    Returns:
    
    next or previous Node from list
  - getNext
```
public T getNext()
```
    Get next node in chain (previous if not clockwise).
    
    Returns:
    
    previous or next Node from list
  - setPrev
```
public void setPrev(T n)
```
    Adds previous (or next if not clockwise) Node to list.
    
    Parameters:
    
    n - Node to add
  - setNext
```
public void setNext(T n)
```
    Adds next (or previous if not clockwise) Node to list.
    
    Parameters:
    
    n - Node to add
  - updateNormale
```
public void updateNormale(boolean inner)
```
    Updates the normal (must point inwards).
    
    Parameters:
    
    inner - inner
  - randDirection
```
public static void randDirection()
```
    Set direction of list.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - freeze
```
public void freeze()
```
    Freeze Point.
  - unfreeze
```
public void unfreeze()
```
    Unfreeze Point.
  - isFrozen
```
public boolean isFrozen()
```
    Getter to frozen field.
    
    Returns:
    
    frozen
  - getCurvatureLocal
```
public double getCurvatureLocal()
```
    Evaluate local curvature of T related to previous, this and next T.
    
    Returns:
    
    Local curvature for this node in degrees

Class PointsList<T extends PointsList<T>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

prev

next

point

normal

tan

head

tracknumber

position

Constructor Detail

PointsList

PointsList

PointsList

PointsList

Method Detail

hashCode

equals

getX

getY

setX

setY

setClockwise

getPoint

getTrackNum

getNormal

getTangent

getPosition

setPosition

isHead

setNormal

setTrackNum

setHead

getPrev

getNext

setPrev

setNext

updateNormale

randDirection

toString

freeze

unfreeze

isFrozen

getCurvatureLocal