- All Superinterfaces:
ChartElement
,Renderer3D
- All Known Implementing Classes:
BarXYZRenderer
,LineXYZRenderer
,ScatterXYZRenderer
,SurfaceRenderer
A renderer that can display data from an
XYZDataset
on an
XYZPlot
.-
Field Summary
Fields inherited from interface org.jfree.chart3d.renderer.Renderer3D
TRANSPARENT_COLOR
-
Method Summary
Modifier and TypeMethodDescriptionvoid
composeAll
(XYZPlot plot, World world, Dimension3D dimensions, double xOffset, double yOffset, double zOffset) Composes all the 3D objects that this renderer needs to present.void
composeItem
(XYZDataset dataset, int series, int item, World world, Dimension3D dimensions, double xOffset, double yOffset, double zOffset) Constructs and places one item from the specified dataset into the given world.findXRange
(XYZDataset dataset) Returns the range that should be set on the x-axis in order for this renderer to be able to display all the data in the supplied dataset.findYRange
(XYZDataset dataset) Returns the range that should be set on the y-axis in order for this renderer to be able to display all the data in the supplied dataset.findZRange
(XYZDataset dataset) Returns the range that should be set on the z-axis in order for this renderer to be able to display all the data in the supplied dataset.Returns the color source for the renderer, which is an object that is responsible for providing the colors used by the renderer to draw data (and legend) items.Returns the type of composition performed by the renderer.getPlot()
Returns the plot that this renderer is assigned to.void
Sets the colors for the renderer.void
setColorSource
(XYZColorSource source) Sets the color source for the renderer and sends aRenderer3DChangeEvent
to all registered listeners.void
Sets the plot that the renderer is assigned to.Methods inherited from interface org.jfree.chart3d.ChartElement
receive
Methods inherited from interface org.jfree.chart3d.renderer.Renderer3D
addChangeListener, removeChangeListener
-
Method Details
-
getPlot
Returns the plot that this renderer is assigned to.- Returns:
- The plot (possibly
null
).
-
setPlot
Sets the plot that the renderer is assigned to. Although this method is part of the public API, client code should not need to call it.- Parameters:
plot
- the plot (null
permitted).
-
getColorSource
Returns the color source for the renderer, which is an object that is responsible for providing the colors used by the renderer to draw data (and legend) items.- Returns:
- The paint source (never
null
).
-
setColorSource
Sets the color source for the renderer and sends aRenderer3DChangeEvent
to all registered listeners.- Parameters:
source
- the color source (null
not permitted).- Since:
- 1.2
-
setColors
Sets the colors for the renderer.- Parameters:
colors
- the colors.- Since:
- 1.2
-
findXRange
Returns the range that should be set on the x-axis in order for this renderer to be able to display all the data in the supplied dataset. If the dataset contains no data, this method returnsnull
.- Parameters:
dataset
- the dataset (null
not permitted).- Returns:
- The range (possibly
null
).
-
findYRange
Returns the range that should be set on the y-axis in order for this renderer to be able to display all the data in the supplied dataset. If the dataset contains no data, this method returnsnull
.- Parameters:
dataset
- the dataset (null
not permitted).- Returns:
- The range.
-
findZRange
Returns the range that should be set on the z-axis in order for this renderer to be able to display all the data in the supplied dataset. If the dataset contains no data, this method returnsnull
.- Parameters:
dataset
- the dataset (null
not permitted).- Returns:
- The range.
-
getComposeType
Returns the type of composition performed by the renderer. This determines whether the plot will call thecomposeItem()
method (once for each data item) or just call thecomposeAll()
method once.- Returns:
- The type of composition (never
null
). - Since:
- 1.1
-
composeItem
void composeItem(XYZDataset dataset, int series, int item, World world, Dimension3D dimensions, double xOffset, double yOffset, double zOffset) Constructs and places one item from the specified dataset into the given world. TheXYZPlot
class will iterate over its dataset and and call this method for each item (in other words, you don't need to call this method directly).- Parameters:
dataset
- the dataset (null
not permitted).series
- the series index.item
- the item index.world
- the world (null
not permitted).dimensions
- the dimensions (null
not permitted).xOffset
- the x-offset.yOffset
- the y-offset.zOffset
- the z-offset.
-
composeAll
void composeAll(XYZPlot plot, World world, Dimension3D dimensions, double xOffset, double yOffset, double zOffset) Composes all the 3D objects that this renderer needs to present. This method only needs to be implemented if thegetComposeType()
method returnsALL
, otherwise it can be left empty.- Parameters:
plot
- the plot.world
- the world (null
not permitted).dimensions
- the dimensions (null
not permitted).xOffset
- the x-offset.yOffset
- the y-offset.zOffset
- the z-offset.- Since:
- 1.1
-