Graph

java.lang.Object
- muehlseife.correlations.Graph

```
public class Graph
extends java.lang.Object
```
Graph contains Nodes, Edges and Groups. Use this class to create and delete these objects during runtime or by code

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Graph.StyleSheet

Nested Classes
Modifier and Type	Class and Description
`class`	`Graph.StyleSheet`

Field Summary

Fields
Modifier and Type	Field and Description
`float`	`attractionForce` strength of the attraction force between connected elements
`float`	`collisionForce` strength of the collision force between the elements
`boolean`	`createRelations` allow the user to create new relations during runtime
`boolean`	`fixCaption` allow the user to change the caption of the nodes during runtime
`boolean`	`fixColor` allow the user to change the color of the nodes during runtime
`boolean`	`fixPosition` allow the user to move the nodes during runtime
`boolean`	`fixSize` allow the user to change the size of the nodes during runtime
`boolean`	`highLight`
`boolean`	`listView` toggle view mode
`float`	`relationsForce` strength of the attraction force between connected elements
`boolean`	`resize`
`boolean`	`runPhysics` toggle self organization
`float`	`scale` scale of the view
`boolean`	`shaded` shaded or filled
`boolean`	`showBoundingBox` show the bounding box (for mouse interaction)
`boolean`	`showCaption` visibility of the node caption
`boolean`	`showIcon` visibility of the node icon (PShape)
`boolean`	`showLabels`
`boolean`	`showSliders`
`processing.core.PVector`	`trans` translation of the view
`static java.lang.String`	`VERSION`

Constructor Summary

Constructors
Constructor and Description

Graph(processing.core.PApplet pa)
create new Graph

Graph(processing.core.PApplet pa, processing.core.PGraphics pg)
create new Graph

Constructors
Constructor and Description
`Graph(processing.core.PApplet pa)` create new `Graph`
`Graph(processing.core.PApplet pa, processing.core.PGraphics pg)` create new `Graph`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(java.lang.String nn)` check if the Graph contains a Node with a name nn
`void`	`deleteBoundingBox()` reset bounding box
`void`	`deleteSelectionBox()` reset bounding box (for Node selection)
`java.io.File`	`exportXML(java.lang.String fileName)` export as XML file
`java.io.File`	`exportZip(java.lang.String fileName)` export as ZIP file
`Node`	`get(java.lang.String nn)` get `Node` by name returns `null` when it doesn't contain a Node with this name
`Node[]`	`getAll()` get all Nodes of the Graph
`Node[]`	`getGroup(java.lang.String nn)` get a Group of Nodes
`Node[]`	`getSelected()` get all selected Nodes as ArrayList
`java.util.ArrayList<Node>`	`getSelectedList()` get all selected Nodes as ArrayList
`void`	`importXML(java.lang.String fileName)` import XML file
`void`	`importZip(java.lang.String fileName)` import ZIP file
`void`	`keyEvent(processing.event.KeyEvent event)` key events
`void`	`mouseEvent(processing.event.MouseEvent event)` mouse events
`void`	`put(java.lang.String nn, Node n)` add `Node`
`void`	`put(java.lang.String nn, Node n, java.lang.String... g)` add Node and put it in Group(s)
`void`	`registerCorrelationsEvent(java.lang.Object oo)` register a method to call at every correlations event the method must look like this: `correlationsEvent(CorrelationsEvent event)`
`void`	`render()` render everything
`void`	`setBoundingBox(float x1, float y1, float x2, float y2)` set the bounding box
`void`	`setMouseBoundingBox(float x1, float y1, float x2, float y2)` set the bounding box (for mouse interaction)
`void`	`setSelectionBox(float x1, float y1, float x2, float y2)` set bounding box (for Node selection)

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - fixSize
```
public boolean fixSize
```
    allow the user to change the size of the nodes during runtime
  - fixColor
```
public boolean fixColor
```
    allow the user to change the color of the nodes during runtime
  - fixPosition
```
public boolean fixPosition
```
    allow the user to move the nodes during runtime
  - fixCaption
```
public boolean fixCaption
```
    allow the user to change the caption of the nodes during runtime
  - createRelations
```
public boolean createRelations
```
    allow the user to create new relations during runtime
  - showCaption
```
public boolean showCaption
```
    visibility of the node caption
  - showIcon
```
public boolean showIcon
```
    visibility of the node icon (PShape)
  - shaded
```
public boolean shaded
```
    shaded or filled
  - showBoundingBox
```
public boolean showBoundingBox
```
    show the bounding box (for mouse interaction)
  - VERSION
```
public static final java.lang.String VERSION
```
    See Also:
    
    Constant Field Values
  - trans
```
public processing.core.PVector trans
```
    translation of the view
  - scale
```
public float scale
```
    scale of the view
  - highLight
```
public boolean highLight
```
  - resize
```
public boolean resize
```
  - showSliders
```
public boolean showSliders
```
  - showLabels
```
public boolean showLabels
```
  - collisionForce
```
public float collisionForce
```
    strength of the collision force between the elements
  - attractionForce
```
public float attractionForce
```
    strength of the attraction force between connected elements
  - relationsForce
```
public float relationsForce
```
    strength of the attraction force between connected elements
  - runPhysics
```
public boolean runPhysics
```
    toggle self organization
  - listView
```
public boolean listView
```
    toggle view mode
- Constructor Detail
  - Graph
```
public Graph(processing.core.PApplet pa,
             processing.core.PGraphics pg)
```
    create new Graph
    
    Parameters:
    
    PApplet - pa
    
    PGraphics - pg
  - Graph
```
public Graph(processing.core.PApplet pa)
```
    create new Graph
    
    Parameters:
    
    PApplet - pa
- Method Detail
  - registerCorrelationsEvent
```
public void registerCorrelationsEvent(java.lang.Object oo)
```
    register a method to call at every correlations event
    the method must look like this: correlationsEvent(CorrelationsEvent event)
    
    Parameters:
    
    Object - oo:
  - render
```
public void render()
```
    render everything
  - put
```
public void put(java.lang.String nn,
                Node n)
```
    add Node
    
    Parameters:
    
    String - nn: name of the Node
    
    Node - n: the Node
  - get
```
public Node get(java.lang.String nn)
```
    get Node by name
    returns null when it doesn't contain a Node with this name
    
    Parameters:
    
    String - nn: name of the Node
  - put
```
public void put(java.lang.String nn,
                Node n,
                java.lang.String... g)
```
    add Node and put it in Group(s)
    
    Parameters:
    
    String - nn: name of the Node
    
    Node - n: the Node
    
    String... - g: group name(s)
  - getAll
```
public Node[] getAll()
```
    get all Nodes of the Graph
  - getGroup
```
public Node[] getGroup(java.lang.String nn)
```
    get a Group of Nodes
    
    Parameters:
    
    String - nn: name of the groups
  - contains
```
public boolean contains(java.lang.String nn)
```
    check if the Graph contains a Node with a name nn
    
    Parameters:
    
    String - nn: name of the Node
  - getSelectedList
```
public java.util.ArrayList<Node> getSelectedList()
```
    get all selected Nodes as ArrayList
  - getSelected
```
public Node[] getSelected()
```
    get all selected Nodes as ArrayList
  - setBoundingBox
```
public void setBoundingBox(float x1,
                           float y1,
                           float x2,
                           float y2)
```
    set the bounding box
    
    Parameters:
    
    float - x1: top left coordinate of the box
    
    float - y1: top left coordinate of the box
    
    float - x2: bottom right coordinate of the box
    
    float - y2: bottom right coordinate of the box
  - setMouseBoundingBox
```
public void setMouseBoundingBox(float x1,
                                float y1,
                                float x2,
                                float y2)
```
    set the bounding box (for mouse interaction)
  - deleteBoundingBox
```
public void deleteBoundingBox()
```
    reset bounding box
  - setSelectionBox
```
public void setSelectionBox(float x1,
                            float y1,
                            float x2,
                            float y2)
```
    set bounding box (for Node selection)
  - deleteSelectionBox
```
public void deleteSelectionBox()
```
    reset bounding box (for Node selection)
  - keyEvent
```
public void keyEvent(processing.event.KeyEvent event)
```
    key events
  - mouseEvent
```
public void mouseEvent(processing.event.MouseEvent event)
```
    mouse events
  - exportXML
```
public java.io.File exportXML(java.lang.String fileName)
```
    export as XML file
  - importXML
```
public void importXML(java.lang.String fileName)
```
    import XML file
  - exportZip
```
public java.io.File exportZip(java.lang.String fileName)
```
    export as ZIP file
  - importZip
```
public void importZip(java.lang.String fileName)
```
    import ZIP file

Class Graph

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

fixSize

fixColor

fixPosition

fixCaption

createRelations

showCaption

showIcon

shaded

showBoundingBox

VERSION

trans

scale

highLight

resize

showSliders

showLabels

collisionForce

attractionForce

relationsForce

runPhysics

listView

Constructor Detail

Graph

Graph

Method Detail

registerCorrelationsEvent

render

put

get

put

getAll

getGroup

contains

getSelectedList

getSelected

setBoundingBox

setMouseBoundingBox

deleteBoundingBox

setSelectionBox

deleteSelectionBox

keyEvent

mouseEvent

exportXML

importXML

exportZip

importZip