ForceObject (JunGrapht Visualization 1.1 API)

java.lang.Object
- org.jungrapht.visualization.layout.quadtree.ForceObject<T>

```
public class ForceObject<T>
extends Object
```
An instance used to gather forces while visiting the BarnesHut QuadTree.

Author:

Tom Nelson

Field Summary

Fields
Modifier and Type Field Description

Point f
force vector

protected double mass
mass

Point p
location of p

Constructor Summary

Constructors
Constructor	Description
`ForceObject(T element, double x, double y)`
`ForceObject(T element, double x, double y, double mass)`
`ForceObject(T element, Point p)`
`ForceObject(T element, Point p, double mass)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ForceObject`	`add(ForceObject<T> other)`
`protected void`	`addForceFrom(ForceObject<T> other)`	override in the layoutAlgorithm to apply forces in a way that is consistent with the chosen implementation.
`boolean`	`equals(Object o)`
`T`	`getElement()`
`double`	`getMass()`
`int`	`hashCode()`
`String`	`toString()`

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

Field Detail

p
```
public final Point p
```
location of p

f
```
public Point f
```
force vector

mass
```
protected double mass
```
mass

Constructor Detail

ForceObject

public ForceObject(T element,
                   Point p,
                   double mass)

ForceObject

public ForceObject(T element,
                   Point p)

ForceObject

public ForceObject(T element,
                   double x,
                   double y)

ForceObject

public ForceObject(T element,
                   double x,
                   double y,
                   double mass)

Method Detail
- getMass
```
public double getMass()
```
  Returns:
  
  the mass of this ForceObject
- addForceFrom
```
protected void addForceFrom(ForceObject<T> other)
```
  override in the layoutAlgorithm to apply forces in a way that is consistent with the chosen implementation. See FRBHVisitorLayoutAlgorithm and SpringVisitorLayoutAlgorithm.
  
  Parameters:
  
  other - the ForceObject (a node or a force vector) to apply force from
- add
```
public ForceObject add(ForceObject<T> other)
```
- getElement
```
public T getElement()
```
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class Object
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object