com.steema.teechart.styles
Class Surface

java.lang.Object
  extended by com.steema.teechart.TeeBase
      extended by com.steema.teechart.styles.Series
          extended by com.steema.teechart.styles.Custom3D
              extended by com.steema.teechart.styles.Custom3DPalette
                  extended by com.steema.teechart.styles.Custom3DGrid
                      extended by com.steema.teechart.styles.Surface
All Implemented Interfaces:
ISeries
Direct Known Subclasses:
IsoSurface, Waterfall

public class Surface
extends Custom3DGrid

Title: Surface class

Description: Surface 3D Series.

Example:


 surfaceSeries = new com.steema.teechart.styles.Surface(myChart.getChart());
 surfaceSeries.setPaletteStyle(PaletteStyle.STRONG);
 surfaceSeries.getSideBrush().setColor(Color.WHITE);
 surfaceSeries.getSideBrush().setStyle(null);
 surfaceSeries.setUseColorRange(false);
 surfaceSeries.setUsePalette(true);
 

Copyright (c) 2005-2013 by Steema Software SL. All Rights Reserved.

Company: Steema Software SL


Nested Class Summary
 class Surface.CellsOrientation
           
 
Nested classes/interfaces inherited from class com.steema.teechart.styles.Custom3DGrid
Custom3DGrid.CellsRow, Custom3DGrid.PCellsRow, Custom3DGrid.YCalculator
 
Nested classes/interfaces inherited from class com.steema.teechart.styles.Custom3DPalette
Custom3DPalette.ColorResolver
 
Nested classes/interfaces inherited from class com.steema.teechart.styles.Series
Series.MarkTextResolver
 
Field Summary
protected  Point[] points
           
protected  ChartPen sideLines
           
 
Fields inherited from class com.steema.teechart.styles.Custom3DGrid
FXStartIndex, FZStartIndex, gridIndex, iInGallery, iNextXCell, iNextZCell, iNumXValues, iNumZValues, valueIndex0, valueIndex1, valueIndex2, valueIndex3
 
Fields inherited from class com.steema.teechart.styles.Custom3DPalette
bUseColorRange, bUsePalette, iPaletteSteps
 
Fields inherited from class com.steema.teechart.styles.Custom3D
vzValues
 
Fields inherited from class com.steema.teechart.styles.Series
AUTODEPTH, AUTOZORDER, bActive, bBrush, bColorEach, calcVisiblePoints, colorMember, customMarkText, drawBetweenPoints, endZ, firstVisible, hasZValues, iColors, iNumSampleValues, iZOrder, labelMember, lastVisible, listenerList, mandatory, manualData, marks, middleZ, notMandatory, percentDecimal, percentFormat, sLabels, startZ, useAxis, useSeriesColor, valueFormat, vxValues, vyValues, yMandatory
 
Fields inherited from class com.steema.teechart.TeeBase
chart, InternalUse
 
Constructor Summary
Surface()
           
Surface(IBaseChart c)
           
 
Method Summary
 Surface.CellsOrientation cellsOrientation()
           
 void createSubGallery(Gallery addSubChart)
           
protected  void draw()
           
 void drawCell(int x, int z)
           
protected  void drawSidePortion(com.steema.teechart.styles.Surface.SidePoint z0, com.steema.teechart.styles.Surface.SidePoint z1)
           
protected  boolean fourGridIndex(int x, int z)
           
 java.lang.String getDescription()
          Gets descriptive text.
 boolean getDotFrame()
          Sets SurfaceSeries as a grid of dots (pixels).
 boolean getHideCells()
           
 ChartBrush getSideBrush()
          Determines the Brush to fill the sides of a Surface Series.
 ChartPen getSideLines()
           
 boolean getSmoothPalette()
          Determine the cell Colors of a Surface Series.
 boolean getWaterFall()
          Enables/disables the display as a waterfall.
 ChartPen getWaterLines()
          Sets Pen to draw valuelines.
 boolean getWireFrame()
          Shows Surface polygons as grid or wire frame when true.
 void prepareForGallery(boolean isEnabled)
           
protected  void prepareLegendCanvas(IGraphics3D g, int valueIndex, Color backColor, ChartBrush aBrush)
           
protected  java.lang.Object readResolve()
           
 void setChart(IBaseChart c)
          Chart associated with this object.
 void setDotFrame(boolean value)
          Sets SurfaceSeries as a grid of dots (pixels).
 void setHideCells(boolean value)
           
 void setSideLines(ChartPen value)
           
 void setSmoothPalette(boolean value)
          Determine the cell Colors of a Surface Series.
 void setSubGallery(int index)
          Creates and prepares the index'th Series style to show at sub-gallery dialog.
 void setWaterFall(boolean value)
           
 void setWireFrame(boolean value)
          Shows Surface polygons as grid or wire frame when true.
protected  boolean shouldDrawSides()
           
protected  Point[] updateArray(int count, Point[] points)
           
 
Methods inherited from class com.steema.teechart.styles.Custom3DGrid
addSampleValues, addValues, backFaced, canCreateValues, clear, createValues, doBeforeDrawChart, doGetYValue, existFourGridIndex, fillGridIndex, getIndex, getIrregularGrid, getNumXValues, getNumZValues, isValidSeriesSource, numSampleValues, reCreateValues, removeYCalculator, setIndex, setIrregularGrid, setNumXValues, setNumZValues, setYCalculator
 
Methods inherited from class com.steema.teechart.styles.Custom3DPalette
addPalette, calcColorRange, clearPalette, countLegendItems, createDefaultPalette, drawLegendShape, galleryChanged3D, getBlueFactor, getBrush, getCountLegendItems, getEndColor, getGreenFactor, getLegendString, getMidColor, getPalette, getPaletteMin, getPaletteRange, getPaletteStep, getPaletteSteps, getPaletteStyle, getPen, getRedFactor, getStartColor, getUseColorRange, getUsePalette, getUsePaletteMin, getValueColor, getValueColorValue, legendItemColor, removeColorResolver, setBlueFactor, setColorResolver, setEndColor, setGreenFactor, setMidColor, setPaletteMin, setPaletteRange, setPaletteStep, setPaletteSteps, setPaletteStyle, setRainbowPalette, setRedFactor, setSameBrush, setStartColor, setUseColorRange, setUsePalette, setUsePaletteMin
 
Methods inherited from class com.steema.teechart.styles.Custom3D
add, add, add, add, add, add, add, add, add, calcZOrder, calcZPos, drawMark, getMaxZValue, getMinZValue, getPoint, getTimesZOrder, getZValues, isValidSourceOf, setTimesZOrder, valueListOfAxis
 
Methods inherited from class com.steema.teechart.styles.Series
add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, addChartValue, added, addedValue, addNull, addNullXY, addSeriesMouseListener, addSeriesPaintListener, assign, assignDispose, assignValues, associatedToAxis, beginUpdate, calcFirstLastVisibleIndex, calcHorizMargins, calcPercentSt, calcPosValue, calculateMarkPosition, calcVerticalMargins, calcXPos, calcXPosValue, calcXSizeValue, calcYPos, calcYPosValue, calcYSizeValue, canAddRandomPoints, changeType, checkDataSource, checkMouse, checkOrder, checkOtherSeries, clearLists, clicked, clicked, clone, cloneSeries, convertArray, createNewSeries, createNewSeries, createNewSeries, dataSourceArray, delete, delete, delete, dispose, doAfterDrawValues, doBeforeDrawValues, doClick, doClickPointer, doDoubleClick, drawHiddenValue, drawLegend, drawLegend, drawMarks, drawMarksSeries, drawSeries, drawSeriesForward, drawValue, drawValuesForward, endUpdate, fillSampleValues, fillSampleValues, fireSeriesMouseEvent, fireSeriesPaint, firstDisplayed, getActive, getAllowSinglePoint, getColor, getColorEach, getColorMember, getColors, getCount, getCursor, getCustomHorizAxis, getCustomVertAxis, getDataSource, getDefaultColor, getDefaultNullValue, getDepth, getEndZ, getFields, getFirstVisible, getFunction, getHasZValues, getHorizAxis, getHorizontalAxis, getLabelMember, getLabels, getLastVisible, getMandatory, getMandatoryAxis, getMarks, getMarkText, getMarkValue, getMaxXValue, getMaxYValue, getMiddleZ, getMinXValue, getMinYValue, getNotMandatory, getNumGallerySeries, getNumSampleValues, getOriginValue, getPercentFormat, getSeriesColor, getShowInLegend, getStartZ, getTitle, getUseAxis, getValueFormat, getValueIndexSwapper, getValueList, getValueList, getValueMarkText, getValuesLists, getVertAxis, getVerticalAxis, getVisible, getXValues, getYMandatory, getYValueList, getYValues, getZOrder, hasClickEvents, hasDataSource, hasListenersOf, hasNoMandatoryValues, isNull, isPointInChartRect, isValidSeriesSource, lastDisplayed, lastVisibleMark, legendToValueIndex, maxMarkWidth, moreSameZOrder, mouseEvent, newFromType, onDisposing, randomBounds, recalcGetAxis, refreshSeries, removeMarkTextResolver, removeSeriesMouseListener, removeSeriesPaintListener, repaint, sameClass, setActive, setColor, setColorEach, setColorMember, setColors, setCursor, setCustomHorizAxis, setCustomHorizAxis, setCustomVertAxis, setCustomVertAxis, setDataSource, setDefaultNullValue, setDepth, setEndZ, setFunction, setHorizontal, setHorizontalAxis, setLabelMember, setLabels, setMarks, setMarkTextResolver, setMiddleZ, setNull, setNull, setPercentFormat, setSeriesColor, setShowInLegend, setStartZ, setTitle, setValueFormat, setValueList, setVerticalAxis, setVisible, setXValues, setYValues, setZOrder, setZPositions, sortByLabels, sortByLabels, swapValueIndex, titleOrName, toString, valuesListAdd, xScreenToValue, yScreenToValue
 
Methods inherited from class com.steema.teechart.TeeBase
getChart, invalidate, setBooleanProperty, setColorProperty, setDoubleProperty, setIntegerProperty, setStringProperty
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.steema.teechart.styles.ISeries
getChart, invalidate
 

Field Detail

sideLines

protected ChartPen sideLines

points

protected transient Point[] points
Constructor Detail

Surface

public Surface(IBaseChart c)

Surface

public Surface()
Method Detail

createSubGallery

public void createSubGallery(Gallery addSubChart)
Overrides:
createSubGallery in class Custom3DPalette

getDescription

public java.lang.String getDescription()
Gets descriptive text.

Overrides:
getDescription in class Series
Returns:
String

getSmoothPalette

public boolean getSmoothPalette()
Determine the cell Colors of a Surface Series.
When set to true, each cell is filled using a color calculated as the average of each cell 4 corner colors. When set to false, only one corner color is used.
Default value: false

Returns:
boolean

setSmoothPalette

public void setSmoothPalette(boolean value)
Determine the cell Colors of a Surface Series.
Default value: false

Example:


 series.setSmoothPalette(true);
 

Parameters:
value - boolean

readResolve

protected java.lang.Object readResolve()
Overrides:
readResolve in class Custom3DPalette

setChart

public void setChart(IBaseChart c)
Description copied from class: TeeBase
Chart associated with this object.

Specified by:
setChart in interface ISeries
Overrides:
setChart in class Custom3DPalette
Parameters:
c - IBaseChart

setSubGallery

public void setSubGallery(int index)
Description copied from class: Series
Creates and prepares the index'th Series style to show at sub-gallery dialog.

Specified by:
setSubGallery in interface ISeries
Overrides:
setSubGallery in class Custom3DPalette
Parameters:
index - int

getSideBrush

public ChartBrush getSideBrush()
Determines the Brush to fill the sides of a Surface Series.

Returns:
ChartBrush

getSideLines

public ChartPen getSideLines()

setSideLines

public void setSideLines(ChartPen value)

getWaterLines

public ChartPen getWaterLines()
Sets Pen to draw valuelines.

Returns:
ChartPen

getWaterFall

public boolean getWaterFall()
Enables/disables the display as a waterfall.
Default value: false

Returns:
boolean

setWaterFall

public void setWaterFall(boolean value)

getWireFrame

public boolean getWireFrame()
Shows Surface polygons as grid or wire frame when true.
If Surface.Pen.Visible is True (default), Surface points are displayed as a "grid" or "wireframe", with lines connecting them.
Default value: false

Returns:
boolean

setWireFrame

public void setWireFrame(boolean value)
Shows Surface polygons as grid or wire frame when true.
If Surface.Pen.Visible is True (default), Surface points are displayed as a "grid" or "wireframe", with lines connecting them.
Default value: false

Example:


 series = new com.steema.teechart.styles.Surface(myChart.getChart());
 series.setWireFrame(true);
 series.setUsePalette(true);
 series.setUseColorRange(false);
 series.getPen().setWidth(1);
 series.fillSampleValues(10);
 

Parameters:
value - boolean

shouldDrawSides

protected boolean shouldDrawSides()

getHideCells

public boolean getHideCells()

setHideCells

public void setHideCells(boolean value)

getDotFrame

public boolean getDotFrame()
Sets SurfaceSeries as a grid of dots (pixels).
It's very similar to the WireFrame mode except that no lines connect the Surface's points.
Default value: false

Returns:
boolean

setDotFrame

public void setDotFrame(boolean value)
Sets SurfaceSeries as a grid of dots (pixels).
Default value: false

Parameters:
value - boolean

draw

protected void draw()
Overrides:
draw in class Series

prepareForGallery

public void prepareForGallery(boolean isEnabled)
Overrides:
prepareForGallery in class Custom3DPalette

prepareLegendCanvas

protected void prepareLegendCanvas(IGraphics3D g,
                                   int valueIndex,
                                   Color backColor,
                                   ChartBrush aBrush)
Overrides:
prepareLegendCanvas in class Custom3D

updateArray

protected Point[] updateArray(int count,
                              Point[] points)

cellsOrientation

public Surface.CellsOrientation cellsOrientation()

drawSidePortion

protected void drawSidePortion(com.steema.teechart.styles.Surface.SidePoint z0,
                               com.steema.teechart.styles.Surface.SidePoint z1)

fourGridIndex

protected boolean fourGridIndex(int x,
                                int z)

drawCell

public void drawCell(int x,
                     int z)