org.askalon.graph.chart
Interface MultipleSurfaceChart

All Superinterfaces:

Chart, Cleanable, DescriptionModeChart, SectionChart, SurfacesChart, UnalignedChart

public interface MultipleSurfaceChart
extends SurfacesChart, SectionChart

The multiple surface chart is similar to the surface chart, but it additionally allows to display multiple surfaces, each one with a configurable color. A surface is determined by its values at the datpoints, which are arranged in a 2 dimensiontal grid. The distances of the grid may vary.

Author:

Georg Schild and Franz Endstrasser

Method Summary

boolean	getLinesTransparent() Gets the current transparency mode for the lines of the surfaces.
float	getTransparency(int surface_id) Gets the current transparency of a surface specified by the index.
double	getValue(int surface_id, int idx, int idz) Gets the current value of a surface datapoint determined by the indices.
double[]	getValues(int surface_id, int idX, int idZ) Gets the values of all neighbour datapoints of the given datapoint for one surface.
void	removeEntity(int surface_id) Remove a surface specified by the id.
void	setLinesTransparent(boolean b) Enables/disables the transparency of lines for all surfaces.
void	setTransparency(int surface_id, float transparency) Sets the transparency of a surface.
void	setValue(int surface_id, int idx, int idz, double value) Sets the value of a datapoint of a surface.
void	setValues(int surface_id, List<GridValueElement> l) Sets a list of values for one surface, what is more efficient than setting them as single values.

Methods inherited from interface org.askalon.graph.chart.SurfacesChart

getDataCountX, getDataCountZ, getXDescription, getZDescription, setXDescription, setZDescription

Methods inherited from interface org.askalon.graph.chart.Chart

getChartConfiguration, getChartMenu, getChartName, getLegend, getUnit, getXAxisText, getYAxisText, isDisableUpdate, isEdgesVisible, refreshConfiguration, resetConfiguration, setChartConfiguration, setDisableUpdate, setEdgesVisible, setUnit, setXAxisText, setYAxisText

Methods inherited from interface org.askalon.graph.chart.base.Cleanable

cleanUp

Methods inherited from interface org.askalon.graph.chart.DescriptionModeChart

getDescriptionMode, setDescriptionMode

Methods inherited from interface org.askalon.graph.chart.UnalignedChart

getXLinesVisible, getZLinesVisible, setXLinesVisible, setZLinesVisible

Methods inherited from interface org.askalon.graph.chart.SectionChart

getSectionColor, getSectionCount, getSectionName, isVisible, setSectionColor, setSectionName, setVisible

Methods inherited from interface org.askalon.graph.chart.Chart

getChartConfiguration, getChartMenu, getChartName, getLegend, getUnit, getXAxisText, getYAxisText, isDisableUpdate, isEdgesVisible, refreshConfiguration, resetConfiguration, setChartConfiguration, setDisableUpdate, setEdgesVisible, setUnit, setXAxisText, setYAxisText

Methods inherited from interface org.askalon.graph.chart.base.Cleanable

cleanUp

Method Detail

setValue

void setValue(int surface_id,
              int idx,
              int idz,
              double value)

Sets the value of a datapoint of a surface.

Parameters:

surface_id - the id of the surface for which the datapoint should be set

idx - the x-coordinate of the datapoint

idz - the z-coordinate of the datapoint

value - the new value for this datapoint

See Also:

getValue(int, int, int), setValues(int, List)

setValues

void setValues(int surface_id,
               List<GridValueElement> l)

Sets a list of values for one surface, what is more efficient than setting them as single values.

Parameters:

surface_id - the id of the surface

l - the list of values to update

See Also:

GridValueElement, getValue(int, int, int), setValue(int, int, int, double)

getValue

double getValue(int surface_id,
                int idx,
                int idz)

Gets the current value of a surface datapoint determined by the indices.

Parameters:

surface_id - the id of the surface

idx - the x-coordinate of the datapoint

idz - the z-coordinate of the datapoint

Returns:

the current value of this surfaces datapoint

See Also:

getValues(int, int, int), setValue(int, int, int, double), setValues(int, List)

removeEntity

void removeEntity(int surface_id)

Remove a surface specified by the id.

Parameters:

surface_id - the id of the surface to remove

setTransparency

void setTransparency(int surface_id,
                     float transparency)

Sets the transparency of a surface.

Parameters:

surface_id - the id of the surface

transparency - the new transparency of this surface, 0.0 <= transparency <= 1.0

See Also:

getTransparency(int)

getTransparency

float getTransparency(int surface_id)

Gets the current transparency of a surface specified by the index.

Parameters:

surface_id - the id of the surface

Returns:

the current transparency of this surface

See Also:

setTransparency(int, float)

setLinesTransparent

void setLinesTransparent(boolean b)

Enables/disables the transparency of lines for all surfaces.

Parameters:

b - true to enable transparency, false to disable it

See Also:

getLinesTransparent()

getLinesTransparent

boolean getLinesTransparent()

Gets the current transparency mode for the lines of the surfaces.

Returns:

true if lines are transparent, false otherwise

See Also:

setLinesTransparent(boolean)

getValues

double[] getValues(int surface_id,
                   int idX,
                   int idZ)

Gets the values of all neighbour datapoints of the given datapoint for one surface. This are the four datapoints which determine two triangles in the visualisation.

Parameters:

surface_id - the id of the surface

idX - the x-coordinate of the datapoint

idZ - the z-coordinate of the datapoint

Returns:

a double array of size 4, containing all neighbour datapoint values