JSurface

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - jplot3d.JSurface

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable
```
public class JSurface
extends JComponent
```
The class JSurface is responsible for the generation of surface images and user mouse events handling.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JComponent
  JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class java.awt.Component
  Component.BaselineResizeBehavior

Field Summary

Fields
Modifier and Type	Field and Description
`LineAccumulator`	`accumulator`
`int`	`calc_divisions`
`float`	`color_factor`
`int`	`contour_lines`
`float`	`contour_stepz`
`SurfaceVertex[]`	`contour_vertex`
`SurfaceVertex`	`cop`
`boolean`	`critical`
`int`	`curve`
`boolean`	`data_available`
`org.freehep.graphics2d.VectorGraphics`	`graphics`
`boolean`	`interrupted`
`boolean`	`isBoxed`
`boolean`	`isDisplayGrids`
`boolean`	`isDisplayXY`
`boolean`	`isDisplayZ`
`boolean`	`isMesh`
`boolean`	`isScaleBox`
`JMenuItem`	`item1`
`JMenuItem`	`item2`
`Color`	`line_color`
`SurfaceModel`	`model`
`SurfaceModel.PlotType`	`plot_type`
`boolean`	`plotboth`
`boolean`	`plotfunc1`
`boolean`	`plotfunc2`
`boolean`	`printing`
`Point`	`projection`
`Projector`	`projector`
`SurfaceVertex[][]`	`vertex`
`float`	`xmax`
`float`	`xmin`
`float`	`ymax`
`float`	`ymin`
`float`	`zmax`
`float`	`zmin`

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

JSurface()

JSurface(SurfaceModel model)
The constructor of JSurface

Constructors
Constructor and Description
`JSurface()`
`JSurface(SurfaceModel model)` The constructor of `JSurface`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`computePlotArea()` Common method for contour plot and density plot that computes the best plot area size and position.
`int`	`contourConvertX(float x)` Converts normalized x coordinate (-10..+10) to screen x coordinate
`int`	`contourConvertY(float y)` Converts normalized y coordinate (-10..+10) to screen y coordinate
`void`	`createContour()` Creates contour plot of a single area division.
`void`	`destroyImage()` Destroys the internal image.
`void`	`doExportPNG(File file)` `mouseDown` event handler.
`void`	`drawBoundingBox()` Draws the bounding box of surface.
`void`	`drawBoundingRect()` Creates bounding box for images of contour plot or density plot
`void`	`drawBoxGridsTicksLabels(org.freehep.graphics2d.VectorGraphics g2d, boolean draw_axes)` Draws non-surface parts, i.e: bounding box, axis grids, axis ticks, axis labels, base plane.
`JSurface`	`getFocusedComponent()`
`Dimension`	`getPreferredSize()` Returns the preferred size of this object.
`Projector`	`getProjector()` Get projector
`float[]`	`getRanges()` Gets the current x, y, and z ranges.
`SurfaceColor`	`getSurfaceColor()`
`SurfaceModel`	`getSurfaceModel()` Get model
`SurfaceVertex[][]`	`getValuesArray()` Gets the current vertices array.
`org.freehep.graphics2d.VectorGraphics`	`getVectorGraphics()` Get current graphics
`void`	`paintComponent(Graphics g)` Paints surface.
`void`	`plotArea(int start_lx, int start_ly, int end_lx, int end_ly, int sx, int sy)` Plots an area of group of planes
`void`	`setDataAvailability(boolean avail)` Sets the data availability flag.
`void`	`setRanges(float xmin, float xmax, float ymin, float ymax)` Sets the x and y ranges of calculated surface vertices.
`void`	`setValuesArray(SurfaceVertex[][] vertex)` Sets the new vertices array of surface.
`void`	`update(Graphics g)` Updates image.

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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, 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, updateUI

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, getAccessibleContext, 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, 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
  - model
```
public SurfaceModel model
```
  - projector
```
public Projector projector
```
  - vertex
```
public SurfaceVertex[][] vertex
```
  - data_available
```
public boolean data_available
```
  - interrupted
```
public boolean interrupted
```
  - critical
```
public boolean critical
```
  - printing
```
public boolean printing
```
  - cop
```
public SurfaceVertex cop
```
  - item1
```
public JMenuItem item1
```
  - item2
```
public JMenuItem item2
```
  - curve
```
public int curve
```
  - graphics
```
public org.freehep.graphics2d.VectorGraphics graphics
```
  - plot_type
```
public SurfaceModel.PlotType plot_type
```
  - calc_divisions
```
public int calc_divisions
```
  - plotfunc1
```
public boolean plotfunc1
```
  - plotfunc2
```
public boolean plotfunc2
```
  - plotboth
```
public boolean plotboth
```
  - isBoxed
```
public boolean isBoxed
```
  - isMesh
```
public boolean isMesh
```
  - isScaleBox
```
public boolean isScaleBox
```
  - isDisplayXY
```
public boolean isDisplayXY
```
  - isDisplayZ
```
public boolean isDisplayZ
```
  - isDisplayGrids
```
public boolean isDisplayGrids
```
  - xmin
```
public float xmin
```
  - xmax
```
public float xmax
```
  - ymin
```
public float ymin
```
  - ymax
```
public float ymax
```
  - zmin
```
public float zmin
```
  - zmax
```
public float zmax
```
  - color_factor
```
public float color_factor
```
  - projection
```
public Point projection
```
  - line_color
```
public Color line_color
```
  - contour_lines
```
public int contour_lines
```
  - contour_stepz
```
public float contour_stepz
```
  - contour_vertex
```
public SurfaceVertex[] contour_vertex
```
  - accumulator
```
public LineAccumulator accumulator
```
- Constructor Detail
  - JSurface
```
public JSurface()
```
  - JSurface
```
public JSurface(SurfaceModel model)
```
    The constructor of JSurface
    
    See Also:
    
    SurfaceFrame
- Method Detail
  - getFocusedComponent
```
public JSurface getFocusedComponent()
```
  - destroyImage
```
public void destroyImage()
```
    Destroys the internal image. It will force SurfaceCanvas to regenerate all images when the paint method is called.
  - setRanges
```
public void setRanges(float xmin,
                      float xmax,
                      float ymin,
                      float ymax)
```
    Sets the x and y ranges of calculated surface vertices. The ranges will not affect surface appearance. They affect axes scale appearance.
    
    Parameters:
    
    xmin - the minimum x
    
    xmax - the maximum x
    
    ymin - the minimum y
    
    ymax - the maximum y
  - getRanges
```
public float[] getRanges()
```
    Gets the current x, y, and z ranges.
    
    Returns:
    
    array of x,y, and z ranges in order of xmin, xmax, ymin, ymax, zmin, zmax
  - setDataAvailability
```
public void setDataAvailability(boolean avail)
```
    Sets the data availability flag. If this flag is false, SurfaceCanvas will not generate any surface image, even if the data is available. But it is the programmer's responsiblity to set this flag to false when data is not available.
    
    Parameters:
    
    avail - the availability flag
  - setValuesArray
```
public void setValuesArray(SurfaceVertex[][] vertex)
```
    Sets the new vertices array of surface.
    
    Parameters:
    
    vertex - the new vertices array
    
    See Also:
    
    getValuesArray()
  - getValuesArray
```
public SurfaceVertex[][] getValuesArray()
```
    Gets the current vertices array.
    
    Returns:
    
    current vertices array
    
    See Also:
    
    setValuesArray(jplot3d.SurfaceVertex[][])
  - doExportPNG
```
public void doExportPNG(File file)
                 throws IOException
```
    mouseDown event handler. Sets internal tracking variables for dragging operations.
    
    Parameters:
    
    e - the event
    
    x - the x coordinate of cursor
    
    y - the y coordinate of cursor
    
    Throws:
    
    IOException
  - paintComponent
```
public void paintComponent(Graphics g)
```
    Paints surface. Creates surface plot, contour plot, or density plot based on current vertices array, contour plot flag, and density plot flag. If no data is available, creates image of base plane and axes.
    
    Overrides:
    
    paintComponent in class JComponent
    
    Parameters:
    
    g - the graphics context to paint
    
    See Also:
    
    #setContour, #setDensity, setValuesArray(jplot3d.SurfaceVertex[][]), setDataAvailability(boolean)
  - update
```
public void update(Graphics g)
```
    Updates image. Just call the paint method to avoid flickers.
    
    Overrides:
    
    update in class JComponent
    
    Parameters:
    
    g - the graphics context to update
    
    See Also:
    
    JComponent.paint(java.awt.Graphics)
  - getPreferredSize
```
public Dimension getPreferredSize()
```
    Returns the preferred size of this object. This will be the initial size of SurfaceCanvas.
    
    Overrides:
    
    getPreferredSize in class JComponent
    
    Returns:
    
    the preferred size.
  - drawBoundingBox
```
public final void drawBoundingBox()
```
    Draws the bounding box of surface.
  - drawBoxGridsTicksLabels
```
public final void drawBoxGridsTicksLabels(org.freehep.graphics2d.VectorGraphics g2d,
                                          boolean draw_axes)
```
    Draws non-surface parts, i.e: bounding box, axis grids, axis ticks, axis labels, base plane.
    
    Parameters:
    
    g - the graphics context to draw
    
    draw_axes - if true, only draws base plane and z axis
  - plotArea
```
public final void plotArea(int start_lx,
                           int start_ly,
                           int end_lx,
                           int end_ly,
                           int sx,
                           int sy)
```
    Plots an area of group of planes
    
    Parameters:
    
    start_lx - start index in x direction
    
    start_ly - start index in y direction
    
    end_lx - end index in x direction
    
    end_ly - end index in y direction
    
    sx - step in x direction
    
    sy - step in y direction
  - contourConvertX
```
public final int contourConvertX(float x)
```
    Converts normalized x coordinate (-10..+10) to screen x coordinate
    
    Parameters:
    
    x - the normalized x coordinate
    
    Returns:
    
    the screen x coordinate
  - contourConvertY
```
public final int contourConvertY(float y)
```
    Converts normalized y coordinate (-10..+10) to screen y coordinate
    
    Parameters:
    
    y - the normalized x coordinate
    
    Returns:
    
    the screen y coordinate
  - drawBoundingRect
```
public final void drawBoundingRect()
```
    Creates bounding box for images of contour plot or density plot
  - computePlotArea
```
public final void computePlotArea()
```
    Common method for contour plot and density plot that computes the best plot area size and position.
  - createContour
```
public final void createContour()
```
    Creates contour plot of a single area division. Called by plotContour method
    
    See Also:
    
    #plotContour
  - getProjector
```
public Projector getProjector()
```
    Get projector
    
    Returns:
  - getSurfaceColor
```
public SurfaceColor getSurfaceColor()
```
  - getSurfaceModel
```
public SurfaceModel getSurfaceModel()
```
    Get model
    
    Returns:
  - getVectorGraphics
```
public org.freehep.graphics2d.VectorGraphics getVectorGraphics()
```
    Get current graphics
    
    Returns:

Class JSurface

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.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

model

projector

vertex

data_available

interrupted

critical

printing

cop

item1

item2

curve

graphics

plot_type

calc_divisions

plotfunc1

plotfunc2

plotboth

isBoxed

isMesh

isScaleBox

isDisplayXY

isDisplayZ

isDisplayGrids

xmin

xmax

ymin

ymax

zmin

zmax

color_factor

projection

line_color

contour_lines

contour_stepz

contour_vertex

accumulator

Constructor Detail

JSurface

JSurface

Method Detail

getFocusedComponent

destroyImage

setRanges

getRanges

setDataAvailability

setValuesArray

getValuesArray

doExportPNG

paintComponent

update

getPreferredSize

drawBoundingBox

drawBoxGridsTicksLabels

plotArea

contourConvertX

contourConvertY

drawBoundingRect

computePlotArea

createContour

getProjector

getSurfaceColor

getSurfaceModel

getVectorGraphics