NumericProbePanel (Artisynth API documentation)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - artisynth.core.gui.NumericProbePanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, HasProperties, ValueChangeListener
```
public class NumericProbePanel
extends javax.swing.JPanel
implements HasProperties, ValueChangeListener
```
Author:

Chad Added to display a thin line for outputprobes, and not to display datapoints per John's request

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NumericProbePanel.ScreenTransform
Maps x and y values to and from pixel coordinates.
- Nested classes/interfaces inherited from class javax.swing.JComponent
  javax.swing.JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class java.awt.Component
  java.awt.Component.BaselineResizeBehavior

Nested Classes
Modifier and Type	Class and Description
`static class`	`NumericProbePanel.ScreenTransform` Maps x and y values to and from pixel coordinates.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.awt.Color`	`BlueViolet`
`static java.awt.Color[]`	`colorList`
`static java.awt.Color`	`DARK_GREEN`
`static java.awt.Color`	`DarkOliveGreen`
`static java.awt.Color`	`DarkOrange`
`static java.awt.Color`	`IndianRed`
`static PropertyList`	`myProps`
`static java.awt.Color`	`NavajoWhite`
`static java.awt.Color`	`PeachPuff`

Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description
`NumericProbePanel(NumericList nlist, int width, int height, boolean largeDisplay, boolean inputData)`
`NumericProbePanel(NumericProbePanel panel)`
`NumericProbePanel(Probe probe)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`adjustRangeIfNecessary()`
`NumericProbePanel.ScreenTransform`	`createScreenTransform()`
`void`	`decreaseXRange()` Decrease the x range that is being viewed.
`void`	`decreaseYRange()` Decrease the y range that is being viewed.
`void`	`dispose()`
`void`	`drawPlot(DataRenderer r, boolean largeDisplay)`
`void`	`exportImageAs()`
`PropertyList`	`getAllPropertyInfo()` Returns a list giving static information about all properties exported by this object.
`artisynth.core.gui.NumericProbePanel.CursorMode`	`getCursorMode()`
`DoubleInterval`	`getDefaultXRange()`
`DoubleInterval`	`getDefaultYRange()`
`boolean`	`getDrawGrid()`
`Interpolation`	`getInterpolation()`
`Interpolation.Order`	`getInterpolationOrder()`
`int`	`getKnotSize()`
`boolean`	`getKnotsVisible()`
`int`	`getLineWidth()`
`Property`	`getProperty(java.lang.String path)` Returns a property associated with a specified path name.
`int`	`getTickLength()`
`int[]`	`getTraceOrder(artisynth.core.gui.NumericProbePanel.TraceOrdering ordering)` Finds the trace indices required for a particular ordering based on the display's current values.
`int`	`getVectorSize()`
`DoubleInterval`	`getXRange()`
`Range`	`getXRangeRange()`
`DoubleInterval`	`getYRange()`
`Range`	`getYRangeRange()`
`void`	`increaseXRange()` Increase the x range that is being viewed.
`void`	`increaseYRange()` Increase the y range that is being viewed.
`boolean`	`isAutoRanging()`
`boolean`	`isLargeDisplay()`
`void`	`moveDisplay(long xDistance, long yDistance)` Move the display around when it is zoomed in on.
`void`	`paint(java.awt.Graphics g)`
`Point2d`	`pixelsToCoords(java.awt.Point p)`
`void`	`repaint()`
`void`	`repaintForPropertyChanges()` Repaint if probe property changes require it.
`void`	`repaintWithoutAutoRanging()`
`void`	`resetColors()`
`void`	`resetDisplay()`
`void`	`resetDrawOrder(int size)`
`static double`	`round(double d, int decimalPlace)`
`void`	`setAutoRanging(boolean enable)`
`void`	`setCursorMode(artisynth.core.gui.NumericProbePanel.CursorMode mode)`
`void`	`setDefaultXRange()`
`void`	`setDefaultYRange()`
`void`	`setDisplaySize(int width, int height)`
`void`	`setDrawGrid(boolean enable)`
`void`	`setInterpolationOrder(Interpolation.Order order)`
`void`	`setKnotSize(int size)`
`void`	`setKnotsVisible(boolean enable)`
`void`	`setLargeDisplay(boolean isLargeDisplay)`
`void`	`setLineColor(int index, java.awt.Color color)`
`void`	`setLineWidth(int width)`
`void`	`setTickLength(int len)`
`void`	`setXRange(double min, double max)`
`void`	`setXRange(DoubleInterval range)`
`void`	`setYRange(double min, double max)`
`void`	`setYRange(DoubleInterval range)`
`void`	`swapDrawIndicies(int a, int b)`
`void`	`valueChange(ValueChangeEvent e)`
`void`	`zoomIn(java.awt.Point zoomPoint)` Zoom in on a particular point on the numeric probe display.
`void`	`zoomOut(java.awt.Point zoomPoint)` Zoom out on a particular point on the numeric probe display.

Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

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

Field Detail

DARK_GREEN

public static java.awt.Color DARK_GREEN

DarkOliveGreen

public static java.awt.Color DarkOliveGreen

IndianRed
```
public static java.awt.Color IndianRed
```

DarkOrange

public static java.awt.Color DarkOrange

BlueViolet

public static java.awt.Color BlueViolet

NavajoWhite

public static java.awt.Color NavajoWhite

PeachPuff
```
public static java.awt.Color PeachPuff
```

colorList

public static java.awt.Color[] colorList

myProps
```
public static PropertyList myProps
```

Constructor Detail

NumericProbePanel
```
public NumericProbePanel(Probe probe)
```

NumericProbePanel

public NumericProbePanel(NumericProbePanel panel)

NumericProbePanel

public NumericProbePanel(NumericList nlist,
                         int width,
                         int height,
                         boolean largeDisplay,
                         boolean inputData)

Method Detail
- createScreenTransform
```
public NumericProbePanel.ScreenTransform createScreenTransform()
```
- getAllPropertyInfo
```
public PropertyList getAllPropertyInfo()
```
  Description copied from interface: HasProperties
  
  Returns a list giving static information about all properties exported by this object.
  
  Specified by:
  
  getAllPropertyInfo in interface HasProperties
  
  Returns:
  
  static information for all exported properties
- getProperty
```
public Property getProperty(java.lang.String path)
```
  Returns a property associated with a specified path name. All properties exported by this object must have a name which is a valid Java identifier. Specifying one of these names causes the corresponding Property to be returned. Handles to subproperties can also be obtained by delimiting the sub-property name(s) by '.' characters. A sub-property exists if the value of a property is itself an object which exports properties. It is only possible to obtain a sub-property handle if each of its ancestor properties exports their values by reference.
  
  Specified by:
  
  getProperty in interface HasProperties
  
  Parameters:
  
  path - name of the desired property or sub-property
  
  Returns:
  
  handle to the property
- setDrawGrid
```
public void setDrawGrid(boolean enable)
```
- getDrawGrid
```
public boolean getDrawGrid()
```
- setXRange
```
public void setXRange(DoubleInterval range)
```
- setXRange
```
public void setXRange(double min,
                      double max)
```
- setDefaultXRange
```
public void setDefaultXRange()
```
- getXRange
```
public DoubleInterval getXRange()
```
- getXRangeRange
```
public Range getXRangeRange()
```
- setYRange
```
public void setYRange(DoubleInterval range)
```
- setYRange
```
public void setYRange(double min,
                      double max)
```
- setDefaultYRange
```
public void setDefaultYRange()
```
- getYRange
```
public DoubleInterval getYRange()
```
- getYRangeRange
```
public Range getYRangeRange()
```
- setTickLength
```
public void setTickLength(int len)
```
- getTickLength
```
public int getTickLength()
```
- setLineWidth
```
public void setLineWidth(int width)
```
- getLineWidth
```
public int getLineWidth()
```
- getKnotSize
```
public int getKnotSize()
```
- setKnotSize
```
public void setKnotSize(int size)
```
- getKnotsVisible
```
public boolean getKnotsVisible()
```
- setKnotsVisible
```
public void setKnotsVisible(boolean enable)
```
- isAutoRanging
```
public boolean isAutoRanging()
```
- setAutoRanging
```
public void setAutoRanging(boolean enable)
```
- getInterpolationOrder
```
public Interpolation.Order getInterpolationOrder()
```
- setInterpolationOrder
```
public void setInterpolationOrder(Interpolation.Order order)
```
- getInterpolation
```
public Interpolation getInterpolation()
```
- setDisplaySize
```
public void setDisplaySize(int width,
                           int height)
```
- getCursorMode
```
public artisynth.core.gui.NumericProbePanel.CursorMode getCursorMode()
```
- setCursorMode
```
public void setCursorMode(artisynth.core.gui.NumericProbePanel.CursorMode mode)
```
- getDefaultYRange
```
public DoubleInterval getDefaultYRange()
```
- getDefaultXRange
```
public DoubleInterval getDefaultXRange()
```
- resetDisplay
```
public void resetDisplay()
```
- repaint
```
public void repaint()
```
  Overrides:
  
  repaint in class java.awt.Component
- repaintWithoutAutoRanging
```
public void repaintWithoutAutoRanging()
```
- repaintForPropertyChanges
```
public void repaintForPropertyChanges()
```
  Repaint if probe property changes require it.
- adjustRangeIfNecessary
```
public void adjustRangeIfNecessary()
```
- drawPlot
```
public void drawPlot(DataRenderer r,
                     boolean largeDisplay)
```
- paint
```
public void paint(java.awt.Graphics g)
```
  Overrides:
  
  paint in class javax.swing.JComponent
- round
```
public static double round(double d,
                           int decimalPlace)
```
- swapDrawIndicies
```
public void swapDrawIndicies(int a,
                             int b)
```
- zoomIn
```
public void zoomIn(java.awt.Point zoomPoint)
```
  Zoom in on a particular point on the numeric probe display.
  
  Parameters:
  
  zoomPoint - The point to zoom in on.
- zoomOut
```
public void zoomOut(java.awt.Point zoomPoint)
```
  Zoom out on a particular point on the numeric probe display. Only zoom out as far as the original display range.
  
  Parameters:
  
  zoomPoint - The point to zoom out on.
- moveDisplay
```
public void moveDisplay(long xDistance,
                        long yDistance)
```
  Move the display around when it is zoomed in on. Constrain the movement to where the probe is displayed.
  
  Parameters:
  
  xDistance - The distance to move the display in pixels.
  
  yDistance - The distance to move the display in pixels.
- increaseYRange
```
public void increaseYRange()
```
  Increase the y range that is being viewed. This is different from zooming because we can increase the range past the original display range.
- decreaseYRange
```
public void decreaseYRange()
```
  Decrease the y range that is being viewed. When the range is increased this function undoes those increases.
- increaseXRange
```
public void increaseXRange()
```
  Increase the x range that is being viewed. This is different from zooming because we can increase the range past the original display range.
- decreaseXRange
```
public void decreaseXRange()
```
  Decrease the x range that is being viewed. When the range is increased this function undoes those increases.
- getTraceOrder
```
public int[] getTraceOrder(artisynth.core.gui.NumericProbePanel.TraceOrdering ordering)
```
  Finds the trace indices required for a particular ordering based on the display's current values. These indices can be specified as an argument to PlotTraceManager.setTraceOrder(int[]).
  
  Parameters:
  
  ordering - requested ordering
  
  Returns:
  
  trace indices
- pixelsToCoords
```
public Point2d pixelsToCoords(java.awt.Point p)
```
- exportImageAs
```
public void exportImageAs()
```
- valueChange
```
public void valueChange(ValueChangeEvent e)
```
  Specified by:
  
  valueChange in interface ValueChangeListener
- resetDrawOrder
```
public void resetDrawOrder(int size)
```
- resetColors
```
public void resetColors()
```
- setLineColor
```
public void setLineColor(int index,
                         java.awt.Color color)
```
- isLargeDisplay
```
public boolean isLargeDisplay()
```
- setLargeDisplay
```
public void setLargeDisplay(boolean isLargeDisplay)
```
- getVectorSize
```
public int getVectorSize()
```
- dispose
```
public void dispose()
```

Class NumericProbePanel

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

DARK_GREEN

DarkOliveGreen

IndianRed

DarkOrange

BlueViolet

NavajoWhite

PeachPuff

colorList

myProps

Constructor Detail

NumericProbePanel

NumericProbePanel

NumericProbePanel

Method Detail

createScreenTransform

getAllPropertyInfo

getProperty

setDrawGrid

getDrawGrid

setXRange

setXRange

setDefaultXRange

getXRange

getXRangeRange

setYRange

setYRange

setDefaultYRange

getYRange

getYRangeRange

setTickLength

getTickLength

setLineWidth

getLineWidth

getKnotSize

setKnotSize

getKnotsVisible

setKnotsVisible

isAutoRanging

setAutoRanging

getInterpolationOrder

setInterpolationOrder

getInterpolation

setDisplaySize

getCursorMode

setCursorMode

getDefaultYRange

getDefaultXRange

resetDisplay

repaint

repaintWithoutAutoRanging

repaintForPropertyChanges

adjustRangeIfNecessary

drawPlot

paint

round

swapDrawIndicies

zoomIn

zoomOut

moveDisplay

increaseYRange

decreaseYRange

increaseXRange

decreaseXRange

getTraceOrder