com.steema.teechart.styles
Class Custom3DGrid

java.lang.Object
  com.steema.teechart.TeeBase
      com.steema.teechart.styles.Series
          com.steema.teechart.styles.Custom3D
              com.steema.teechart.styles.Custom3DPalette
                  com.steema.teechart.styles.Custom3DGrid

All Implemented Interfaces:

ISeries, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

ColorGrid, Contour, Surface, Tower

public class Custom3DGrid
extends Custom3DPalette

Title: Custom3DGrid class

Description: Custom3DGridSeries.

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

Company: Steema Software SL

See Also:

Serialized Form

Nested Class Summary

protected class	Custom3DGrid.CellsRow
protected class	Custom3DGrid.PCellsRow
static interface	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 int	FXStartIndex
protected int	FZStartIndex
protected Custom3DGrid.PCellsRow	gridIndex
protected boolean	iInGallery
protected int	iNextXCell
protected int	iNextZCell
protected int	iNumXValues
protected int	iNumZValues
protected int	valueIndex0
protected int	valueIndex1
protected int	valueIndex2
protected int	valueIndex3

Fields inherited from class com.steema.teechart.styles.Custom3DPalette

bUseColorRange, bUsePalette, iPaletteSteps, sameBrush

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, InternalUse, 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

Constructor Summary

Custom3DGrid()

Custom3DGrid(IBaseChart c)

Method Summary

protected void	addSampleValues(int numValues)
protected void	addValues(java.util.ArrayList source)
protected boolean	backFaced()
protected boolean	canCreateValues()
void	clear() Deletes all Series values.
void	createValues(int numX, int numZ) Makes a Surface grid of NumX by NumZ dimensions.
void	doBeforeDrawChart()
protected double	doGetYValue(int x, int z)
protected boolean	existFourGridIndex(int x, int z)
void	fillGridIndex()
int	getIndex(int x, int z) A two dimension array property for the easy access to series cell values.
boolean	getIrregularGrid() Determine if X and Z values are equi-distant or not.
int	getNumXValues() Determines the Surface's horizontal size in number of points.
int	getNumZValues() Determines the Surface's depth size in number of points.
protected boolean	isValidSeriesSource(ISeries value)
protected int	numSampleValues()
void	reCreateValues()
void	removeYCalculator()
void	setIndex(int x, int z, int index) A two dimension array property for the easy access to series cell values.
void	setIrregularGrid(boolean value) Determines if X and Z values are equi-distant or not.
void	setNumXValues(int value) Determines the Surface's horizontal size in number of points.
void	setNumZValues(int value) Determines the Surface's depth size in number of points.
void	setYCalculator(Custom3DGrid.YCalculator calculator)

Methods inherited from class com.steema.teechart.styles.Custom3DPalette

addPalette, calcColorRange, clearPalette, countLegendItems, createDefaultPalette, createSubGallery, drawLegendShape, galleryChanged3D, getBlueFactor, getBrush, getCountLegendItems, getEndColor, getGreenFactor, getLegendString, getMidColor, getPalette, getPaletteMin, getPaletteRange, getPaletteStep, getPaletteSteps, getPaletteStyle, getPen, getRedFactor, getStartColor, getUseColorRange, getUsePalette, getUsePaletteMin, getValueColor, getValueColorValue, legendItemColor, prepareForGallery, readResolve, removeColorResolver, setBlueFactor, setChart, setColorResolver, setEndColor, setGreenFactor, setMidColor, setPaletteMin, setPaletteRange, setPaletteStep, setPaletteSteps, setPaletteStyle, setRainbowPalette, setRedFactor, setSameBrush, setStartColor, setSubGallery, 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, prepareLegendCanvas, setTimesZOrder

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, 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, dataSourceArray, delete, delete, delete, dispose, doAfterDrawValues, doBeforeDrawValues, doClick, doClickPointer, doDoubleClick, draw, drawLegend, drawLegend, drawMarks, drawMarksSeries, drawSeries, drawSeriesForward, drawValue, drawValuesForward, endUpdate, fillSampleValues, fillSampleValues, fireSeriesMouseEvent, fireSeriesPaint, firstDisplayed, getActive, getAllowSinglePoint, getBitmapEditor, getColor, getColorEach, getColorMember, getColors, getCount, getCursor, getCustomHorizAxis, getCustomVertAxis, getDataSource, getDefaultColor, getDefaultNullValue, getDepth, getDescription, 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

gridIndex

protected Custom3DGrid.PCellsRow gridIndex

iNumXValues

protected int iNumXValues

iNumZValues

protected int iNumZValues

iInGallery

protected boolean iInGallery

valueIndex0

protected int valueIndex0

valueIndex1

protected int valueIndex1

valueIndex2

protected int valueIndex2

valueIndex3

protected int valueIndex3

iNextXCell

protected int iNextXCell

iNextZCell

protected int iNextZCell

FXStartIndex

protected int FXStartIndex

FZStartIndex

protected int FZStartIndex

Constructor Detail

Custom3DGrid

public Custom3DGrid()

Custom3DGrid

public Custom3DGrid(IBaseChart c)

Method Detail

setYCalculator

public void setYCalculator(Custom3DGrid.YCalculator calculator)

removeYCalculator

public void removeYCalculator()

doGetYValue

protected double doGetYValue(int x,
                             int z)

clear

public void clear()

Deletes all Series values.

Specified by:

clear in interface ISeries

Overrides:

clear in class Series

getIrregularGrid

public boolean getIrregularGrid()

Determine if X and Z values are equi-distant or not.
Default value: false

Returns:

boolean

setIrregularGrid

public void setIrregularGrid(boolean value)

Determines if X and Z values are equi-distant or not.
Default value: false

Example:

 series = new com.steema.teechart.styles.Surface(myChart.getChart());
 series.getMarks().setVisible(false);
 series.setIrregularGrid(true);          // <---------- VERY IMPORTANT !!!
 series.getVertAxis().setMinMax(-2,2);   // axis scale for Y values
 series.setUseColorRange(false);
 series.setUsePalette(true);
 series.setPaletteStyle(PaletteStyle.STRONG);
 

Parameters:

value - boolean

existFourGridIndex

protected boolean existFourGridIndex(int x,
                                     int z)

backFaced

protected boolean backFaced()

isValidSeriesSource

protected boolean isValidSeriesSource(ISeries value)

addSampleValues

protected void addSampleValues(int numValues)

Overrides:

addSampleValues in class Series

createValues

public void createValues(int numX,
                         int numZ)

Makes a Surface grid of NumX by NumZ dimensions.
For each grid point, the OnGetYValue event is called to allow the user to supply the corresponding Y value.

Parameters:

numX - int

numZ - int

canCreateValues

protected boolean canCreateValues()

getIndex

public int getIndex(int x,
                    int z)

A two dimension array property for the easy access to series cell values.

Parameters:

x - int

z - int

Returns:

int

setIndex

public void setIndex(int x,
                     int z,
                     int index)

A two dimension array property for the easy access to series cell values.

Parameters:

x - int

z - int

index - int

doBeforeDrawChart

public void doBeforeDrawChart()

Overrides:

doBeforeDrawChart in class Custom3DPalette

addValues

protected void addValues(java.util.ArrayList source)

Overrides:

addValues in class Series

fillGridIndex

public void fillGridIndex()

numSampleValues

protected int numSampleValues()

Overrides:

numSampleValues in class Series

getNumXValues

public int getNumXValues()

Determines the Surface's horizontal size in number of points.
A Surface is a grid of NumXValues x NumZValues dimensions. Changing NumXValues forces the Surface to recreate all values.
Default value: 10

Returns:

int

setNumXValues

public void setNumXValues(int value)

Determines the Surface's horizontal size in number of points.
Default value: 10

Parameters:

value - int

getNumZValues

public int getNumZValues()

Determines the Surface's depth size in number of points.
A Surface is a grid of NumXValues x NumZValues dimensions. Changing NumZValues forces the Surface to recreate all values.
Default value: 10

Returns:

int

setNumZValues

public void setNumZValues(int value)

Determines the Surface's depth size in number of points.
Default value: 10

Parameters:

value - int

reCreateValues

public void reCreateValues()