JClass DesktopViews 6.3.0 API
Documentation

com.klg.jclass.chart3d
Class JCSurface

java.lang.Object
  |
  +--com.klg.jclass.chart3d.ParentTrackChange
        |
        +--com.klg.jclass.chart3d.JCSurface
All Implemented Interfaces:
Serializable

public class JCSurface
extends ParentTrackChange

JClass Chart 3D class that contains properties that pertain to plots of type surface. These are properties such as whether to draw a solid skirt and whether to show or filter mesh lines.

See Also:
Serialized Form

Field Summary
static double PIXEL_SPREAD
          Pixel spread that determines the space used in automatic mesh filtering.
protected  boolean solid
          Asks if solid "skirts" under the surface should be drawn.
protected  boolean[] xMesh
          Array that determines whether an x mesh line is drawn (based on grid).
protected  int xMeshFilter
          Filter value for x mesh lines.
protected  boolean xMeshShowing
          Asks if x mesh lines are showing.
protected  boolean[] yMesh
          Array that determines whether a y mesh line is drawn (based on grid).
protected  int yMeshFilter
          Filter value for y mesh lines.
protected  boolean yMeshShowing
          Asks if y mesh lines are showing.
 
Fields inherited from class com.klg.jclass.chart3d.ParentTrackChange
parents
 
Constructor Summary
JCSurface()
          No args constructor.
JCSurface(boolean solid, boolean xMeshShowing, boolean yMeshShowing, int xMeshFilter, int yMeshFilter)
          Constructor that provides values for solid, x and y showing and filter.
 
Method Summary
 void computeMeshFiltering(com.klg.jclass.chart3d.Chart3dDataView dataView)
          Computes mesh filtering for both xs and ys.
 boolean[] getXMesh()
          Returns the current x mesh array, which tells whether a given mesh line is drawn.
 int getXMeshFilter()
          Returns the current x mesh filter.
 boolean[] getYMesh()
          Returns the current y mesh array, which tells whether a given mesh line is drawn.
 int getYMeshFilter()
          Returns the current y mesh filter.
 boolean isSolid()
          Asks if solid "skirts" under the surface are drawn.
 boolean isXMeshShowing()
          Asks if the x mesh lines are showing.
 boolean isYMeshShowing()
          Asks if the y mesh lines are showing.
 void setSolid(boolean solid)
          Sets whether solid "skirts" under the surface are drawn.
 void setXMeshFilter(int xMeshFilter)
          Sets the current x mesh filter.
 void setXMeshShowing(boolean xMeshShowing)
          Sets whether x mesh lines are drawn.
 void setYMeshFilter(int yMeshFilter)
          Sets the current y mesh filter.
 void setYMeshShowing(boolean yMeshShowing)
          Sets whether y mesh lines are drawn.
 
Methods inherited from class com.klg.jclass.chart3d.ParentTrackChange
addParent, clearParents, removeParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PIXEL_SPREAD

public static final double PIXEL_SPREAD
Pixel spread that determines the space used in automatic mesh filtering.

See Also:
Constant Field Values

solid

protected boolean solid
Asks if solid "skirts" under the surface should be drawn.


xMeshShowing

protected boolean xMeshShowing
Asks if x mesh lines are showing.


yMeshShowing

protected boolean yMeshShowing
Asks if y mesh lines are showing.


xMeshFilter

protected int xMeshFilter
Filter value for x mesh lines.


yMeshFilter

protected int yMeshFilter
Filter value for y mesh lines.


xMesh

protected boolean[] xMesh
Array that determines whether an x mesh line is drawn (based on grid).


yMesh

protected boolean[] yMesh
Array that determines whether a y mesh line is drawn (based on grid).

Constructor Detail

JCSurface

public JCSurface()
No args constructor. Values at default values.


JCSurface

public JCSurface(boolean solid,
                 boolean xMeshShowing,
                 boolean yMeshShowing,
                 int xMeshFilter,
                 int yMeshFilter)
Constructor that provides values for solid, x and y showing and filter.

Parameters:
solid - Should solid "skirts" under the surface be drawn?
xMeshShowing - Are x mesh lines showing?
yMeshShowing - Are y mesh lines showing?
xMeshFilter - filter value for x mesh lines
yMeshFilter - filter value for y mesh lines
Method Detail

isSolid

public boolean isSolid()
Asks if solid "skirts" under the surface are drawn.

Returns:
Is the surface a solid object?

setSolid

public void setSolid(boolean solid)
Sets whether solid "skirts" under the surface are drawn.

Parameters:
solid - sets whether the surface is a solid object

isXMeshShowing

public boolean isXMeshShowing()
Asks if the x mesh lines are showing.

Returns:
Are x mesh lines be drawn?

setXMeshShowing

public void setXMeshShowing(boolean xMeshShowing)
Sets whether x mesh lines are drawn.

Parameters:
xMeshShowing - Are the x mesh lines drawn?

isYMeshShowing

public boolean isYMeshShowing()
Asks if the y mesh lines are showing.

Returns:
Are y mesh lines drawn?

setYMeshShowing

public void setYMeshShowing(boolean yMeshShowing)
Sets whether y mesh lines are drawn.

Parameters:
yMeshShowing - Are the y mesh lines drawn?

getXMeshFilter

public int getXMeshFilter()
Returns the current x mesh filter. A filter value of n means every nth mesh line is drawn. If the value is 1 or greater, the filter value is honored. If the value is zero, a "pleasing" value is calculated so that mesh lines are not drawn too close together.

Returns:
the current x mesh filter

setXMeshFilter

public void setXMeshFilter(int xMeshFilter)
Sets the current x mesh filter. A filter value of n means every nth mesh line is drawn. If the value is 1 or greater, the filter value is honored. If the value is zero, a "pleasing" value is calculated so that mesh lines are not drawn too close together.

Parameters:
xMeshFilter - the new x mesh filter

getYMeshFilter

public int getYMeshFilter()
Returns the current y mesh filter. A filter value of n means every nth mesh line is drawn. If the value is 1 or greater, the filter value is honored. If the value is zero, a "pleasing" value is calculated so that mesh lines are not drawn too close together.

Returns:
the current y mesh filter

setYMeshFilter

public void setYMeshFilter(int yMeshFilter)
Sets the current y mesh filter. A filter value of n means every nth mesh line is drawn. If the value is 1 or greater, the filter value is honored. If the value is zero, a "pleasing" value is calculated so that mesh lines are not drawn too close together.

Parameters:
yMeshFilter - the new y mesh filter

getXMesh

public boolean[] getXMesh()
Returns the current x mesh array, which tells whether a given mesh line is drawn.

Returns:
the current x mesh array

getYMesh

public boolean[] getYMesh()
Returns the current y mesh array, which tells whether a given mesh line is drawn.

Returns:
the current y mesh array

computeMeshFiltering

public void computeMeshFiltering(com.klg.jclass.chart3d.Chart3dDataView dataView)
Computes mesh filtering for both xs and ys. If the user specified filter is 1 or greater, it is honored. If it is zero, then a "pleasing" mesh filtering, based on the size of the viewport, is computed.

Parameters:
dataView - the Chart3dDataView whose mesh lines are to be filtered

Copyright © 2004 Quest Software Inc..
All rights reserved.