RollingLine2DTrace (Javadocs: gwoptics)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.gwoptics.graphics.graph2D.traces
Class RollingLine2DTrace

java.lang.Object
  org.gwoptics.graphics.graph2D.traces.Line2DTrace
      org.gwoptics.graphics.graph2D.traces.RollingLine2DTrace

All Implemented Interfaces:: IGraph2DTrace, IRenderable

public class RollingLine2DTrace
extends Line2DTrace
extends Line2DTrace

Since:: 0.4.0
Author:: Daniel Brown 13/7/09

Constructor Summary
`RollingLine2DTrace(ILine2DEquation eq, long msRefreshRate, float xTickIncr)` Creates a new `RollingLine2DTrace` to be added to a `Graph2D` instance.

Method Summary
`void`	`generate()` Uses the ILineEquation object provided to fill the internal arrays.
`long`	`getRefreshRate()`
`void`	`onAddTrace(java.lang.Object[] traces)` Here we override the onAddTrace method to see if any Rolling2DTraces have been previously added.
`void`	`onRemoveTrace()` Before the trace is officially removed from the trace list of a Graph2D object, the onRemove method is called.
`void`	`pre()`
`void`	`setGraph(IGraph2D grph)` Sets an internal variable to store a reference to the graph object the trace is being plotted on
`void`	`setParent(processing.core.PApplet parent)` Sets the parent PApplet object

Methods inherited from class org.gwoptics.graphics.graph2D.traces.Line2DTrace
`draw, removeEffect, setEquationCallback, setLineWidth, setPosition, setTraceColour, setTraceEffect`

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

Constructor Detail

RollingLine2DTrace

public RollingLine2DTrace(ILine2DEquation eq,
                          long msRefreshRate,
                          float xTickIncr)

Creates a new RollingLine2DTrace to be added to a Graph2D instance. A rolling graph is able to update itself automatically after a user defined period in milliseconds indefinitely. All RollingLine2DTrace traces that are added to a Graph2D instance should have the same update rate or an exception will be thrown.

Parameters:: eq - Equation that is to be used to generate the trace.; msRefreshRate - Rate at which trace is updated in milliseconds; xTickIncr - The amount the X-Axis value should increase every update

Method Detail

getRefreshRate

public long getRefreshRate()

setParent

public void setParent(processing.core.PApplet parent)

Description copied from class: Line2DTrace

Sets the parent PApplet object

Specified by:: setParent in interface IRenderable
Overrides:: setParent in class Line2DTrace

setGraph

public void setGraph(IGraph2D grph)

Description copied from interface: IGraph2DTrace

Sets an internal variable to store a reference to the graph object the trace is being plotted on

Specified by:: setGraph in interface IGraph2DTrace
Overrides:: setGraph in class Line2DTrace

onAddTrace

public void onAddTrace(java.lang.Object[] traces)

Here we override the onAddTrace method to see if any Rolling2DTraces have been previously added. Then check to see if our refresh rate is the same as the others

Specified by:: onAddTrace in interface IGraph2DTrace
Overrides:: onAddTrace in class Line2DTrace

onRemoveTrace

public void onRemoveTrace()